old_contents:
FORMAT: 1A
HOST: https://neighbor.ly/api/

# Neighbor.ly
Here you will find how to integrate an application with Neighbor.ly. Check our [Dashboard source code](https://github.com/neighborly/neighborly-dashboard) for a real use case.

# Sessions
Your first stop when integrating with Neighborly. For a lot of endpoints, you are expected to provide an `access_token`, managed by this section.

## Sessions [/sessions]
### Create a session [POST]

+ Request

        { "email": "mr.nobody@example.com", "password": "your-really-strong-password" }

    + Header

            Accept: application/vnd.api+json;revision=1

+ Response 201 (application/json)

        { "access_token": "Ndf6kxgLfr_KMhAg8wMpm7Yit2cvHkv9oI8qIXWiHmZdeqI1h0cmn8p4wCEhoZS-AQY", "user_id": 1 }

+ Response 400 (application/json)
        {}

+ Response 401 (application/json)
        {}

new_contents:
FORMAT: 1A
HOST: https://neighbor.ly/api/

# Neighbor.ly
Here you will find how to integrate an application with Neighbor.ly. Check our [Dashboard source code](https://github.com/neighborly/neighborly-dashboard) for a real use case.

# Sessions
Your first stop when integrating with Neighborly. For a lot of endpoints, you are expected to provide an `access_token`, managed by this section.

## Sessions [/sessions]
### Create a session [POST]

+ Request

    + Header

            Accept: application/vnd.api+json;revision=1

    + Body

            { "email": "mr.nobody@example.com", "password": "your-really-strong-password" }

+ Response 201 (application/json)

        { "access_token": "Ndf6kxgLfr_KMhAg8wMpm7Yit2cvHkv9oI8qIXWiHmZdeqI1h0cmn8p4wCEhoZS-AQY", "user_id": 1 }

+ Response 400 (application/json)

        {}

+ Response 401 (application/json)

        {}

message: [DOC] Add body section to create a new session

license: mit

repos: FromUte/dune-api


old_contents:
# Lion API

Lion is a basic localization service using `git` as the backend for storing translations.

## Request headers

All requests to Lion must include the following headers:

- `Lion-Api-Version`

# Group Projects

## Project collection [/projects]

### List projects [GET]

List all configured projects

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "projects": [
                    "projectA": {
                        "name" "projectA" // All project details
                    }
                ]
              }

## Project management [/project/{name}]

+ Parameters

    + name (required, string) ... Project name

### Get project [GET]

Fetch project details, given the projects' name.

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "name": "Project name",
                "resources": [
                  "resource1",
                  "..."
                ]
              }

+ Response 404 (application/json)

    + Header

              Lion-Api-Version: v1

new_contents:
# Lion API

Lion is a basic localization service using `git` as the backend for storing translations.

## Request headers

Requests should have the `Lion-Api-Version` header set. The current API version is `v1`. If the header is not set, it is assumed to be the latest version.

Example header:

- `Lion-Api-Version: v1`

# Group Projects

## Project collection [/projects]

### List projects [GET]

List all configured projects

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "projects": [
                    "projectA": {
                        "name" "projectA" // All project details
                    }
                ]
              }

## Project management [/project/{name}]

+ Parameters

    + name (required, string) ... Project name

### Get project [GET]

Fetch project details, given the projects' name.

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "name": "Project name",
                "resources": [
                  "resource1",
                  "..."
                ]
              }

+ Response 404 (application/json)

    + Header

              Lion-Api-Version: v1

subject: Make the API version optional in the request

repos: sebdah/lion


old_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt"
            }

new_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt",
                "body": "
Watch out for companies that aren't charities

Look out for companies with misleading names that sound like debt charities but are actually commercial businesses.

Never ever pay for services from this type of company.
"
            }

subject: Add article body to API Blueprint

message: Add article body to API Blueprint


old_contents:
FORMAT: 1A
HOST: https://orgmanager.miguelpiedrafita.com/api

# Orgmanager API

The Orgmanager API allows you to integrate Orgmanager with other applications and projects.

## Questions Collection [/questions]

### List All Questions [GET]

+ Response 200 (application/json)

        [
            {
                "question": "Favourite programming language?",
                "published_at": "2015-08-05T08:40:51.620Z",
                "choices": [
                    {
                        "choice": "Swift",
                        "votes": 2048
                    }, {
                        "choice": "Python",
                        "votes": 1024
                    }, {
                        "choice": "Objective-C",
                        "votes": 512
                    }, {
                        "choice": "Ruby",
                        "votes": 256
                    }
                ]
            }
        ]

### Create a New Question [POST]

You may create your own question using this action. It takes a JSON
object containing a question and a collection of answers in the
form of choices.

+ Request (application/json)

        {
            "question": "Favourite programming language?",
            "choices": [
                "Swift",
                "Python",
                "Objective-C",
                "Ruby"
            ]
        }

