API spec cleanup: consistently use reusable path params and fix security scheme key #293
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
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
paulfitz
approved these changes
Dec 26, 2023
There was a problem hiding this comment.
Thanks for the clean-up @alexmojaki, good catch on the descriptions.
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.
This is mainly about replacing repeated redefinitions of the orgId, workspaceId, and docId path params with refs to a single definition under components. As well as just making the spec shorter and cleaner, it makes it easier to build the customized API console.
In the params I've touched, I've moved the description from the schema up to the path definition because that's where it's actually supposed to be, otherwise it doesn't show in the Swagger UI. This should be done to all params, but I'll leave that to another PR.
Also I've fixed the
API Keysecurity scheme to not have a space because apparently that's bad.