Как Показать вложенное определение атрибута В ​​Apiary.io

Question

У меня есть структура данных определяются следующим образом:

# Data Structures 

## PlayerRank (object) 
Represents the minimum amount of data the the client needs to send to give rank information about a particular Player in a particular Played Game. 
+ playerId (number, required) - NemeStats unique identifier for the Player. 
+ gameRank (number, required) - The corresponding rank of the Player in this Played Game. A rank of 1 means the Player got first place, 2 means second place, and so on. 
+ pointsScored (number, optional) - Integer number of points the Player scored in the Played Game. 

Я пытаюсь использовать эту структуру данных в другом определении действия следующим образом:

## Create a new Played Game [POST] 
This service will record a new Played Game. 

+ Attributes 
    + gameDefinitionId (number, required) - NemeStats unique identifier for the Game Definition (e.g. Race For the Galaxy's unique Id) of the Played Game. 
    + datePlayed (string, optional) - The date the game was played in yyyy-MM-dd format (e.g. 2015-04-29). 
    + notes (string, optional) - Any notes or comments that the User wants to record about the game for future reference. 
    + playerRanks (array[PlayerRank], required) - A collection of PlayerRank objects specifying the game rank and points scored for each Player. See below table for details. 

Что я хочу сделать для документации Apiary.io, чтобы показать определение не только атрибутов верхнего уровня, но и свойств объекта PlayerRank. Как разработчик, пытающийся понять пользовательский интерфейс, я хочу увидеть определение каждого объекта и поля, чтобы я знал, как правильно сформировать запрос. Сейчас он дает только описание объекта playerRanks: «Коллекция объектов PlayerRank, определяющая рейтинг игры и очки, набранные для каждого игрока». но он не расширяет определение, чтобы показать все свойства структуры данных PlayerRank.

Любая идея, если документация Apiary.io может облегчить это?

Answer 1

Теперь Пасека, API Blueprint поддерживает вложенные объекты, которые вы можете определить, как показано ниже, например

+ Attributes (object) 
    + name: iPhone 6/6s (string, required) - Offer Name 
    + price: 10.4 (number) - Offer price 
     can be a number with 2 decimal places, this is the sale price 
    + offer_options (object) 
     + option_name: black (string, required) - offer option name 
     + max_qty: 0 (number) - Purchase limit to this quantity 

Answer 2

AFAIK это бета-функция, и пользовательский интерфейс еще не закончен, см. this github issue для получения дополнительной информации и предварительного просмотра будущего birght.