+ Response 201 (application/json)

    + Headers

            Location: /questions/2

    + Body

            {
                "question": "Favourite programming language?",
                "published_at": "2015-08-05T08:40:51.620Z",
                "choices": [
                    {
                        "choice": "Swift",
                        "votes": 0
                    }, {
                        "choice": "Python",
                        "votes": 0
                    }, {
                        "choice": "Objective-C",
                        "votes": 0
                    }, {
                        "choice": "Ruby",
                        "votes": 0
                    }
                ]
            }

new_contents:
FORMAT: 1A
HOST: https://orgmanager.miguelpiedrafita.com/api

# Orgmanager API

The Orgmanager API allows you to integrate Orgmanager with other applications and projects.

## User Data [/user]

### Get user info [GET]

+ Response 200 (application/json)

        {
            "id":1,
            "name":"Miguel Piedrafita",
            "email":"soy@miguelpiedrafita.com",
            "github_username":"m1guelpf",
            "created_at":"2017-01-25 18:44:32",
            "updated_at":"2017-02-16 19:40:50"
        }

## User Organizations [/user/orgs]

### Get user organizations [GET]

+ Response 200 (application/json)

        {
            "id":1,
            "name":"Test Organization",
            "url":"https:\/\/api.github.com\/orgs\/test-org",
            "description":null,
            "avatar":"https:\/\/miguelpiedrafita.com\/logo.png",
            "invitecount":100
        }

message: :memo: Add /user and /user/orgs api endpoints to api docs


old_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt",
                "body": "
Watch out for companies that aren't charities

Look out for companies with misleading names that sound like debt charities but are actually commercial businesses.

Never ever pay for services from this type of company.
"
            }

new_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/{locale}/articles/{id}]
A single Article object with all its details

+ Parameters
    + locale = `en` (optional, string, `cy`) ... Locale of the Article.
    + id (required, string, `foo-bar`) ... ID of the Article.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt",
                "body": "
Watch out for companies that aren't charities

Look out for companies with misleading names that sound like debt charities but are actually commercial businesses.

Never ever pay for services from this type of company.
"
            }

subject: Add locale to API Blueprint

message: Add locale to API Blueprint


old_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "id": "where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt"
            }

new_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt"
            }

subject: Add URLs to API Blueprint

message: Add URLs to API Blueprint


old_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/{locale}/articles/{id}]
A single Article object with all its details

+ Parameters
    + locale = `en` (optional, string, `cy`) ... Locale of the Article.
    + id (required, string, `where-to-go-to-get-free-debt-advice`) ... ID of the Article.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt",
                "body": "
Watch out for companies that aren't charities

Look out for companies with misleading names that sound like debt charities but are actually commercial businesses.

Never ever pay for services from this type of company.
"
            }

new_contents:
FORMAT: 1A
HOST: https://www.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/{locale}/articles/{id}]
A single Article object with all its details

+ Parameters
    + locale = `en` (optional, string, `en`) ... Locale of the Article.
    + id (required, string, `where-to-go-to-get-free-debt-advice`) ... ID of the Article.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "url": "https://www.moneyadviceservice.org.uk/en/articles/where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt",
                "body": "
Watch out for companies that aren't charities

Look out for companies with misleading names that sound like debt charities but are actually commercial businesses.

Never ever pay for services from this type of company.
"
            }

subject: Fix locale example for API Blueprint

message: Fix locale example for API Blueprint


old_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service's API.

# Group Articles
Article related resources of the **Money Advice Service**

## Articles Collection [/articles]
### List all Articles [GET]
+ Response 200 (application/json)

        [{
          "id": 1, "content": "Jogging in park"
        }, {
          "id": 2, "content": "Pick-up posters from post-office"
        }]

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + slug (required, string, `the-article`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            X-My-Header: The Value

    + Body

            { "slug": "the-article", "title": "Pick-up posters from post-office", content: "
La de da
" }

new_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            X-My-Header: The Value

    + Body

            { "id": "where-to-go-to-get-free-debt-advice", "title": "Where to go to get free debt advice" }

subject: Remove articles collection from API blueprint


old_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            X-My-Header: The Value

    + Body

            { "id": "where-to-go-to-get-free-debt-advice", "title": "Where to go to get free debt advice" }

new_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            { "id": "where-to-go-to-get-free-debt-advice", "title": "Where to go to get free debt advice" }

subject: Add link header to API Blueprint

message: Add link header to API Blueprint


old_contents:
# Lion API

Lion is a basic localization service using `git` as the backend for storing translations.

## Request headers

Requests should have the `Lion-Api-Version` header set. The current API version is `v1`. If the header is not set, it is assumed to be the latest version.

Example header:

- `Lion-Api-Version: v1`

# Group Projects

## Project collection [/projects]

### List projects [GET]

List all configured projects

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "projects": [
                    "projectA": {
                        "name" "projectA" // All project details
                    }
                ]
              }

## Project management [/project/{name}]

+ Parameters

    + name (required, string) ... Project name

### Get project [GET]

Fetch project details, given the projects' name.

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "name": "Project name",
                "resources": [
                  "resource1",
                  "..."
                ]
              }

