{{ define "aglio"}} Back to top
Markdown formatted description.
Also Markdown formatted. This also includes automatic “smartypants” formatting – hooray!
“A quote from another time and place”
Another paragraph. Code sample:
Authorization: bearer 5262d64b892e8d4341000001
And some code with no highlighting:
Foo bar baz
Group description (also with Markdown)
Note list description
Even
More
Markdown
Get a list of notes.
200
ShowHideContent-Type: application/json
X-Request-ID: f72fc914
X-Response-Time: 4ms
[
{
"id": 1,
"title": "Grocery list",
"body": "Buy milk"
},
{
"id": 2,
"title": "TODO",
"body": "Fix garage door"
}
]
Create a new note
Note description
Get a single note.
string
(required) Example: 68a5sdf67The note ID
Update a single note
string
(required) Example: 68a5sdf67The note ID
Content-Type: application/json
{
"title": "Grocery List (Safeway)"
}
200
ShowHideContent-Type: application/json
X-Request-ID: f72fc914
X-Response-Time: 4ms
{
"id": 1,
"title": "Grocery list",
"body": "Buy milk"
}
404
ShowHideContent-Type: application/json
X-Request-ID: f72fc914
X-Response-Time: 4ms
{
"error": "Note not found"
}
Delete a single note
string
(required) Example: 68a5sdf67The note ID
204
404
ShowHideContent-Type: application/json
X-Request-ID: f72fc914
X-Response-Time: 4ms
{
"error": "Note not found"
}
Group description
A list of users
Get a list of users. Example:
https://api.mywebsite.com/users?sort=joined&limit=5
string
(optional) Example: aliceSearch for a user by name
string
(optional) Example: 2011-01-01Search by join date
string
(optional) Example: 2011-01-01Search by join date
string
(optional) Default: name Example: joinedWhich field to sort by
Choices: name
joined
-joined
age
-age
location
-location
plan
-plan
integer
(optional) Default: 10 Example: 25The maximum number of users to return, up to 50
200
ShowHideContent-Type: application/json
[
{
"name": "alice",
"image": "http://foo.com/alice.jpg",
"joined": "2013-11-01"
},
{
"name": "bob",
"image": "http://foo.com/bob.jpg",
"joined": "2013-11-02"
}
]
Generated by aglio on 19 Feb 2015
{{ end }}