Примитивный тип как структура данных для API Blueprint
Я хочу использовать примитивный тип для описания структуры данных. Вот так:
# Data Structures
## Video Delete (enum[number])
+ `0` - Successful deletion.
+ `1` - Error occured.
И вывод есть.
{
"enum": [
1,
0
],
"$schema": "http://json-schema.org/draft-04/schema#"
}
Так что описание отсутствует. Я пытался поместить описание в разных местах. Я сделал много вещей (не хочу говорить о них). Также я попытался добавить информацию для перечисления значений следующим образом:
+ `0` (number) - Successful deletion.
Я не знаю, касается ли эта проблема синтаксиса MSON или генератора Aglio.
1 ответ
Насколько я могу судить, синтаксис выше поддерживается MSON. Проблема в том, что Aglio ничего не делает с описанием, и когда я пошел, чтобы посмотреть, как добавить его, я понял, что оно не поддерживается в JSON Schema. Кажется, есть два метода, которые люди используют, чтобы обойти этот факт:
Добавьте перечисленные описания значений к основному описанию, тема Olio 1.6.2 имеет поддержку для этого, но синтаксический анализатор C++, похоже, все еще имеет некоторые ошибки вокруг этой функции:
## Video Delete (enum[number]) - 0 for success, 1 for error
Использовать странный
oneOf
синтаксис, в котором вы создаете наборы отдельных перечислений с описанием. Я не рекомендую это.
К сожалению, первый вариант требует работы с вашей стороны и не может быть легко выполнен в Aglio. У кого-нибудь есть лучшее описание и некоторые примеры ввода MSON -> Схема JSON?