Comment annoter un champ comme obsolète dans OpenAPI (Swagger) 2.0?

Question

J'ai la définition de schéma suivante:

swagger: '2.0'
...
definitions:
  Service:
    type: object
    properties:
      serviceId:
        type: string
        description: Device or service identification number
        example: 1111111111      
      location:
        type: string
        description: Location of the service
        example: '400 Street name, City State postcode, Country'

Je voudrais annoter le champ location comme obsolète. Y a-t-il un moyen de faire cela?

Answer 1

La possibilité de marquer les schémas et les propriétés de schéma comme deprecated a été ajoutée dans OpenAPI 3.0:

openapi: 3.0.1
...
components:
  schemas:
    Service:
      type: object
      properties:
        location:
          type: string
          description: Location of the service
          example: '400 Street name, City State postcode, Country'
          deprecated: true    # <---------

Si vous utilisez OpenAPI 2.0 (Swagger 2.0), la seule chose que vous pouvez faire est de documenter verbalement la dépréciation dans la propriété description.

Answer 2

selon documentation il suffit d'utiliser l'attribut deprecated

/pet/findByTags:
get:
  deprecated: true