-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
Ref description override component #22114
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
base: master
Are you sure you want to change the base?
Ref description override component #22114
Conversation
| ref.setDescription(schema.getDescription()); | ||
| } | ||
| } | ||
|
|
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.
thanks for the fix
but this change will permanently update the description of the reference schema.
if the reference schema is used somewhere else, the description will be the overridden one instead of the original one.
i think a better way to fix it is in the fromProperty in default codegen. or maybe using normalizer to fix it.
I'll try to find time to come up with a fix later this week
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.
fromProperty what do you mean? Please clarify, maybe I can update the approach
|
here is a workaround using allOf: |
I don't understand the comment. |
|
working on a fix. stay tuned... |
|
Just filed #22364. Please test the change locally when you've time. |
In OpenAPI 3.1 the description of the Reference Object SHOULD override that of the referenced component.
This PR corrects the unaliasing of the referenced schema, ovverriding the description of the referenced schema.
A test has been added to verify
unaliasSchemaas well a test in the Typescript generator.@wing328
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)"fixes #123"present in the PR description)