Support overriding description
of $ref
as part of OpenAPI 3.1
#484
Labels
enhancement
New feature or request
description
of $ref
as part of OpenAPI 3.1
#484
Hello,
I'm trying to add linting to large OpenAPI 3.1 files and and got many
no-$ref-siblings
errors because we often override thedescription
to add more details.Since this was supported by some tools and not others I started digging a bit more into what the standard actually is.
It seems that starting with OpenAPI 3.1, it is possible to override the
description
andsummary
of a reference, but ONLY those two fields.Here's a link to the relevant part of the spec : https://spec.openapis.org/oas/v3.1.0#reference-object
And a relevant issue on the OpenAPI-Specifcation repo confirming this behaviour : OAI/OpenAPI-Specification#2744
Here's a quick a example that works if you paste it in https://editor-next.swagger.io, and stops working when setting the OpenAPI version to
3.0.0
:The text was updated successfully, but these errors were encountered: