web-dev-qa-db-de.com

Wie kommentiere ich ein Feld als veraltet in OpenAPI (Swagger) 2.0?

Ich habe die folgende Schemadefinition:

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'

Ich möchte das Feld location mit Anmerkungen versehen, da es veraltet ist. Gibt es eine Möglichkeit, dies zu tun?

3
saeedj

Die Möglichkeit, Schemas und Schemaeigenschaften als deprecated zu markieren, wurde in OpenAPI 3.0 hinzugefügt:

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    # <---------

Wenn Sie OpenAPI 2.0 (Swagger 2.0) verwenden, können Sie die Nichtbeachtung nur mündlich in der Eigenschaft description dokumentieren.

4
Helen

laut Dokumentation reicht es aus, das Attribut deprecated zu verwenden

/pet/findByTags:
get:
  deprecated: true
1
Tomas