fix: use short name when generating parameter description #6155
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
priyadi
force-pushed
the
fix/short-name-parameter-description-2
branch
from
2914bda
to
0a84f49
Compare
priyadi
force-pushed
the
fix/short-name-parameter-description-2
branch
from
0a84f49
to
3fee80b
Compare
soyuka
reviewed
Feb 12, 2024
| @@ -265,7 +265,14 @@ private function collectPaths(ApiResource $resource, ResourceMetadataCollection | |||
| continue; | |||
| } | |||
|
|
|||
| $parameter = new Parameter($parameterName, 'path', (new \ReflectionClass($uriVariable->getFromClass()))->getShortName().' identifier', true, false, false, ['type' => 'string']); | |||
| $fromClass = $this->resourceMetadataFactory->create($uriVariable->getFromClass()); | |||
There was a problem hiding this comment.
interesting but I think that this is quite a lot of work, probably that this should actually get fixed by #5995
There was a problem hiding this comment.
I'm not sure if I understand. I don't use any filtering feature at all. My Problem is simply this:
This is BookDto as an ApiResource with its shortName set to Book. As you can see, all the labels are correct, except for the one in the parameter. All this time we had to fix it by overriding it in openapiContext.
soyuka
pushed a commit
to Timu57/core
that referenced
this pull request
Feb 29, 2024
soyuka
pushed a commit
that referenced
this pull request
Feb 29, 2024
|
let me know if you still have an issue with this patch, I'm releasing it soon |
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.
OpenApiFactory previously only uses class name when generating parameter description, and did not respect the
shortNameparameter. This PR fixes the problem.