Skip to content

Commit

Permalink
Transferring blueprint from apiary.io
Browse files Browse the repository at this point in the history
  • Loading branch information
sotrachhun committed Aug 1, 2014
1 parent 21f24fe commit 489fa31
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions apiary.apib
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
FORMAT: 1A
HOST: http://www.google.com

# Yoolk REST API
Notes API is a *short texts saving* service similar to its physical paper presence on your table.

# 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 (application/json)

{ "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

0 comments on commit 489fa31

Please sign in to comment.