Description des enums

Apprenez comment ajouter des descriptions aux enums

Lorsqu'une opération d'API inclut une énumération, vous pouvez ajouter x-enumDescriptions pour fournir plus de contexte sur chaque option. GitBook affichera les valeurs de l'énumération et leurs descriptions dans un tableau à côté de l'opération.

openapi.yaml

openapi: '3.0'
info: ...
components:
  schemas:
    project_status:
      type: string
      enum:
        - LIVE
        - PENDING
        - REJECTED
      x-enumDescriptions:
        LIVE: Le projet est en ligne.
        PENDING: Le projet est en attente d'approbation.
        REJECTED: Le projet a été rejeté.