fix(docs/swagger): various fixes and improved consistency #1139
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
well, well.. started with fixing some errors i noticed in the swagger annotations and quickly turned into a rabbit hole of fixing and trying to improve various things. however, here are some highlights: - correct flat out errors in swagger annotations - ensure all response codes are covered - simplify language (also meant removing some unnecessary language) - improve consistency in language
ecrupper
approved these changes
Jun 7, 2024
plyr4
approved these changes
Jun 7, 2024
Merged
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.
well, well.. started with fixing some errors i noticed in the swagger annotations and quickly turned into a rabbit hole of fixing and trying to improve various things.
however, here are some highlights:
Note: only on the admin endpoints did i correct some 404 returns that should have been 400, otherwise there are no actual code changes.
there is more to be done. i noticed some inconsistencies in some places where we return 404 when there was an error retrieving objects from the database when in most cases we return internal server error (500). might want to consider determining what kind of error and returning appropriate response.