Example API documentation version 1

http://example.com/1

Welcome

Welcome to the Example Documentation. The Example API allows you to do stuff. See also example.com.

var raml2html = require('raml2html');

// Using the default templates:
// source can either be a filename, file contents (string) or parsed RAML object
raml2html.parse(source, onSuccess, onError);

// Using your own templates:
// - config should be an object with at least an `template` property
// - config can also include `helpers` and `partials`
// - the config object will be accessible from your handlebars templates
raml2html.parseWithConfig(source, config, onSuccess, onError);

Chapter two

More content here. Including bold text!

ACCOUNTS

This is the top level description for /account.

  • One
  • Two
  • Three

post

post

Creates a new account. Some bold text here. More text. Need to fill the line, so make it longer still. Hooray! Line two

Paragraph two

Creates a new account. Some bold text here. More text. Need to fill the line, so make it longer still. Hooray! Line two

Paragraph two

Body

Type: application/json

Example:

{
  "email": "john@example.com",
  "password": "super_secret",
  "name": "John Doe"
}

HTTP status code 200

Account was created and user is now logged in

get

get

find an account

find an account

Query Parameters

  • name: required (string)

    name on account

    Example:

    Naruto Uzumaki
  • gender: required (one of male,female)
  • number: (integer - default: 42)

get put delete

get
put

Update the account

delete

Delete the account

URI Parameters

  • id: required (string)

    account identifier

Headers

  • Authorization: (string)

    Basic authentication header

    Example:

    Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Update the account

URI Parameters

  • id: required (string)

    account identifier

Body

Type: application/x-www-form-urlencoded

Form Parameters
  • name: (string)

    name on account

    Example:

    Naruto Uzumaki
  • gender: (one of male,female)

Delete the account

URI Parameters

  • id: required (string)

    account identifier

post

post

Login with email and password

Login with email and password

Body

Type: application/json

Example:

{
  "email": "john@example.com",
  "password": "super_secret"
}

HTTP status code 200

Login was correct

Body

Type: text/xml

Example:

<test>This is a test</test>

HTTP status code 400

Login was incorrect, please try again

HTTP status code 401

Not authorized

Headers

  • WWW-Authenticate: (string)

    user was not authorized

    Example:

    WWW-Authenticate: Basic realm="raml2html"

post

post

Sends an email to the user with a link to set a new password

Sends an email to the user with a link to set a new password

Body

Type: application/json

Example:

{
  "email": "john@example.com"
}

get delete

get

Gets the sessions

delete

Deletes the session, logging out the user

Gets the sessions

    Deletes the session, logging out the user

      Forecasts

      The very top resource - displays OK

      get

      Overview endpoint to assemble and access forecast data in various timely resolutions - THIS IS NOT DISPLAYED ANYWHERE WITH RAML2HTML :/

      get

      Provides an overview of the available data - display OK

      Provides an overview of the available data - display OK

      URI Parameters

      • geoposition: required (string)

        A geoposition aquired by calling /geoposition/search - displays OK

      No methods here, but it does have a description

      /conversations

      This is the top level description for /conversations.

      get post

      get

      Get a list of conversation for the current user

      post

      Create a new conversions. The currently logged in user doesn't need to be supplied in the members list, it's implied.

      Get a list of conversation for the current user

      Secured by oauth_1_0

        Create a new conversions. The currently logged in user doesn't need to be supplied in the members list, it's implied.

        Secured by oauth_1_0

        Body

        Type: application/json

        Example:

        {
  "content": "My message!",
  "members": [1, 2, 3]
}

        HTTP status code 200

        A conversation with these members already existed, the message was added to that one

        HTTP status code 201

        The conversation was created and the message added to it

        get put

        get

        Get a single conversation including its messages

        put

        Update a conversation (change members)

        Get a single conversation including its messages

        URI Parameters

        • convId: required (string)

        Update a conversation (change members)

        URI Parameters

        • convId: required (string)

        get post

        get

        Get the messages for the conversation

        post

        Add a new message to a conversation

        Get the messages for the conversation

        URI Parameters

        • convId: required (string)

        Query Parameters

        • page_size: (number - default: 20)

          The number of items per page

        • page: (number)

          The page to return

        Add a new message to a conversation

        URI Parameters

        • convId: required (string)

        put delete

        put

        Update the message

        delete

        Delete the message

        Update the message

        URI Parameters

        • convId: required (string)
        • messageId: required (string)

        Delete the message

        URI Parameters

        • convId: required (string)
        • messageId: required (string)

        /users

        get post

        get

        Get a list of all users

        post

        Creates a new user

        Get a list of all users

        Query Parameters

        • page_size: (number - default: 20)

          The number of items per page

        • page: (number)

          The page to return

        • from: (string)

          Limit results to those created after from.

          Example:

          2014-12-31T00:00:00.000Z

        Creates a new user

        Body

        Type: application/json

        Example:

        {
  "email": "john@example.com",
  "name": "John Doe",
}

        get put delete

        get

        Get the details of a user including a list of groups he belongs to

        put

        Update a user

        delete

        Deletes a user

        Get the details of a user including a list of groups he belongs to

        URI Parameters

        • userId: required (string)

        Update a user

        URI Parameters

        • userId: required (string)

        Deletes a user

        URI Parameters

        • userId: required (string)

        /groups

        get post

        get

        Get a list of all the groups

        post

        Create a new group

        Get a list of all the groups

          Create a new group

          Body

          Type: application/json

          Example:

          {
  "name": "Cool people",
  "members": [1, 2, 3]
}

          get put delete

          get

          Get the details of a group, including the member list

          put

          Update the group, optionally supplying the new list of members (overwrites current list)

          delete

          Removes the group

          Get the details of a group, including the member list

          URI Parameters

          • groupId: required (string)

          Update the group, optionally supplying the new list of members (overwrites current list)

          URI Parameters

          • groupId: required (string)

          Body

          Type: application/json

          Example:

          {
  "name": "Cool people",
  "members": [1, 2, 3]
}

          Removes the group

          URI Parameters

          • groupId: required (string)

          post

          post

          Adds a user to a group

          Adds a user to a group

          URI Parameters

          • groupId: required (string)

          Body

          Type: application/json

          Example:

          {
  "user_id": 4,
}

          delete

          delete

          Removes a user from a group

          Removes a user from a group

          URI Parameters

          • groupId: required (string)
          • userId: required (string)