-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Transferring blueprint from apiary.io
- Loading branch information
Showing
1 changed file
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
FORMAT: 1A | ||
HOST: http://www.google.com | ||
|
||
# marmir | ||
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 |