Generating description with $ref

[avantipande1]

Home:
      type: object
      properties:
        home_address:
                 description: "its the home address"
                 $ref: '#/components/schemas/Address'
Office:
      type: object
      properties:
        office_address:
                 description: "its the office address"
                 $ref: '#/components/schemas/Address'

This is a kind of swagger I want to generate with annotations, where I can have specific descriptions for home and office addresses.
Is there anyway swagger-ui will read this description for $ref?

swagger-api/swagger-editor#1184 (comment)

This is one of the solution I found but there is no way to generate it with annotations.
Thanks

[webron]

Currently, the OpenAPI specification does not support any additional attributes alongside a $ref, so there's nothing we can do about it. The next version of the spec will support it, but that's months away.

[avantipande1]

Currently, the OpenAPI specification does not support any additional attributes alongside a $ref, so there's nothing we can do about it. The next version of the spec will support it, but that's months away.

Thanks Ron for the update.

[webron]

Going to close this as there's nothing we can do about it.

[DepickereSven]

It's supported in OpenAPI 3.1.0
Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#referenceObject

[m1ks]

Hi, should we open this issue again since the feature is now supported in OpenAPI 3.1.0?

[yehor-manzhula]

@m1ks Here is the new issue #4013