Skip to content

Commit

Permalink
Example blueprint updates for testing
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgtaylor committed Oct 29, 2015
1 parent 567510d commit 1166312
Showing 1 changed file with 52 additions and 4 deletions.
56 changes: 52 additions & 4 deletions example.apib
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,33 @@ Get a list of notes.
+ Attributes (NoteList)

### Create New Note [POST]
Create a new note
Create a new note using a title and an optional content body.

+ Request (application/json)
+ Request with body (application/json)

+ Body

{
"title": "My new note",
"body": "..."
"body": "This is the body"
}

+ Response 201

+ Response 400 (application/json)

+ Body

{
"error": "Invalid title"
}

+ Request without body (application/json)

+ Body

{
"title": "My new note"
}

+ Response 201
Expand Down Expand Up @@ -178,6 +196,36 @@ If the value for `title` or `body` is `null` or `undefined`, then the correspond
"error": "Note not found"
}

+ Request delete body (application/json)

+ Body

{
"body": ""
}

+ Response 200 (application/json)

+ Headers

X-Request-ID: f72fc914
X-Response-Time: 4ms

+ Attributes (NoteData)

+ Response 404 (application/json)

+ Headers

X-Request-ID: f72fc914
X-Response-Time: 4ms

+ Body

{
"error": "Note not found"
}

### Delete a Note [DELETE]
Delete a single note

Expand Down Expand Up @@ -264,7 +312,7 @@ Get a list of bars
Get a single tag

+ Parameters
+ id
+ id - Unique tag identifier

### GET

Expand Down

0 comments on commit 1166312

Please sign in to comment.