+ Response 404 (application/json)

    + Header

              Lion-Api-Version: v1

new_contents:
# Lion API

Lion is a basic localization service using `git` as the backend for storing translations.

## Request headers

Requests should have the `Lion-Api-Version` header set. The current API version is `v1`. If the header is not set, it is assumed to be the latest version.

Example header:

- `Lion-Api-Version: v1`

# Group Projects

## Project collection [/projects]

### List projects [GET]

List all configured projects

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "projects": [
                    "projectA": {
                        "name" "projectA" // All project details
                        ...
                    }
                ]
              }

## Project management [/project/{slug}]

+ Parameters

    + slug (required, string) ... Project slug

### Get project [GET]

Fetch project details, given the projects' name.

+ Request (application/json)

    + Header

              Lion-Api-Version: v1

+ Response 200 (application/json)

    + Header

              Lion-Api-Version: v1

    + Body

              {
                "name": "Project name",
                "slug": "project-name",
                "resources": [
                  "resource1",
                  "..."
                ]
              }

+ Response 404 (application/json)

    + Header

              Lion-Api-Version: v1

subject: Substitute name with slug for fetching projects


old_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            { "id": "where-to-go-to-get-free-debt-advice", "title": "Where to go to get free debt advice" }

new_contents:
FORMAT: 1A
HOST: https://api.moneyadviceservice.org.uk

# Money Advice Service
API for the Money Advice Service.

# Articles
Article related resources of the **Money Advice Service**.

## Article [/articles/{id}]
A single Article object with all its details

+ Parameters
    + id (required, string, `foo-bar`) ... String `id` of the Article to perform action with. Has example value.

### Retrieve a Article [GET]
+ Response 200 (application/json)

    + Header

            Link: <https://www.moneyadviceservice.org.uk/cy/articles/ble-i-gael-cyngor-am-ddim-ynghylch-dyled>; rel="alternate"; hreflang="cy"; title="Ble i gael cyngor am ddim ynghylch dyled"

    + Body

            {
                "id": "where-to-go-to-get-free-debt-advice",
                "title": "Where to go to get free debt advice",
                "description": "Find out where you can get free, confidential help if you are struggling with debt"
            }

subject: Add article description to API Blueprint


old_contents:
FORMAT: 1A
HOST: https://awesome-bucketlist-api.herokuapp.com/

# awesome-bucketlist

Polls is a simple API allowing consumers to view polls and vote in them.

## Bucketlists [/bucketlists]

### Create New Bucketlist [POST]
Creates a new bucketlist under your account.

+ Request (application/json)

    + Headers

            Authorization: "Your Token"

+ Response 201 (application/json)

        [
            {
                "name": "Dare Devil",
                "description": "Stunts I want to try out."

            }
        ]

### Get All Bucketlists [GET]

You may create your own question using this action. It takes a JSON
object containing a question and a collection of answers in the
form of choices.

+ Request (application/json)

    + Headers

            Authorization: "Your Token"

+ Response 200 (application/json)

    + Body

            [
                {
                    "name": "Dare Devil",
                    "description": "Stunts I want to try out."
                }
            ]

new_contents:
FORMAT: 1A
HOST: https://awesome-bucketlist-api.herokuapp.com/

# awesome-bucketlist

A Bucketlist is a list of items, activities or goals you want to achieve before you "kick the bucket"
this is an API to allow you create a new user account, login into your account, create, update, view or delete
bucketlists and bucketlist items.e

## Bucketlists [/bucketlists]

### Create New Bucketlist [POST]
Creates a new bucketlist under your account.

+ Request (application/json)

    + Headers

            Authorization: "Your Token"

+ Response 201 (application/json)

        [
            {
                "name": "Dare Devil",
                "description": "Stunts I want to try out."

            }
        ]

### Get All Bucketlists [GET]

You may create your own question using this action. It takes a JSON
object containing a question and a collection of answers in the
form of choices.

+ Request (application/json)

    + Headers

            Authorization: "Your Token"

+ Response 200 (application/json)

    + Body

            [
                {
                    "name": "Dare Devil",
                    "description": "Stunts I want to try out."
                }
            ]

message: [CHORE] Update Introduction description for Apiary

repos: brayoh/bucket-list-api


old_contents:
<!-- include(models.apib) -->

# Group Rescues

<!-- include(rescues/list.apib) -->

<!-- include(rescues/create.apib) -->

<!-- include(rescues/retrieve.apib) -->

