[php-symfony] fix handling of endpoints with "text/plain" or "image/png" response type#21258
Closed
gturri wants to merge 3 commits intoOpenAPITools:masterfrom
gturri:dev
Closed
[php-symfony] fix handling of endpoints with "text/plain" or "image/png" response type#21258gturri wants to merge 3 commits intoOpenAPITools:masterfrom gturri:dev
gturri wants to merge 3 commits intoOpenAPITools:masterfrom
gturri:dev
Conversation
When a query has header "Accept" set to "*/*" it means it accepts everything. It is hence weird to return a 406. This patch ensures it does not occur: when the query accepts everything then we take any produced type. This fixes #13334. This also partly makes the open PR #15560 obsolete (or at least, it provides a workaround)
$this->convertFormat may return "null". When it's the case we end up
calling
...->serialize($data, null);
but this crashes at runtime because that serialize method declares that
the 2nd parameter is of type "string" (so null is not accepted).
With this patch we avoid having an error 500. Instead we return something
that makes perfect sense when the OpenApi specification declares a content
of type "text/plain" and that the returned value is for instance a string,
an int, or a boolean.
This fixes the generated returned type of controller methods for
endpoint with a response declared like
content:
text/plain:
schema:
type: <boolean|string|integer|number>
or for
content:
image/png:
schema:
type: string
format: binary
Without this commit the generated method *had to* return a value that
matched "array|object|null", which does not work in this case.
This commit makes it possible to return the proper type.
Contributor
Author
|
I'm afraid I'm seeing an issue in the last commit that I did not spot yesterday. I'm closing that PR and will recreate a new one once I have more thoroughly tested it. |
Merged
5 tasks
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
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.
PR checklist
Commit all changed files.
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*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)This fixes #21256 (and this subsequently fixes #13334, which is a subset of the other one).
This PR implements the 3 fixes that are required to be able to handle all the endpoints described in this OpenApi specification:
Namely this:
Controller.getOutputFormatreturns a valid format when the user accepts*/*->serialize($data, ...)`` when the 2nd argument isnull` (it would crash (error 500)). Instead it uses a straightforward way to handle the serialization in those simple casestext/plain(nb: to make it easier to review I did a separate commit for each of those 3 fixes)
Ping technical committed, ie: @jebentier @dkarlovi @mandrean @jfastnacht @ybelenko @renepardon (and thanks for your work!)