[dart2] Include request body on DELETE call#10100
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Aug 7, 2021
Merged
[dart2] Include request body on DELETE call#10100wing328 merged 2 commits intoOpenAPITools:masterfrom
wing328 merged 2 commits intoOpenAPITools:masterfrom
Conversation
This change updates the generated `ApiClient` to include the request body on DELETE calls. [Per the RFC on page 2][1], DELETE calls are allowed to have a request body, even though the behavior may be undefined. I've not come across many APIs that use this behavior but there are a few, in particular the [Ory Kratos API][2] does so, not forwarding the body prevents such an API from being used. An API spec that does not define a request body should continue to function as expected. [1] https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.5 [2] https://www.ory.sh/kratos/docs/reference/api/#operation/submitSelfServiceLogoutFlowWithoutBrowser
Contributor
|
openapi spec 3.0.3 says delete can contain body, so that's ok with me even if other openapi generated clients dont support it. |
agilob
approved these changes
Aug 5, 2021
amondnet
approved these changes
Aug 6, 2021
kuhnroyal
approved these changes
Aug 6, 2021
ekilmer
added a commit
to ekilmer/openapi-generator
that referenced
this pull request
Aug 16, 2021
* master: (849 commits) Don't use encodeCollectionQueryParameter on maps (OpenAPITools#10116) Fixed the utc time issue for httpSigning auth. (OpenAPITools#10139) [dart][dio] Update built_value to =>8.1.0 (OpenAPITools#10122) Add Inquisico to list of generator users (OpenAPITools#10142) add my companies to README (OpenAPITools#10146) [C][Client] Allocate memory for the element of array when the type is number (OpenAPITools#10124) update samples Fixed typo in csharp-netcore httpclient generated code (OpenAPITools#10119) Typescript-angular: Added missing semi colon to interface export in `apis.ts` template file. (OpenAPITools#10121) Fix issue 10020: [BUG] [typescript-angular] Add "header" to reserved words (OpenAPITools#10091) Add missing samples for OpenAPITools#9857 [typescript] FIX: Generate documentation and examples OpenAPITools#9413 (OpenAPITools#9857) Feat adds has discriminator with non empty mapping (OpenAPITools#9667) Add switches (authentication collections) to support files (OpenAPITools#9884) [dart-dio-next] improve encodeCollectionQueryParameter to handle cases where collectionFormat is null (OpenAPITools#10105) [go-server] Feat: add required assertions to models (OpenAPITools#10068) [dart2] Include request body on DELETE call (OpenAPITools#10100) Make php's array a primitive (OpenAPITools#10093) Fix typo (preffer -> prefer) (OpenAPITools#10098) Fix typo on rust client (OpenAPITools#10096) ...
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
5 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.
This change updates the generated
ApiClientto include the request body on DELETE calls. Per the RFC on page 2, DELETE calls are allowed to have a request body, even though the behavior may be undefined. I've not come across many APIs that use this behavior but there are a few, in particular the Ory Kratos API does so, not forwarding the body prevents such an API from being used. An API method that does not define a request body should continue to function as expected as the body would be null in that scenario.PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master,5.3.x,6.0.x@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12)