-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
[PHP-Client] Allow Content-Type merge-match+json for encoding #19479
Conversation
modules/openapi-generator/src/main/resources/php/libraries/psr-18/api.mustache
Outdated
Show resolved
Hide resolved
modules/openapi-generator/src/main/resources/php/libraries/psr-18/api.mustache
Outdated
Show resolved
Hide resolved
private function bodyShouldBeEncoded(string $contentType): bool | ||
{ | ||
return preg_match('~^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)~', $contentType) === 1; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about adding this function in the api client class instead?
can we name this method as isJsonMime?
minor suggestion: add a docstring explaining what this function does
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure, what you mean by "what about adding this function in the api client class instead?"
As this is a method used throughout the code and if not working properly results in Exceptions being thrown, I think it is quite important.
What I could think of, is implementing a separate Class "JsonDetector" or anything with a single method, which could be injected via consturctor DI. Would this be a good solution or are you thinking of anything else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry for the confusion, api client class (ApiClient.php) is in client generated by php-dt generator but not php client generator.
shall we put the function in HeaderSelector class instead which has something similar already?
$headersWithJson = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you have something like this in mind?
all tests passed locally:
thanks again for the PR |
Some APIs offer a PATCH-Request method for Entities and use "application/merge-patch+json" as Content-Type. This was not detected as json_encode and ObjectSerializer target and thus resultet in an Exception,
This PR fixes this.
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
(upcoming 7.6.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)@jebentier , @dkarlovi , @mandrean , @jfastnacht , @ybelenko , @renepardon