Support $ref alongside description in OpenAPI V3 #314
Merged
Conversation
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
Jefftree
commented
Mar 1, 2022
openapiv3/OpenAPIv3.proto
Outdated
| string version = 6; | ||
| repeated NamedAny specification_extension = 7; | ||
| string summary = 8; | ||
| string summary = 7; |
Collaborator
Author
There was a problem hiding this comment.
This change was generated automatically after running the regeneration script. Is this expected?
Contributor
There was a problem hiding this comment.
I've been manually changing this back to maintain backwards-compatibility of the protos. Could you do that here? Essentially I'm asking for the summary tag to be 7 and specification_extension should be 8.
Contributor
There was a problem hiding this comment.
That would also require regenerating OpenAPIv3.pb.go
Collaborator
Author
There was a problem hiding this comment.
Fixed. Updated both the .proto and .pb.go file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Copied from the latest OpenAPI 3.1 spec: https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.1/schema.json#L1072-L1081
Add support for $ref to have a description alongside it in the same object in the proto model for OpenAPI V3.0 and V3.1. This is an expected property for 3.1 and a relaxed constraint for 3.0.
/assign @timburks