列挙型の説明

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

API 操作に enum が含まれている場合、追加できます x-enumDescriptions 各オプションについてより詳しい文脈を提供するために。GitBook は、操作の横にある表に enum の値とその説明を表示します。

openapi.yaml

openapi: '3.0'
info: ...
components:
  schemas:
    project_status:
      type: string
      enum:
        - LIVE
        - PENDING
        - REJECTED
      x-enumDescriptions:
        LIVE: プロジェクトは公開されています。
        PENDING: プロジェクトは承認待ちです。
        REJECTED: プロジェクトは却下されました。