apiary.apib

FORMAT: 1A
 
# Test API
 
## Items [/items{?filter}]
 
### List all Items [GET]

+ Parameters 
 
    + filter (optional, boolean) ... A filter on items
 
+ Response 200 (application/json)
 
        [{"id":1, "name":"item1"},{"id":2, "name":"item2"}]
 
### Create a New Item [POST]
 
+ Request 
 
        {"name":"item3"}
 
+ Response 201
 
        {"status":"created", "id":3}

This will work in upcoming documentation redesign – see http://docs.actionspecificparams.apiary.io

Note it is still shown in the URI but parameter is discussed only in the for the List action. We might eventually remove it from the respective URI (in the rendered documentation) as well.

You can try it for yourself appending ?3ColumnDocumentation=1 to your docs URL (e.g. `http://docs.actionspecificparams.apiary.io/?3ColumnDocumentation=1>

Please contact Apiary.io support over Intercom should you have a further question.