Apiary: Is it possible to document what JSON response fields are?

Question

I would like to document what the actual JSON fields themselves represent.

I have documented the GET statement, and parameters but this does not make a complete document

Answer 1

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 .