updated the swagger page's endpoints' names to more meaningful names #77
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tcezard
approved these changes
Jan 23, 2024
| @@ -23,6 +24,7 @@ | |||
|
|
|||
| @RestController | |||
| @RequestMapping("/comparison") | |||
| @Tag(name = "Comparison endpoints") | |||
There was a problem hiding this comment.
Technically, these are also under the seqcol specification so they should be called Seqcol as well.
I would actually prefer if they are in the same section.
There was a problem hiding this comment.
Technically, these are also under the seqcol specification so they should be called Seqcol as well. I would actually prefer if they are in the same section.
Yeah that makes sense, I've made the update in commit 470c68c. Now it looks like this:
There was a problem hiding this comment.
This looks good, my nitpicks:
- I wonder if we can at least get the two
comparisonendpoints to sit next to each other in the same section? - There's a typo in the tag name, should be Seqcol!
There was a problem hiding this comment.
Done !
Thanks April
There was a problem hiding this comment.
Now it looks like this:
| @@ -25,6 +26,7 @@ | |||
|
|
|||
| @RestController | |||
| @RequestMapping("/") | |||
| @Tag(name = "Secqol endpoint") | |||
There was a problem hiding this comment.
Suggested change
| @Tag(name = "Secqol endpoint") | |
| @Tag(name = "Secqol endpoints") |
nitin-ebi
approved these changes
Jan 23, 2024
apriltuesday
approved these changes
Jan 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently the endpoints in the swagger page are named the same as the controller name. So we propose to change the endpoint names in the swagger ui to a more meaningful names.
Fixes #76
Swagger UI before and after the change
Before
After
Finally
I would really like to hear your feedback on the naming of the endpoints, in order to have the best meaningful names.