Fix $ref serialization errors for requestBodies and responses#1033
Merged
millicentachieng merged 6 commits intovnextmicrosoft/OpenAPI.NET:vnextfrom Oct 6, 2022
fix/ma/ref-serialization-errorsmicrosoft/OpenAPI.NET:fix/ma/ref-serialization-errorsCopy head branch name to clipboard
Merged
Fix $ref serialization errors for requestBodies and responses#1033millicentachieng merged 6 commits intovnextmicrosoft/OpenAPI.NET:vnextfrom fix/ma/ref-serialization-errorsmicrosoft/OpenAPI.NET:fix/ma/ref-serialization-errorsCopy head branch name to clipboard
millicentachieng merged 6 commits intovnextmicrosoft/OpenAPI.NET:vnextfrom
fix/ma/ref-serialization-errorsmicrosoft/OpenAPI.NET:fix/ma/ref-serialization-errorsCopy head branch name to clipboard
Conversation
…odies and responses respectively during v2 serialization
baywet
requested changes
Oct 6, 2022
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Merged
fc5d8ea to
1de587c
Compare
baywet
approved these changes
Oct 6, 2022
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
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.
Fixes #1000
This PR
requestBodiesto refparametersin v2 serializationconsumesandproducesproperties when there are ref requestBodies and responses in v2 serializationExample with ref Request Body
paths: '/Documents({Id})/Revisions/$ref': post: tags: - Documents.RevisionDto summary: Create new navigation property ref to Revisions for Documents operationId: Documents.CreateRefRevisions - consumes: [ ] + consumes: + - application/json parameters: - in: path name: Id description: 'key: Id of DocumentDto' required: true type: integer format: int32 maximum: 2147483647 minimum: -2147483648 x-ms-docs-key-type: DocumentDto - - in: body - name: body - schema: { } + - $ref: '#/parameters/refPostBody' responses: '204': description: Success default: $ref: '#/responses/error' x-ms-docs-operation-type: operation parameters: + refPostBody: + in: body + name: body + description: New navigation property ref value + required: true + schema: + $ref: '#/definitions/ReferenceCreate'Example with ref Response
paths: '/Tasks({Id})/Default.Upload': post: tags: - Tasks.Actions summary: Invoke action Upload operationId: Tasks.DocumentDto.Upload + produces: + - application/json parameters: - in: path name: Id description: 'key: Id of DocumentDto' required: true type: integer format: int32 maximum: 2147483647 minimum: -2147483648 x-ms-docs-key-type: DocumentDto responses: '200': $ref: '#/responses/UploadResponse' default: $ref: '#/responses/error' x-ms-docs-operation-type: action x-description: Provides operations to call the Upload method. responses: UploadResponse: description: Success schema: $ref: '#/definitions/Siterra.Documents.App.DTO.DocumentDto'