Sha256: ddc7da6cd88dc8aa939ab760f26ffb66318b45e126e6ab3735283eff64afa219

Contents?: true

Size: 1 KB

Versions: 34

Compression:

Stored size: 1 KB

Contents

FORMAT: 1A

# Apiary Client Test - DON'T CHANGE DOCUMENT!

This document is used for testing apiary-client

# Group Notes
Notes related resources of the **Notes API**

## Notes Collection [/notes
### List all Notes [GET]
+ Response 200 (application/json)

        [{
          "id": 1, "title": "Jogging in park"
        }, {
          "id": 2, "title": "Pick-up posters from post-office"
        }]

### Create a Note [POST

+ Request

sflmvs;mv;dsm{ "title": "Buy cheese and bread for breakfast." }

+ Response 201 (application/json)

        { "id": 3, "title": "Buy cheese and bread for breakfast." }

## Note [/notes/{id}]
A single Note object with all its details

+ Parameters
    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.

### Retrieve a Note [GET]
+ Response 200 (application/json)

    + Header

            X-My-Header: The Value

    + Body

            { "id": 2, "title": "Pick-up posters from post-office" }

### Remove a Note [DELETE]
+ Response 204

Version data entries

34 entries across 34 versions & 1 rubygems

Version Path
apiaryio-0.6.0 spec/fixtures/apiary_with_bom.apib
apiaryio-0.5.2 spec/fixtures/apiary_with_bom.apib
apiaryio-0.5.1 spec/fixtures/apiary_with_bom.apib
apiaryio-0.5.0 spec/fixtures/apiary_with_bom.apib
apiaryio-0.4.2 spec/fixtures/apiary_with_bom.apib
apiaryio-0.4.1 spec/fixtures/apiary_with_bom.apib
apiaryio-0.4.0-x86_64-darwin-13 spec/fixtures/apiary_with_bom.apib
apiaryio-0.3.5 features/fixtures/apiary_with_bom.apib
apiaryio-0.3.4 features/fixtures/apiary_with_bom.apib
apiaryio-0.3.3 features/fixtures/apiary_with_bom.apib
apiaryio-0.3.2 features/fixtures/apiary_with_bom.apib
apiaryio-0.3.1 features/fixtures/apiary_with_bom.apib
apiaryio-0.3.0 features/fixtures/apiary_with_bom.apib
apiaryio-0.2.5 features/fixtures/apiary_with_bom.apib