apiblueprint - How To Show Nested Attribute Definition In Apiary.io -
i have data structure defined follows:
# data structures ## playerrank (object) represents minimum amount of data the client needs send give rank information particular player in particular played game. + playerid (number, required) - nemestats unique identifier player. + gamerank (number, required) - corresponding rank of player in played game. rank of 1 means player got first place, 2 means second place, , on. + pointsscored (number, optional) - integer number of points player scored in played game. i'm attempting use data structure in action definition follows:
## create new played game [post] service record new played game. + attributes + gamedefinitionid (number, required) - nemestats unique identifier game definition (e.g. race galaxy's unique id) of played game. + dateplayed (string, optional) - date game played in yyyy-mm-dd format (e.g. 2015-04-29). + notes (string, optional) - notes or comments user wants record game future reference. + playerranks (array[playerrank], required) - collection of playerrank objects specifying game rank , points scored each player. see below table details. what want happen apiary.io documentation show definition of not top level attributes of playerrank object. developer trying understand ui, want see definition of each object , field know how form request. right gives description playerranks object : "a collection of playerrank objects specifying game rank , points scored each player." doesn't expand definition show of properties of playerrank data structure.
any idea if apiary.io documentation can facilitate this?
now apiary, api blueprint supports nested objects can define below example
+ attributes (object) + name: iphone 6 / 6s (string, required) - offer name + price: 10.4 (number) - offer price can number 2 decimal places, sale price + offer_options (object) + option_name: black (string, required) - offer option name + max_qty: 0 (number) - purchase limit quantity
Comments
Post a Comment