Add operationId on OpenAPI operations#6549
Merged
carltongibson merged 1 commit intoencode:openapi-schema-generationfrom Mar 29, 2019
Lucidiot:openapi-operation-ids
Merged
Add operationId on OpenAPI operations#6549carltongibson merged 1 commit intoencode:openapi-schema-generationfrom Lucidiot:openapi-operation-ids
carltongibson merged 1 commit intoencode:openapi-schema-generationfrom
Lucidiot:openapi-operation-ids
Conversation
carltongibson
approved these changes
Mar 29, 2019
Collaborator
carltongibson
left a comment
There was a problem hiding this comment.
Hi @Lucidiot. Super.
Let's merge this in as-is, and address the points on the main PR. (It gives people a chance to test...)
I'll have a look over the weekend in more depth, but I'd rather have it in attracting issues than think about it forever first. (I hope that makes sense.)
Thanks for the input!
This file contains hidden or 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
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 pull request adds an
operationIdproperty on generated OpenAPI operations from #6532. This property is recommended in the OpenAPI specification and is actually a requirement if we want the generated schema to have any use with OpenAPI clients ; most client libraries will use those operation IDs to build methods. See the Operation Object in the OpenAPI spec for more info.Example with
openapi3and an hypotheticalThingsListAPIView:Same example with
apistar:TODO:
Fixes #6542