Don't generate requestBody in DELETE method, which is not allowed in OpenAPI v3.0.3 spec #243
+5
−55
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
|
FYI @exoego that logger issue making the tests fail is something to do with a gem dependancy changing, I can fix it in this PR if you'd like? |
|
@dantherussell Nice but can you create a separate PR? |
Sure - #244 |
dantherussell
force-pushed
the
fix-semantic-error-for-deletes
branch
from
f6be466 to
1b22e52
Compare
exoego
approved these changes
Feb 4, 2025
exoego
changed the title
|
@dantherussell Thanks for the PRs. This was released in https://rubygems.org/gems/rspec-openapi/versions/0.18.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.
While testing some generated docs which included a
DELETEoperation, the Swagger editor gave me the following error:When I looked into it, I found out that in v3.0.3 of the OpenAPI Spec (which is what this gem currently generates), a
requestBodyin aDELETEoperation is not allowed, as the HTTP 1.1 specification Section 4.3.1 does not have explicitly defined semantics for request bodies inDELETE.This has changed in v3.1.0, where for such operations,
requestBodyis permitted but does not have well-defined semantics and, as per the specification, should be avoided if possible.The
schema_builderwas already using a nilrequestBodyforGETrequests, so I have modified it slightly to do the same forDELETE.