Лучшая практика показывать enum в примерах ответов в YAML swagger - PullRequest
Новая
       8

Лучшая практика показывать enum в примерах ответов в YAML swagger

0 голосов
/ 16 апреля 2020

Я пишу API, и в своем документе я хочу показать клиенту пример ответа.

Одно свойство ответа dataset -> @type - это Enum, и я хочу перечислить все возможные значения в примерах ответов. 

      responses:
        "200":
          description: "success"
          content:
            application/ld+json:
              schema:
                  ...
              examples:
                  value:
                    "dataset":
                      "@id": 123
                      "@type":
                         "oneOf": ['NewData', 'HistoryData']

Это выглядит странно после рендеринга. 

"dataset": {
   "@id": 123
   "@type": {
      "oneOf": [
        "NewData",
        "HistoryData"
        ]
},

Это огромный отклик, и единственное отличие - это тип. Поэтому я не хочу копировать все, только изменить тип и добавить пример.

Какой лучший способ сделать это?

...