2015-11-24 3 views
0

У меня есть два свойства, один из которых должен быть поставлен. Я пытался добавить комментарий в нижней части структуры данных, но он был проигнорирован. Так что я попробовал описание нескольких линий, но это также было проигнорировано:Добавление комментариев к структуре данных в API Blueprint

# Data Structures 

## Record (object) 

+ ResponseId: `42f7b8b07da641bcb6d96422cb903c0e` (string, optional) - Identifier for the record being updated 
+ UniqueReference: 1 (number, optional) - Reference for the record being updated. 

    If both are supplied, response id will be used 

ответ

1

Добавить описание в верхней части и использовать member type separator, чтобы отделить его от свойств элементов.

Например.

# Data Structures 

## Record (object) 

If both are supplied, response id will be used 

### Properties 

- ResponseId: 42f7b8b07da641bcb6d96422cb903c0e (string, optional) - Identifier for the record being updated 
- UniqueReference: 1 (number, optional) - Reference for the record being updated. 
+0

Если я не сделал что-то не так, это не помогло. 'ФОРМАТ: 1A HOST: http://test.apiblueprint.org/ # Тест ## обратного тока [/ API/Backfeeds] ### одной записи обратного тока [PUT] + Атрибуты (BackfeedRecord) + Запрос (применение/JSON) { "UniqueReference": 4} + отклик 202 # Структура данных ## BackfeedRecord (объективистский т) Если оба поставляются, идентификатор ответа будет использоваться ### Свойства + ResponseId: 42f7b8b07 (String, необязательный) - идентификатор записи обновляется + UniqueReference: 1 (номер, необязательно) - ссылка для обновляемой записи. ' – sixeyes

+0

@sixeyes вы можете вставить чертеж в ответ или использовать его, чтобы связать его – Zdenek

+0

https://gist.github.com/anonymous/f1553488787ccdfd4e9c – sixeyes

 Смежные вопросы

  • Нет связанных вопросов^_^