web-dev-qa-db-ja.com

OpenAPI（Swagger）2.0で廃止されたフィールドに注釈を付ける方法は？

次のスキーマ定義があります。

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'

locationフィールドに非推奨として注釈を付けたいのですが。これを行う方法はありますか？

swaggerswagger-2.0openapi
20
saeedj

スキーマおよびスキーマプロパティをdeprecatedとしてマークする可能性が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    # <---------

OpenAPI 2.0（Swagger 2.0）を使用する場合、できることは、プロパティdescriptionに非推奨を口頭で文書化することだけです。

4
Helen

documentation によると、deprecated属性を使用するだけで十分です

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