You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
Note: this is a duplicate of #1727. I'm not sure if this community prefers to reopen closed issues or create a new issue after closing the original. Feel free to close this issue if the preference is to reopen the original.
I'm still able to reproduce this issue in redoc-cli@0.13.16. Seeing the base description rather than the sibling/overridden one. Will see the sibling description if the base has no description.
Worth noting, the issue isn't specific to description, any base property will render if it exists. So base examples can't be overridden either, for example. I'm not sure if the expectation is for the derived object to be arbitrarily override any base property or if Redoc is expected to only override specific properties (such as description).
Expected behavior
When there are siblings of $ref, it is expected that the siblings override any properties that are also founded in the referenced object.
Minimal reproducible OpenAPI snippet(if possible)
Described in #1727.
The text was updated successfully, but these errors were encountered:
It looks like OpenAPI versions before 3.1 did not allow any siblings to $ref. But, 3.1 explicitly allows summary and description, so those should override the summary and description of the referenced object if applicable.
The 3.1 include JSON Schema draft 2020-12 which allows all keywords siblings inside the schema object. But the sibling keywords do not override the keywords in the referenced schema, they add to them. Link to issue .
In OpenApi 3.1 spec the summary and description should override the referenced object.
I think correct behavior:
overriding description and summary in any part of the definition
add keywords inside the schema object(draft 2020-12).
Describe the bug
Note: this is a duplicate of #1727. I'm not sure if this community prefers to reopen closed issues or create a new issue after closing the original. Feel free to close this issue if the preference is to reopen the original.
I'm still able to reproduce this issue in
redoc-cli@0.13.16
. Seeing the base description rather than the sibling/overridden one. Will see the sibling description if the base has no description.Worth noting, the issue isn't specific to description, any base property will render if it exists. So base examples can't be overridden either, for example. I'm not sure if the expectation is for the derived object to be arbitrarily override any base property or if Redoc is expected to only override specific properties (such as
description
).Expected behavior
When there are siblings of $ref, it is expected that the siblings override any properties that are also founded in the referenced object.
Minimal reproducible OpenAPI snippet(if possible)
Described in #1727.
The text was updated successfully, but these errors were encountered: