{{ define "aglio"}}  Back to top

Markdown formatted description.

Subtitle

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

Notes 

Group description (also with Markdown)

Note List 

Note list description

  • Even

  • More

  • Markdown

Get Notes
/notes

Get a list of notes.

  • Response  200
  • Headers
    Content-Type: application/json
    X-Request-ID: f72fc914
    X-Response-Time: 4ms
    Body
    [
        {
            "id": 1,
            "title": "Grocery list",
            "body": "Buy milk"
        },
        {
            "id": 2,
            "title": "TODO",
            "body": "Fix garage door"
        }
    ]
    
Create New Note
/notes

Create a new note

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "title": "My new note",
        "body": "..."
    }
    
  • Response  201
  • Response  400
  • Headers
    Content-Type: application/json
    Body
    {
        "error": "Invalid title"
    }
    

Note 

Note description

Get Note
/notes/{id}

Get a single note.

  • Parameters
  • id
    string (required) Example: 68a5sdf67

    The note ID

  • Response  200
  • Headers
    Content-Type: application/json
    X-Request-ID: f72fc914
    X-Response-Time: 4ms
    Body
    {
        "id": 1,
        "title": "Grocery list",
        "body": "Buy milk"
    }
    
  • Response  404
  • Headers
    Content-Type: application/json
    X-Request-ID: f72fc914
    X-Response-Time: 4ms
    Body
    {
        "error": "Note not found"
    }
    
Update a Note
/notes/{id}

Update a single note

  • Parameters
  • id
    string (required) Example: 68a5sdf67

    The note ID

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "title": "Grocery List (Safeway)"
    }
    
  • Response  200
  • Headers
    Content-Type: application/json
    X-Request-ID: f72fc914
    X-Response-Time: 4ms
    Body
    {
        "id": 1,
        "title": "Grocery list",
        "body": "Buy milk"
    }
    
  • Response  404
  • Headers
    Content-Type: application/json
    X-Request-ID: f72fc914
    X-Response-Time: 4ms
    Body
    {
        "error": "Note not found"
    }
    
Delete a Note
/notes/{id}

Delete a single note

  • Parameters
  • id
    string (required) Example: 68a5sdf67

    The note ID

  • Response  204
  • Response  404
  • Headers
    Content-Type: application/json
    X-Request-ID: f72fc914
    X-Response-Time: 4ms
    Body
    {
        "error": "Note not found"
    }
    

Users 

Group description

User List 

A list of users

Get users
/users{?name,joinedBefore,joinedAfter,sort,limit}

Get a list of users. Example:

https://api.mywebsite.com/users?sort=joined&limit=5
  • Parameters
  • name
    string (optional) Example: alice

    Search for a user by name

    joinedBefore
    string (optional) Example: 2011-01-01

    Search by join date

    joinedAfter
    string (optional) Example: 2011-01-01

    Search by join date

    sort
    string (optional) Default: name Example: joined

    Which field to sort by

    Choices: name joined -joined age -age location -location plan -plan

    limit
    integer (optional) Default: 10 Example: 25

    The maximum number of users to return, up to 50

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    [
        {
            "name": "alice",
            "image": "http://foo.com/alice.jpg",
            "joined": "2013-11-01"
        },
        {
            "name": "bob",
            "image": "http://foo.com/bob.jpg",
            "joined": "2013-11-02"
        }
    ]
    

Tags and Tagging Long Title 

Get or set tags on notes

Resources 

/tags

Get a list of bars

  • Response  200

Get one tag 

Get a single tag

/tags/{id}
  • Response  200

Generated by aglio on 19 Feb 2015

{{ end }}