API Blueprint: Array в разделе «Атрибуты» отсутствует схема

Question

Я использую API Blueprint для описания RESTful API.

Один из методов API возвращает массив. Я использую Payload Attributes description следующим образом;

+ Attributes (array) 
    + example_string_text (string, required) - Explanation. 
    + another_example_str (string, required) - The same explanation. 

Я уверен, что это неверно, но я не смог найти правильный путь.

Указатели на части документации, которые я пропустил, тепло приветствуются.

Answer 1

Похоже, что вы пытаетесь сделать массив объектов, в этом случае вам нужно добавить анонимный тип объекта:

+ Attributes (array) 
    + (object) 
     + example_string_text (required) - Explanation. 
     + another_example_str (required) - The same explanation. 

Кроме того, обратите внимание, что string является типом по умолчанию так что вы обычно дон 't нужно написать это явно (если вы не хотите).

Answer 2

Я нашел хороший ответ на https://github.com/apiaryio/api-blueprint/issues/237#issuecomment-125943217

работы со мной для ввода атрибутов

## Events [/events] 
### View [GET] 

+ Response 200 (application/json) 
    + Attributes (array) 
     + (Event) 
     + (Event) 
      + name: Katie 
     + (Event) 

## Data Structures 
### Event (object) 
+ name: Kyle (string) 

Answer 3

Я предполагаю, что вы хотите, это массив строки:

Вот пример:

+ Attributes (array) 
    + `USA` - Country 
    + `California` - State 

И документ, который вы можете захотеть читать здесь: MSON:arrays