Fix validation for generators that expect at least one success response #113
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
This update adds at least one successful HTTP `Response Object` to each `Responses Object`. According to OAS 3.0.3 Spec: > The default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification. > > The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. [Specification link](https://swagger.io/specification/v3/#:~:text=and%20it%20SHOULD%20be%20the%20response%20for%20a%20successful%20operation) Providing at least one response for a successful operation is only a recommendation (SHOULD), but not returning a success response for these operations doesn't make sense from a practical point of view. According to the current document, the `paths./pet/{petId}.delete` operation, for example, can only return an error, even if the operation was successful. The example server, however, returns a 200. Fixes swagger-api#112
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 update adds at least one successful HTTP
Response Objectto eachResponses Object.According to OAS 3.0.3 Spec:
Specification link
Providing at least one response for a successful operation is only a recommendation (SHOULD), but not returning a success response for these operations doesn't make sense from a practical point of view.
According to the current document, the
paths./pet/{petId}.deleteoperation, for example, can only return an error, even if the operation was successful. The example server, however, returns a 200.Fixes #112