Example API documentation version 1
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);
More content here. Including bold text!
This is the top level description for /account.
Creates a new account. Some bold text here. More text. Need to fill the line, so make it longer still. Hooray! Line two
The very top resource - displays OK
This is the top level description for /conversations.
Get a list of conversation for the current user
Create a new conversions. The currently logged in user doesn't need to be supplied in the members list, it's implied.
Get a single conversation including its messages
Update a conversation (change members)
Get the messages for the conversation
Add a new message to a conversation
Get the details of a group, including the member list
Update the group, optionally supplying the new list of members (overwrites current list)
Removes the group