Apiary: Is it possible to document what JSON response fields are?
I don't think it is supported yet.
I solved this problem in my project by putting a table with the description right above the GET request line. In your case it could look like:
### List all Applications | Field | Description ||----------------------------------|---------------------------|| Catalog.Applications.OtherFields | Documentation goes here.. |### Get List of Applications [GET]
To help you create the table in Markdown syntax you can use Markdown Tables generator.
Note that the table generator lets you save the table definition to a file so next time you would need to edit the table you can start from where you left off .
Update: We have just rolled out a beta of attributes description using the MSON syntax.
The original payload could be then described as
### Get List of Applications [GET]+ Response 200 (application/json) + Attributes + Catalog (object) + Page: 0 (number) - Number of the page + Count: 6 (number) - Count of *Lorem Ipsum* + Applications (array) - Some array of something + (object) + UID: `6882e96a-5da1-11e3-1111-3f24f45df3ad` + OtherFields + Body { "Catalog" : { "Page" : 0, "Count" : 6, "Applications" : [{ "UID" : "6882e96a-5da1-11e3-1111-3f24f45df3ad" "OtherFields": "" }] } }
Note the explicit JSON in body is redundant and you can skip it completely. See API Blueprint specification – Attributes for additional details