Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the home controller from the swagger-ui #108

Closed
tloubrieu-jpl opened this issue Mar 24, 2022 · 2 comments
Closed

Remove the home controller from the swagger-ui #108

tloubrieu-jpl opened this issue Mar 24, 2022 · 2 comments
Assignees
Labels

Comments

@tloubrieu-jpl
Copy link
Member

💪 Motivation

...so that it does not interfere in the user's mind with the actual API end-points. There might also be security issues with the exposure of this end-point.

📖 Additional Details

Screen Shot 2022-03-24 at 10 11 34 AM

⚖️ Acceptance Criteria

Given a deployed registry API
When I perform http:
Then I expect the home controller should not show in the welcome page

⚙️ Engineering Details

We want to remove that but actually I have no idea what it can be used for. A short analysis of what the home controller is for would be interesting to add to this ticket.

@al-niessner
Copy link
Contributor

It may be possible to remove this but the 30 second google attempt did not provide hope. Unfortunately home controller is the long way to say '/' which then provides the swagger-ui page. It is possible to override the actual behavior of '/' but then swagger-ui will not show up. Hence, removing it may prove to be very difficult. More when I have time.

@al-niessner
Copy link
Contributor

Could not remove it, but changed it to be as simple as possible and renamed to "this page : API Documentation". Hope that is sufficient. See attached screenshot for what it looks like now.

no_more_home_controller

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants