列挙型（enums）の説明

列挙型に説明を追加する方法を学ぶ

API 操作に列挙型が含まれる場合、各オプションについての詳細情報を追加できます x-enumDescriptions 各オプションに関するコンテキストを提供します。GitBook は操作の横に列挙値とその説明を表形式で表示します。

openapi.yaml

openapi: '3.0'
info: ...
components:
  schemas:
    project_status:
      type: string
      enum:
        - LIVE
        - PENDING
        - REJECTED
      x-enumDescriptions:
        LIVE: The project is live.
        PENDING: The project is pending approval.
        REJECTED: The project was rejected.