描述枚举

了解如何为枚举添加描述。

当 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.