<!-- include(rescues/update.apib) -->

new_contents:
# Group Rescues

<!-- include(rescues/list.apib) -->

<!-- include(rescues/create.apib) -->

<!-- include(rescues/retrieve.apib) -->

<!-- include(rescues/search.apib) -->

<!-- include(rescues/update.apib) -->

subject: Add missing rescue search documentation

message: Add missing rescue search documentation


message: Add article description to API Blueprint


old_contents:
FORMAT: 1A

# Machines API

# Group Machines

# Machines collection [/machines/{id}]
  + Parameters
    - id (number, `1`)

## Get Machines [GET]

- Request (application/json)
  + Parameters
    - id (number, `2`)

- Response 200 (application/json; charset=utf-8)

    [
      {
        "type": "bulldozer",
        "name": "willy"
      }
    ]

- Request (application/json)
  + Parameters
    - id (number, `3`)

- Response 200 (application/json; charset=utf-8)

    [
      {
        "type": "bulldozer",
        "name": "willy"
      }
    ]

new_contents:
FORMAT: 1A

# Machines API

# Group Machines

# Machines collection [/machines/{id}]
    + Parameters
        + id (number, `1`)

## Get Machines [GET]

+ Request (application/json)
    + Parameters
        + id (number, `2`)

+ Response 200 (application/json; charset=utf-8)

        [
          {
            "type": "bulldozer",
            "name": "willy"
          }
        ]

+ Request (application/json)
    + Parameters
        + id (number, `3`)

+ Response 200 (application/json; charset=utf-8)

        [
          {
            "type": "bulldozer",
            "name": "willy"
          }
        ]

subject: Use 4 spaces as indentation

message: style: Use 4 spaces as indentation


old_contents:
FORMAT: 1A

# Organising, Swiftly
_Organising_ is an outliner/todo list with strong search functionality.

## Node Collection [/nodes]

### Root node and all children [GET]
Returns the root node, with all of its children.

+ Response 200 (application/json)

    {
        "ID": 0,
        "text": "Update repo",
        "completed": false,
        "children": [
            {
                "ID": 1,
                "text": "Commit changes",
                "completed": true
            }, {
                "ID": 2,
                "text": "Push to origin",
                "completed": false
            }
        ]
    }

subject: Correct API definition semantic issues.

message: Correct API definition semantic issues.


new_contents:
FORMAT: 1A
HOST: https://awesome-bucketlist-api.herokuapp.com/

# awesome-bucketlist

Polls is a simple API allowing consumers to view polls and vote in them.

## Bucketlists [/bucketlists]

### Create New Bucketlist [POST]
Creates a new bucketlist under your account.

+ Request (application/json)

    + Headers

            Authorization: "Your Token"

+ Response 201 (application/json)

        [
            {
                "name": "Dare Devil",
                "description": "Stunts I want to try out."

            }
        ]

### Get All Bucketlists [GET]

You may create your own question using this action. It takes a JSON
object containing a question and a collection of answers in the
form of choices.

+ Request (application/json)

    + Headers

            Authorization: "Your Token"

+ Response 200 (application/json)

    + Body

            [
                {
                    "name": "Dare Devil",
                    "description": "Stunts I want to try out."
                }
            ]

subject: Add Apiary Documentation for the API

message: Add Apiary Documentation for the API


new_contents:
FORMAT: 1A

# Admiral

Admiral is a deployment management system for Fleet and CoreOS. Unlike other deployment systems, Admiral also allows for automatic deployment and scaling of Fleet units.

# Admiral Root [/v1]

This resource simply represents the root of the Admiral API. It provides a basic JSON response as validation that the API server is running.

## Retrieve the API Information [GET]

+ Response 200 (application/json)

        {
            "name": "Admiral API",
            "version": 1
        }

## Group Authentication

Resources related to authenticating users.

## Login [/v1/login]

### Login [POST]

Authenticates a user and returns a token that the client should use for further interactions with the API server.

Requests should be made with a JSON object containing the following items:

+ Request (application/json)

                {
                    "username": "johndoe",
                    "password": "password"
                }

+ Response 200 (application/json)

                {
                    "token": "API token"
                }

+ Response 401 (application/json)

                {
                    "error": 401,
                    "message": "The specified user was invalid."
                }

## Registration [/v1/register]

### Register [POST]

Registers a user with the specified information, and returns a new token if the registration was successful. Registration must be enabled on the server or this endpoint will return an error.

+ Request (application/json)

                {
                    "username": "johndoe",
                    "password": "password"
                }

+ Response 200 (application/json)

                {
                    "token": "API token"
                }

+ Response 500 (application/json)

                {
                    "error": 500,
                    "message": "The server is not accepting registration."
                }

subject: Add login and registration to blueprint

message: Add login and registration to blueprint

repos: andrewmunsell/admiral