How to show the definition of nested attributes in Apiary.io

Question

I have a data structure defined as follows:

# 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. 

I am trying to use this data structure in another action definition as follows:

 ## 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 (eg Race For the Galaxy unique Id) of the Played Game. + datePlayed (string, optional) - The date the game was played in yyyy-MM-dd format (eg 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. 

I want the Apache.io Documentation to show not only the definition of top-level attributes, but also PlayerRank objects. As a developer trying to understand the user interface, I want to see the definition of each object and field so that I know how to correctly form the request. Now he gives only a description of the playerRanks object: "A collection of PlayerRank objects that determines the rating of the game and the points scored for each player." but it does not extend the definition to show all the properties of the PlayerRank data structure.

Any idea if the Apiary.io documentation could facilitate this?

Answer 1

now Apiary, the Blueprint API supports nested objects that you can define below, for example

 + 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 is a beta function and the user interface is not finished yet, see this github issue for more information and a preview of the future birght.