-
-
Notifications
You must be signed in to change notification settings - Fork 7k
[php-symfony] fix handling of endpoints with "text/plain" or "image/png" response type #21261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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 OpenAPITools#13334. This also partly makes the open PR OpenAPITools#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.
...napi-generator/src/main/java/org/openapitools/codegen/languages/PhpSymfonyServerCodegen.java
Outdated
Show resolved
Hide resolved
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.
thanks again for the pr is it correct to say that you've been using these fixes/enhancements in your local environment/production for a while? |
Yes, I'm using these fixes for my local development. |
ok. let's give it a try |
thanks! |
PR OpenAPITools#21261 added support for endpoint with response of type text/plain or even image/png. This commit adds such endpoint so that: - the way those are supported is clearer (as it is now directly visible in the generated sample files) - if a future commit impacts this part of the generation it will be easier to assess that impact
PR #21261 added support for endpoint with response of type text/plain or even image/png. This commit adds such endpoint so that: - the way those are supported is clearer (as it is now directly visible in the generated sample files) - if a future commit impacts this part of the generation it will be easier to assess that impact
(This is the update of #21258 that I pushed too soon the other day. This time I took more time to thoroughly think it before opening this PR)
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.0
minor 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.getOutputFormat
returns a valid format when the user accepts*/*
(or when they don't specify any Accept header)->serialize($data, ...)`` when the 2nd argument is
null` (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!)