endpoint descriptions

Author: Aurélien Malisart

kittens.md

@@ -0,0 +1,121 @@
+# Kittens
+
+## Get All Kittens
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+api.kittens.get
+```
+
+```python
+import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.get()
+```
+
+```shell
+curl "http://example.com/api/kittens"
+  -H "Authorization: meowmeowmeow"
+```
+
+```javascript
+const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let kittens = api.kittens.get();
+```
+
+> The above command returns JSON structured like this:
+
+```json
+[
+  {
+    "id": 1,
+    "name": "Fluffums",
+    "breed": "calico",
+    "fluffiness": 6,
+    "cuteness": 7
+  },
+  {
+    "id": 2,
+    "name": "Max",
+    "breed": "unknown",
+    "fluffiness": 5,
+    "cuteness": 10
+  }
+]
+```
+
+This endpoint retrieves all kittens.
+
+### HTTP Request
+
+`GET http://example.com/api/kittens`
+
+### Query Parameters
+
+Parameter | Default | Description
+--------- | ------- | -----------
+include_cats | false | If set to true, the result will also include cats.
+available | true | If set to false, the result will include kittens that have already been adopted.
+
+<aside class="success">
+Remember — a happy kitten is an authenticated kitten!
+</aside>
+
+## Get a Specific Kitten
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+api.kittens.get(2)
+```
+
+```python
+import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.get(2)
+```
+
+```shell
+curl "http://example.com/api/kittens/2"
+  -H "Authorization: meowmeowmeow"
+```
+
+```javascript
+const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let max = api.kittens.get(2);
+```
+
+> The above command returns JSON structured like this:
+
+```json
+{
+  "id": 2,
+  "name": "Max",
+  "breed": "unknown",
+  "fluffiness": 5,
+  "cuteness": 10
+}
+```
+
+This endpoint retrieves a specific kitten.
+
+<aside class="warning">Inside HTML code blocks like this one, you can't use Markdown, so use <code>&lt;code&gt;</code> blocks to denote code.</aside>
+
+### HTTP Request
+
+`GET http://example.com/kittens/<ID>`
+
+### URL Parameters
+
+Parameter | Description
+--------- | -----------
+ID | The ID of the kitten to retrieve

source/includes/_authentication.md

@@ -0,0 +1,7 @@
+# Authentication
+
+A `api_key` parameter must be passed to all requests.
+
+Parameter | Default
+--------- | -------
+api_key   | null

source/includes/_contacts.md

@@ -0,0 +1,43 @@
+# Contacts
+
+## Get all contacts
+
+This endpoint retrieves all contacts.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts`
+
+page
+
+## Get a contact
+
+This endpoint retrieves a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:id`
+
+## Create a contact
+
+This endpoint creates a new contact.
+
+### HTTP Request
+
+`POST /api/labs/:lab_id/contacts`
+
+## Update a contact
+
+This endpoint updates an existing contact.
+
+### HTTP Request
+
+`PUT /api/labs/:lab_id/contacts/:id`
+
+## Delete a contact
+
+This endpoint deletes an existing contact.
+
+### HTTP Request
+
+`DELETE /api/labs/:lab_id/contacts/:id`

source/includes/_errors.md

@@ -0,0 +1,37 @@
+# Events
+
+## Get all events
+
+This endpoint retrieves all events.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/events`
+
+page
+
+## Get an event
+
+This endpoint retrieves a specific event.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/events/:id`
+
+## Get all events of a contact
+
+This endpoint retrieves all events of a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:contact_id/events`
+
+page
+
+## Get an event of a contact
+
+This endpoint retrieves a specific event of a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:contact_id/events/:id`

source/includes/_events.md

@@ -0,0 +1,30 @@
+# Labs
+
+## Get all labs
+
+This endpoint retrieves all labs.
+
+### HTTP Request
+
+`GET /api/labs`
+
+### Query Parameters
+
+Parameter | Default
+--------- | -------
+api_key   | null
+
+## Get one lab
+
+This endpoint retrieves a specific lab.
+
+### HTTP Request
+
+`GET /api/labs/:id`
+
+### Query Parameters
+
+Parameter | Default
+--------- | -------
+api_key   | null
+lab_id    | null

source/includes/_labs.md

@@ -0,0 +1,37 @@
+# Organizations
+
+## Get all organizations
+
+This endpoint retrieves all organizations.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/organizations`
+
+page
+
+## Get an organization
+
+This endpoint retrieves a specific organization.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/organizations/:id`
+
+## Get all organizations of a contact
+
+This endpoint retrieves all organizations of a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:contact_id/organizations`
+
+page
+
+## Get an organization of a contact
+
+This endpoint retrieves a specific organization of a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:contact_id/organizations/:id`

source/includes/_organizations.md

@@ -0,0 +1,41 @@
+# Permissions
+
+## Get all permissions of a user
+
+This endpoint retrieves all permissions of a user (for all his accessible labs).
+
+### HTTP Request
+
+`GET /api/users/:user_id/permissions`
+
+## Get permissions of a user on a lab
+
+This endpoint retrieves the permissions of a user on a lab.
+
+### HTTP Request
+
+`GET /api/users/:user_id/permissions/:lab_id`
+
+## Grant a user access to a lab
+
+This endpoint grants a user access to a lab.
+
+### HTTP Request
+
+`POST /api/users/:user_id/permissions/:lab_id`
+
+## Update permissions of a user on a lab
+
+This endpoint updates a user's permissions to a lab.
+
+### HTTP Request
+
+`PUT /api/users/:user_id/permissions/:lab_id`
+
+## Revoke access of a user to a lab
+
+This endpoint revokes a user's access to a lab.
+
+### HTTP Request
+
+`DELETE /api/users/:user_id/permissions/:lab_id`

source/includes/_permissions.md

@@ -0,0 +1,37 @@
+# Projects
+
+## Get all projects
+
+This endpoint retrieves all projects.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/projects`
+
+page
+
+## Get a project
+
+This endpoint retrieves a specific project.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/projects/:id`
+
+## Get all projects of a contact
+
+This endpoint retrieves all projects of a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:contact_id/projects`
+
+page
+
+## Get a project of a contact
+
+This endpoint retrieves a specific project of a specific contact.
+
+### HTTP Request
+
+`GET /api/labs/:lab_id/contacts/:contact_id/projects/:id`