Add descriptions for LookupArgumentSets #21
Merged
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
OpenAPI 3.0 does not support parameter dependencies and mutually exclusive parameters. https://swagger.io/docs/specification/describing-parameters/#dependencies This is a complex topic with a lot of debate: OAI/OpenAPI-Specification#256 We know that our LookupArgumentSets are mutually exclusive, so the best thing is to add a description explaining this, so that it will appear in documentation and tools like the swagger editor. Apia already returns a 400 with a friendly error message. closes: #4
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.
OpenAPI 3.0 does not support parameter dependencies and mutually exclusive parameters.
https://swagger.io/docs/specification/describing-parameters/#dependencies
This is a complex topic with a lot of debate:
OAI/OpenAPI-Specification#256
We know that our LookupArgumentSets are mutually exclusive, so the best thing is to add a description explaining this, so that it will appear in documentation and tools like the swagger editor.
Apia already returns a 400 with a friendly error message.
closes: #4
Swagger GET:
Swagger POST:
