Как показать все примеры строк в модели Swagger Do c - PullRequest
Новая
       29

Как показать все примеры строк в модели Swagger Do c

0 голосов
/ 07 мая 2020

Одна из моих моделей в swagger возвращает свойство 'Status', которое может быть одной из нескольких строк.

например: 

"Status" : {
    "type":"string",
    "example" : "'Completed' || 'Group Completed' || 'Errored' || 'Group Errored' || 'Ready' || 'Stopped By User' ||  'Initializing' || 'Queued' || 'Group Queued' ||  'Running' || 'Group Running' ||  'Stopping' || 'Group Stopping'"
               },

Выполнение этого способа выглядит очень беспорядочно. Как лучше всего показать пользователю все эти возможные результаты?

1 Ответ

1 голос
/ 07 мая 2020

Определите enum для этого свойства: 

"Status" : {
  "type": "string",
  "enum": [
    "Completed",
    "Group Completed",
    "Errored",
    ...
  ]
}

Средство визуализации документации отобразит все значения перечисления в документации схемы.

...