From 37ad3b2d44dab862db7ad9212cf4918da2431d79 Mon Sep 17 00:00:00 2001 From: mordka Date: Mon, 31 Jul 2017 21:04:03 +0200 Subject: [PATCH] typo fix --- source/includes/_addons.md | 96 +++++++++++++++++++++++++++++++++++ source/includes/_company.md | 6 +-- source/includes/_device.md | 8 +-- source/includes/_library.md | 2 +- source/includes/_modelling.md | 8 +-- source/includes/_plans.md | 10 ++-- source/includes/_products.md | 10 ++-- source/includes/_user.md | 8 +-- 8 files changed, 122 insertions(+), 26 deletions(-) create mode 100644 source/includes/_addons.md diff --git a/source/includes/_addons.md b/source/includes/_addons.md new file mode 100644 index 00000000000..2c40a994576 --- /dev/null +++ b/source/includes/_addons.md @@ -0,0 +1,96 @@ +## Addons + +Represents Unleash hardware addons + +### Create a addon + +Creates new addon item + +#### API Endpoint + +`POST /addon` + + +#### Parameters + +Name | Type | Constraints | Description +--------|-------|--------- | ------ +`id` | string, uuid | (auto generated) | database hash id +`name` | string | required | addon name +`price` | string | required | addon price per month +`currency` | string | required | price currency in standard ISO 4217 - e.g. AUD +`description` | string | required | addon description, features available +`createdAt` | timestamp | (auto generated) | item created timestamp +`updatedAt` | timestamp | (auto generated) | item updated timestamp + + +### Get a addon + +Retrieve addon by ID + +#### API Endpoint + + `GET /addon/{id}` + +``` + GET /addon/{id} +``` + + +#### Parameters + +Name | Type | Constraints | Description +--------|-------|--------- | ------ +id | string | required, uuid format| id of the addon + + + +### List addons + +``` + GET /addon +``` +List all the addons +#### API Endpoint + + `GET /addon` + +### Update a addon + + +``` + PUT /addon/{id} +``` +Replace a given attribute with new value + + +#### API Endpoint + + ` PUT /addon/{id}` + +#### Parameters +Name | Type | Constraints | Description +--------|-------|--------- | ------ +attributeName | string | required| the name of the attribute +attributeValue | string | required| the value to assign + + +### Delete an addon + +Deletes the addon by id + +#### API Endpoint + + ` DELETE /addon/{id}` + +``` + DELETE /addon/{id} +``` + +#### Parameters + +Name | Type | Constraints | Description +--------|-------|--------- | ------ +id | string | required, uuid format| id of the addon + + diff --git a/source/includes/_company.md b/source/includes/_company.md index 97e2f0bb401..0f54950c61e 100644 --- a/source/includes/_company.md +++ b/source/includes/_company.md @@ -33,7 +33,7 @@ POST /company #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string, uuid | (auto generated) | database hash id owner | string | required, uuid format| The foreign key id of company owner @@ -80,7 +80,7 @@ Retrieve company by ID #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the company @@ -110,7 +110,7 @@ Replace a given attribute with new value ` PUT /company/{id}` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ attributeName | string | required| the name of the attribute attributeValue | string | required| the value to assign diff --git a/source/includes/_device.md b/source/includes/_device.md index a200f4edc55..0ff5768e6c5 100644 --- a/source/includes/_device.md +++ b/source/includes/_device.md @@ -14,7 +14,7 @@ Creates new device item #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string, uuid | (auto generated) | database hash id owner | string | required, uuid format| The foreign key id of device owner @@ -41,7 +41,7 @@ Retrieve device by ID #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the device @@ -71,7 +71,7 @@ Replace a given attribute with new value ` PUT /device/{id}` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ attributeName | string | required| the name of the attribute attributeValue | string | required| the value to assign @@ -91,7 +91,7 @@ Deletes the device by id #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the device diff --git a/source/includes/_library.md b/source/includes/_library.md index 7abaaccdc5e..9214f0468a6 100644 --- a/source/includes/_library.md +++ b/source/includes/_library.md @@ -37,7 +37,7 @@ In order to upload file to Unleash S3, call this endpoint to receive presigned P ` POST /library/upload` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ deviceId | string | required| the device id, which was used to capture the file sessionId | string | required| the session id the file belongs to diff --git a/source/includes/_modelling.md b/source/includes/_modelling.md index 2dd5c3a03ad..2a1f9f37a44 100644 --- a/source/includes/_modelling.md +++ b/source/includes/_modelling.md @@ -8,7 +8,7 @@ Call API for presigned post request and then upload it manually using PUT reques #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ `deviceId` | string | required| device id `sessionId` | number | required | session id @@ -36,7 +36,7 @@ POST https://94hx3w6zfh.execute-api.ap-southeast-2.amazonaws.com/unleash/stitch #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ `items` | array | required| items to upload `deviceId` | string | required| device id @@ -54,7 +54,7 @@ POST /odm/process #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ identityId | string | required| Cognito identity id of the user deviceId | string | required| device id @@ -75,7 +75,7 @@ That might be used to update the UI once the modelling is finished or is interru ### Query parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ task | string | required| the base64 encoded task ARN to query diff --git a/source/includes/_plans.md b/source/includes/_plans.md index 6daa9bdbb5d..bd7f93a125a 100644 --- a/source/includes/_plans.md +++ b/source/includes/_plans.md @@ -21,10 +21,10 @@ Creates new plan item #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ `id` | string, uuid | (auto generated) | database hash id -`name` | string | required | plan name for presenting +`name` | string | required | plan name `description` | string | required | plan description, features available `price` | number | required | plan price per month (x*100) `currency` | string | optional | price currency in standard ISO 4217. Default: AUD @@ -50,7 +50,7 @@ Retrieve plan by ID #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the plan @@ -80,7 +80,7 @@ Replace a given attribute with new value ` PUT /plan/{id}` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ attributeName | string | required| the name of the attribute attributeValue | string | required| the value to assign @@ -100,7 +100,7 @@ Deletes the plan by id #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the plan diff --git a/source/includes/_products.md b/source/includes/_products.md index 144987bd0d0..596acbe4569 100644 --- a/source/includes/_products.md +++ b/source/includes/_products.md @@ -13,12 +13,12 @@ Creates new product item #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ `id` | string, uuid | (auto generated) | database hash id `price` | string | required | product price per month `currency` | string | required | price currency in standard ISO 4217 - e.g. AUD -`name` | string | required | product name for presenting +`name` | string | required | product name `description` | string | required | product description, features available `createdAt` | timestamp | (auto generated) | item created timestamp `updatedAt` | timestamp | (auto generated) | item updated timestamp @@ -39,7 +39,7 @@ Retrieve product by ID #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the product @@ -69,7 +69,7 @@ Replace a given attribute with new value ` PUT /product/{id}` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ attributeName | string | required| the name of the attribute attributeValue | string | required| the value to assign @@ -89,7 +89,7 @@ Deletes the product by id #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the product diff --git a/source/includes/_user.md b/source/includes/_user.md index 81aa2bff347..7a2b778bc0a 100644 --- a/source/includes/_user.md +++ b/source/includes/_user.md @@ -11,7 +11,7 @@ Create new representation of Unleash User. This is post user registration and us #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string, uuid | (auto generated) | database hash id username | string | required | Username alias @@ -37,7 +37,7 @@ Retrieve user by ID #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ id | string | required, uuid format| id of the user @@ -67,7 +67,7 @@ Replace a given attribute with new value ` PUT /user/{id}` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ attributeName | string | required| the name of the attribute attributeValue | string | required| the value to assign @@ -91,7 +91,7 @@ Company logos are to the following path: ` POST /user/uploadLogo` #### Parameters -Name | Type | Contraints | Description +Name | Type | Constraints | Description --------|-------|--------- | ------ companyId | string | required| id of the company filename | string | required| logo file name