The page https://swagger.io/docs/specification/using-ref/ says that when I am using $ref in an OpenAPI spec all sibling properties are ignored. It is not quite clear if there is a way to workaround this issue. Can I use for example
- $ref: '#/components/schemas/MyType'
- description: My description
Go to Solution.
that depends of what open api version are you working, for openapi version 3.0.x the reference object does not have any other fields than $ref, you can check that here .
But for open api 3.1.x you can certainly add a description to the reference object as it's described here
View solution in original post
... or even this (which I found on Internet):
description: My description
As I understand, version 3.1 is not released yet? Do you know anything about planned release date?