Как ссылаться на значение перечисления в API Blueprint(MSON)
Я использую API Blueprint и Agilo для отображения документации по API. При использовании типа enum я наблюдаю странное поведение. Ответ не отображается с определенным значением перечисления, тогда как схема показывает все значения перечисления (что ожидается), а также объявленное значение ("Понедельник" - см. Фактический).
Раздел структуры данных
# Data Structures
## Days (enum[string])
+ `Monday`
+ `Tuesday`
+ `Wednesday`
+ `Thursday`
## ListEntry
- playOrder: 1 (number)
- Id: 37a21975a499494f03367 (string)
- programDay: `Tuesday` (Days)
## `sample-request-200`
- id: 58828b2941cc351348 (string)
- startDate: `2019-08-01T11:00:00.000Z` (string)
- endDate: `2019-08-05T11:55:59.000Z` (string)
- Language: `en-US` (string)
- entries: ListEntry (array[object])
Раздел API запроса документации
+ Request
+ Headers
Content-Type: application/json
+ Attributes (sample-request-200)
фактический
---- JSON Body ----
{
"playOrder": 1,
"Id": "37a21975a499494f03367",
"programDay": "Hello, world!" // Agilo shows "Hello,World" when some error occurred
}
-----Generated Schema-----
"programDay": {
"type": "string",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Monday"
]
}
Желаемый
---- JSON Body ----
{
"playOrder": 1,
"Id": "37a21975a499494f03367",
"programDay": "Monday"
}
-----Generated Schema-----
"programDay": {
"type": "string",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday"
]
}
Любая идея о том, как использовать определенную структуру данных перечисления в проекте API (MSON). Не уверен, как ссылаться на значение перечисления в объекте.
Правильно ли использовать как ниже для ссылки на значение перечисления?
- programDay: `Tuesday` (Days)
0 ответов
Состав:
# Data Structures
## Device (enum)
+ `mobile`
+ `desktop`
Используйте так:
+ Request (multipart/form-data)
+ Attributes
+ `id`: abc (required)
+ `device` (Device)
Полученные результаты: