Update generated API documentation file
Update the documentation using the command described in README.md
Issue: HIC-101
Change-Id: I19445c4b171e270433bc2d30074a871d04121996
diff --git a/documentation/api-endpoints.md b/documentation/api-endpoints.md
index 90bf752..1ae3f29 100644
--- a/documentation/api-endpoints.md
+++ b/documentation/api-endpoints.md
@@ -4,46 +4,428 @@
<a name="overview"></a>
## Overview
+### Version information
+*Version* : v1
+
+
+### URI scheme
+*BasePath* : /
+
+
+### Consumes
+
+* `application/json`
+
+
+### Produces
+
+* `application/json`
+
+
<a name="paths"></a>
## Paths
-<a name="devices_create"></a>
-### POST /hiccup/api/v1/devices/
+<a name="hiccup_api_v1_crashreports_create"></a>
+### POST /hiccup/api/v1/crashreports/
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**board_date** <br>*optional*|**Example** : `"string"`|string|
-|**chipset** <br>*optional*|**Example** : `"string"`|string|
-|**imei** <br>*optional*|**Example** : `"string"`|string|
-|**last_heartbeat** <br>*optional*|**Example** : `"string"`|string|
-|**next_per_crashreport_key** <br>*optional*|**Example** : `"string"`|string|
-|**next_per_heartbeat_key** <br>*optional*|**Example** : `"string"`|string|
-|**token** <br>*optional*|**Example** : `"string"`|string|
-|**user** <br>*required*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [CrashReport](#crashreport)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**201**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**201**|[CrashReport](#crashreport)|
#### Tags
-* devices
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/crashreports/
+```
+
+
+##### Request body
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+#### Example HTTP response
+
+##### Response 201
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_crashreports_list"></a>
+### GET /hiccup/api/v1/crashreports/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**build_fingerprint** <br>*optional*||string|
+|**Query**|**device** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**radio_version** <br>*optional*||string|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[Response 200](#hiccup_api_v1_crashreports_list-response-200)|
+
+<a name="hiccup_api_v1_crashreports_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[crashreport](#crashreport)" ]`|< [CrashReport](#crashreport) > array|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/crashreports/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_api_v1_crashreports_read"></a>
+### GET /hiccup/api/v1/crashreports/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this crashreport.|integer|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[CrashReport](#crashreport)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/crashreports/0/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_crashreports_update"></a>
+### PUT /hiccup/api/v1/crashreports/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this crashreport.|integer|
+
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [CrashReport](#crashreport)
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[CrashReport](#crashreport)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/crashreports/0/
+```
+
+
+##### Request body
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_crashreports_delete"></a>
+### DELETE /hiccup/api/v1/crashreports/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this crashreport.|integer|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**204**|No Content|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/crashreports/0/
+```
+
+
+<a name="hiccup_api_v1_crashreports_partial_update"></a>
+### PATCH /hiccup/api/v1/crashreports/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this crashreport.|integer|
+
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [CrashReport](#crashreport)
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[CrashReport](#crashreport)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/crashreports/0/
+```
+
+
+##### Request body
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_create"></a>
+### POST /hiccup/api/v1/devices/
+
+#### Description
+Create a device
+
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [Device](#device)
+
+
+#### Responses
+
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**201**||[Device](#device)|
+|**400**|Invalid input.|No Content|
+
+
+#### Tags
+
+* hiccup
#### Example HTTP request
@@ -55,34 +437,125 @@
##### Request body
-```
-json :
+```json
{
+ "id" : 0,
"board_date" : "string",
- "next_per_heartbeat_key" : "string",
- "next_per_crashreport_key" : "string",
- "token" : "string",
- "user" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
"imei" : "string",
"chipset" : "string",
- "last_heartbeat" : "string"
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
}
```
-<a name="register_create"></a>
-### POST /hiccup/api/v1/devices/register/
+#### Example HTTP response
+
+##### Response 201
+```json
+{
+ "id" : 0,
+ "board_date" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
+ "imei" : "string",
+ "chipset" : "string",
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
+}
+```
+
+
+<a name="hiccup_api_v1_devices_list"></a>
+### GET /hiccup/api/v1/devices/
+
+#### Description
+List devices
+
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**board_date** <br>*optional*||string|
+|**Query**|**chipset** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**uuid** <br>*optional*||string|
+
#### Responses
|HTTP Code|Schema|
|---|---|
-|**201**|No Content|
+|**200**|[Response 200](#hiccup_api_v1_devices_list-response-200)|
+
+<a name="hiccup_api_v1_devices_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[device](#device)" ]`|< [Device](#device) > array|
#### Tags
-* register
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/devices/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_api_v1_devices_register_create"></a>
+### POST /hiccup/api/v1/devices/register/
+
+#### Description
+Register a new device.
+
+This endpoint will generate a django user for the new device. The device is
+identified by a uuid, and authenticated with a token.
+We generate the uuid here as this makes it easier to deal with collisions.
+
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [DeviceCreate](#devicecreate)
+
+
+#### Responses
+
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**200**|The device has been successfully registered.|[DeviceRegisterResponseSchema](#deviceregisterresponseschema)|
+|**400**|Invalid input.|No Content|
+
+
+#### Tags
+
+* hiccup
#### Example HTTP request
@@ -93,7 +566,27 @@
```
-<a name="crashreports_read"></a>
+##### Request body
+```json
+{
+ "board_date" : "string",
+ "chipset" : "string"
+}
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "uuid" : "string",
+ "token" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_crashreports_read"></a>
### GET /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/
#### Parameters
@@ -101,42 +594,54 @@
|Type|Name|Schema|
|---|---|---|
|**Path**|**device__uuid** <br>*required*|string|
-|**Path**|**device_local_id** <br>*required*|string|
-|**Query**|**limit** <br>*optional*|string|
-|**Query**|**offset** <br>*optional*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
+|**200**|[CrashReport](#crashreport)|
#### Tags
-* crashreports
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/crashreports/string/
+/hiccup/api/v1/devices/string/crashreports/0/
```
-##### Request query
-```
-json :
+#### Example HTTP response
+
+##### Response 200
+```json
{
- "limit" : "string",
- "offset" : "string"
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
}
```
-<a name="crashreports_update"></a>
+<a name="hiccup_api_v1_devices_crashreports_update"></a>
### PUT /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/
#### Parameters
@@ -144,76 +649,82 @@
|Type|Name|Schema|
|---|---|---|
|**Path**|**device__uuid** <br>*required*|string|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**app_version** <br>*required*|**Example** : `"string"`|string|
-|**boot_reason** <br>*required*|**Example** : `"string"`|string|
-|**build_fingerprint** <br>*required*|**Example** : `"string"`|string|
-|**date** <br>*required*|**Example** : `"string"`|string|
-|**device_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**is_fake_report** <br>*optional*|**Example** : `"string"`|string|
-|**next_logfile_key** <br>*optional*|**Example** : `"string"`|string|
-|**power_off_reason** <br>*required*|**Example** : `"string"`|string|
-|**power_on_reason** <br>*required*|**Example** : `"string"`|string|
-|**radio_version** <br>*optional*|**Example** : `"string"`|string|
-|**uptime** <br>*required*|**Example** : `"string"`|string|
-|**uuid** <br>*required*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [CrashReport](#crashreport)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**200**|[CrashReport](#crashreport)|
#### Tags
-* crashreports
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/crashreports/string/
+/hiccup/api/v1/devices/string/crashreports/0/
```
##### Request body
-```
-json :
+```json
{
- "uptime" : "string",
- "is_fake_report" : "string",
+ "id" : "string",
+ "logfiles" : [ "string" ],
"uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
"boot_reason" : "string",
"power_on_reason" : "string",
- "build_fingerprint" : "string",
"power_off_reason" : "string",
- "radio_version" : "string",
- "next_logfile_key" : "string",
- "date" : "string",
- "app_version" : "string",
- "device_local_id" : "string"
+ "next_logfile_key" : 0,
+ "created_at" : "string"
}
```
-<a name="crashreports_destroy"></a>
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_crashreports_delete"></a>
### DELETE /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/
#### Parameters
@@ -221,7 +732,7 @@
|Type|Name|Schema|
|---|---|---|
|**Path**|**device__uuid** <br>*required*|string|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
#### Responses
@@ -233,18 +744,18 @@
#### Tags
-* crashreports
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/crashreports/string/
+/hiccup/api/v1/devices/string/crashreports/0/
```
-<a name="crashreports_partial_update"></a>
+<a name="hiccup_api_v1_devices_crashreports_partial_update"></a>
### PATCH /hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/
#### Parameters
@@ -252,97 +763,106 @@
|Type|Name|Schema|
|---|---|---|
|**Path**|**device__uuid** <br>*required*|string|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**app_version** <br>*optional*|**Example** : `"string"`|string|
-|**boot_reason** <br>*optional*|**Example** : `"string"`|string|
-|**build_fingerprint** <br>*optional*|**Example** : `"string"`|string|
-|**date** <br>*optional*|**Example** : `"string"`|string|
-|**device_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**is_fake_report** <br>*optional*|**Example** : `"string"`|string|
-|**next_logfile_key** <br>*optional*|**Example** : `"string"`|string|
-|**power_off_reason** <br>*optional*|**Example** : `"string"`|string|
-|**power_on_reason** <br>*optional*|**Example** : `"string"`|string|
-|**radio_version** <br>*optional*|**Example** : `"string"`|string|
-|**uptime** <br>*optional*|**Example** : `"string"`|string|
-|**uuid** <br>*optional*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [CrashReport](#crashreport)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**200**|[CrashReport](#crashreport)|
#### Tags
-* crashreports
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/crashreports/string/
+/hiccup/api/v1/devices/string/crashreports/0/
```
##### Request body
-```
-json :
+```json
{
- "uptime" : "string",
- "is_fake_report" : "string",
+ "id" : "string",
+ "logfiles" : [ "string" ],
"uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
"boot_reason" : "string",
"power_on_reason" : "string",
- "build_fingerprint" : "string",
"power_off_reason" : "string",
- "radio_version" : "string",
- "next_logfile_key" : "string",
- "date" : "string",
- "app_version" : "string",
- "device_local_id" : "string"
+ "next_logfile_key" : 0,
+ "created_at" : "string"
}
```
-<a name="devices_read"></a>
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_read"></a>
### GET /hiccup/api/v1/devices/{uuid}/
+#### Description
+Get a device
+
+
#### Parameters
|Type|Name|Schema|
|---|---|---|
|**Path**|**uuid** <br>*required*|string|
-|**Query**|**limit** <br>*optional*|string|
-|**Query**|**offset** <br>*optional*|string|
#### Responses
-|HTTP Code|Schema|
-|---|---|
-|**200**|No Content|
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**200**||[Device](#device)|
+|**404**|Not found.|No Content|
#### Tags
-* devices
+* hiccup
#### Example HTTP request
@@ -353,19 +873,32 @@
```
-##### Request query
-```
-json :
+#### Example HTTP response
+
+##### Response 200
+```json
{
- "limit" : "string",
- "offset" : "string"
+ "id" : 0,
+ "board_date" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
+ "imei" : "string",
+ "chipset" : "string",
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
}
```
-<a name="devices_update"></a>
+<a name="hiccup_api_v1_devices_update"></a>
### PUT /hiccup/api/v1/devices/{uuid}/
+#### Description
+Update a device
+
+
#### Parameters
|Type|Name|Schema|
@@ -375,36 +908,22 @@
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**board_date** <br>*optional*|**Example** : `"string"`|string|
-|**chipset** <br>*optional*|**Example** : `"string"`|string|
-|**imei** <br>*optional*|**Example** : `"string"`|string|
-|**last_heartbeat** <br>*optional*|**Example** : `"string"`|string|
-|**next_per_crashreport_key** <br>*optional*|**Example** : `"string"`|string|
-|**next_per_heartbeat_key** <br>*optional*|**Example** : `"string"`|string|
-|**token** <br>*optional*|**Example** : `"string"`|string|
-|**user** <br>*required*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [Device](#device)
#### Responses
-|HTTP Code|Schema|
-|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**200**||[Device](#device)|
+|**400**|Invalid input.|No Content|
+|**404**|Not found.|No Content|
#### Tags
-* devices
+* hiccup
#### Example HTTP request
@@ -416,24 +935,48 @@
##### Request body
-```
-json :
+```json
{
+ "id" : 0,
"board_date" : "string",
- "next_per_heartbeat_key" : "string",
- "next_per_crashreport_key" : "string",
- "token" : "string",
- "user" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
"imei" : "string",
"chipset" : "string",
- "last_heartbeat" : "string"
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
}
```
-<a name="devices_destroy"></a>
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : 0,
+ "board_date" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
+ "imei" : "string",
+ "chipset" : "string",
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
+}
+```
+
+
+<a name="hiccup_api_v1_devices_delete"></a>
### DELETE /hiccup/api/v1/devices/{uuid}/
+#### Description
+Delete a device
+
+
#### Parameters
|Type|Name|Schema|
@@ -443,14 +986,15 @@
#### Responses
-|HTTP Code|Schema|
-|---|---|
-|**204**|No Content|
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**204**||No Content|
+|**404**|Not found.|No Content|
#### Tags
-* devices
+* hiccup
#### Example HTTP request
@@ -461,9 +1005,13 @@
```
-<a name="devices_partial_update"></a>
+<a name="hiccup_api_v1_devices_partial_update"></a>
### PATCH /hiccup/api/v1/devices/{uuid}/
+#### Description
+Make a partial update for a device
+
+
#### Parameters
|Type|Name|Schema|
@@ -473,36 +1021,22 @@
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**board_date** <br>*optional*|**Example** : `"string"`|string|
-|**chipset** <br>*optional*|**Example** : `"string"`|string|
-|**imei** <br>*optional*|**Example** : `"string"`|string|
-|**last_heartbeat** <br>*optional*|**Example** : `"string"`|string|
-|**next_per_crashreport_key** <br>*optional*|**Example** : `"string"`|string|
-|**next_per_heartbeat_key** <br>*optional*|**Example** : `"string"`|string|
-|**token** <br>*optional*|**Example** : `"string"`|string|
-|**user** <br>*optional*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [Device](#device)
#### Responses
-|HTTP Code|Schema|
-|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**200**||[Device](#device)|
+|**400**|Invalid input.|No Content|
+|**404**|Not found.|No Content|
#### Tags
-* devices
+* hiccup
#### Example HTTP request
@@ -514,22 +1048,42 @@
##### Request body
-```
-json :
+```json
{
+ "id" : 0,
"board_date" : "string",
- "next_per_heartbeat_key" : "string",
- "next_per_crashreport_key" : "string",
- "token" : "string",
- "user" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
"imei" : "string",
"chipset" : "string",
- "last_heartbeat" : "string"
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
}
```
-<a name="crashreports_create"></a>
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : 0,
+ "board_date" : "string",
+ "last_heartbeat" : "string",
+ "uuid" : "string",
+ "imei" : "string",
+ "chipset" : "string",
+ "token" : "string",
+ "next_per_crashreport_key" : 0,
+ "next_per_heartbeat_key" : 0,
+ "user" : 0
+}
+```
+
+
+<a name="hiccup_api_v1_devices_crashreports_create"></a>
### POST /hiccup/api/v1/devices/{uuid}/crashreports/
#### Parameters
@@ -541,40 +1095,20 @@
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**app_version** <br>*required*|**Example** : `"string"`|string|
-|**boot_reason** <br>*required*|**Example** : `"string"`|string|
-|**build_fingerprint** <br>*required*|**Example** : `"string"`|string|
-|**date** <br>*required*|**Example** : `"string"`|string|
-|**device_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**is_fake_report** <br>*optional*|**Example** : `"string"`|string|
-|**next_logfile_key** <br>*optional*|**Example** : `"string"`|string|
-|**power_off_reason** <br>*required*|**Example** : `"string"`|string|
-|**power_on_reason** <br>*required*|**Example** : `"string"`|string|
-|**radio_version** <br>*optional*|**Example** : `"string"`|string|
-|**uptime** <br>*required*|**Example** : `"string"`|string|
-|**uuid** <br>*required*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [CrashReport](#crashreport)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**201**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**201**|[CrashReport](#crashreport)|
#### Tags
-* crashreports
+* hiccup
#### Example HTTP request
@@ -586,26 +1120,105 @@
##### Request body
-```
-json :
+```json
{
- "uptime" : "string",
- "is_fake_report" : "string",
+ "id" : "string",
+ "logfiles" : [ "string" ],
"uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
"boot_reason" : "string",
"power_on_reason" : "string",
- "build_fingerprint" : "string",
"power_off_reason" : "string",
- "radio_version" : "string",
- "next_logfile_key" : "string",
- "date" : "string",
- "app_version" : "string",
- "device_local_id" : "string"
+ "next_logfile_key" : 0,
+ "created_at" : "string"
}
```
-<a name="logfile_put_create"></a>
+#### Example HTTP response
+
+##### Response 201
+```json
+{
+ "id" : "string",
+ "logfiles" : [ "string" ],
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "is_fake_report" : true,
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "boot_reason" : "string",
+ "power_on_reason" : "string",
+ "power_off_reason" : "string",
+ "next_logfile_key" : 0,
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_crashreports_list"></a>
+### GET /hiccup/api/v1/devices/{uuid}/crashreports/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**uuid** <br>*required*||string|
+|**Query**|**build_fingerprint** <br>*optional*||string|
+|**Query**|**device** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**radio_version** <br>*optional*||string|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[Response 200](#hiccup_api_v1_devices_crashreports_list-response-200)|
+
+<a name="hiccup_api_v1_devices_crashreports_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[crashreport](#crashreport)" ]`|< [CrashReport](#crashreport) > array|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/devices/string/crashreports/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_api_v1_devices_crashreports_logfile_put_create"></a>
### POST /hiccup/api/v1/devices/{uuid}/crashreports/{device_local_id}/logfile_put/{filename}/
#### Parameters
@@ -624,9 +1237,14 @@
|**201**|No Content|
+#### Consumes
+
+* `\*/*`
+
+
#### Tags
-* logfile_put
+* hiccup
#### Example HTTP request
@@ -637,7 +1255,7 @@
```
-<a name="heartbeats_create"></a>
+<a name="hiccup_api_v1_devices_heartbeats_create"></a>
### POST /hiccup/api/v1/devices/{uuid}/heartbeats/
#### Parameters
@@ -649,35 +1267,20 @@
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**app_version** <br>*required*|**Example** : `"string"`|string|
-|**build_fingerprint** <br>*required*|**Example** : `"string"`|string|
-|**date** <br>*required*|**Example** : `"string"`|string|
-|**device_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**radio_version** <br>*optional*|**Example** : `"string"`|string|
-|**uptime** <br>*required*|**Example** : `"string"`|string|
-|**uuid** <br>*required*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [HeartBeat](#heartbeat)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**201**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**201**|[HeartBeat](#heartbeat)|
#### Tags
-* heartbeats
+* hiccup
#### Example HTTP request
@@ -689,138 +1292,220 @@
##### Request body
-```
-json :
+```json
{
- "uptime" : "string",
+ "id" : "string",
"uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
"build_fingerprint" : "string",
"radio_version" : "string",
- "date" : "string",
- "app_version" : "string",
- "device_local_id" : "string"
+ "created_at" : "string"
}
```
-<a name="heartbeats_read"></a>
+#### Example HTTP response
+
+##### Response 201
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_heartbeats_list"></a>
+### GET /hiccup/api/v1/devices/{uuid}/heartbeats/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**uuid** <br>*required*||string|
+|**Query**|**build_fingerprint** <br>*optional*||string|
+|**Query**|**device** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**radio_version** <br>*optional*||string|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[Response 200](#hiccup_api_v1_devices_heartbeats_list-response-200)|
+
+<a name="hiccup_api_v1_devices_heartbeats_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[heartbeat](#heartbeat)" ]`|< [HeartBeat](#heartbeat) > array|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/devices/string/heartbeats/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_api_v1_devices_heartbeats_read"></a>
### GET /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/
#### Parameters
|Type|Name|Schema|
|---|---|---|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
|**Path**|**uuid** <br>*required*|string|
-|**Query**|**limit** <br>*optional*|string|
-|**Query**|**offset** <br>*optional*|string|
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
+|**200**|[HeartBeat](#heartbeat)|
#### Tags
-* heartbeats
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/heartbeats/string/
+/hiccup/api/v1/devices/string/heartbeats/0/
```
-##### Request query
-```
-json :
+#### Example HTTP response
+
+##### Response 200
+```json
{
- "limit" : "string",
- "offset" : "string"
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
}
```
-<a name="heartbeats_update"></a>
+<a name="hiccup_api_v1_devices_heartbeats_update"></a>
### PUT /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/
#### Parameters
|Type|Name|Schema|
|---|---|---|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
|**Path**|**uuid** <br>*required*|string|
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**app_version** <br>*required*|**Example** : `"string"`|string|
-|**build_fingerprint** <br>*required*|**Example** : `"string"`|string|
-|**date** <br>*required*|**Example** : `"string"`|string|
-|**device_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**radio_version** <br>*optional*|**Example** : `"string"`|string|
-|**uptime** <br>*required*|**Example** : `"string"`|string|
-|**uuid** <br>*required*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [HeartBeat](#heartbeat)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**200**|[HeartBeat](#heartbeat)|
#### Tags
-* heartbeats
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/heartbeats/string/
+/hiccup/api/v1/devices/string/heartbeats/0/
```
##### Request body
-```
-json :
+```json
{
- "uptime" : "string",
+ "id" : "string",
"uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
"build_fingerprint" : "string",
"radio_version" : "string",
- "date" : "string",
- "app_version" : "string",
- "device_local_id" : "string"
+ "created_at" : "string"
}
```
-<a name="heartbeats_destroy"></a>
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_devices_heartbeats_delete"></a>
### DELETE /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/
#### Parameters
|Type|Name|Schema|
|---|---|---|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
|**Path**|**uuid** <br>*required*|string|
@@ -833,194 +1518,329 @@
#### Tags
-* heartbeats
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/heartbeats/string/
+/hiccup/api/v1/devices/string/heartbeats/0/
```
-<a name="heartbeats_partial_update"></a>
+<a name="hiccup_api_v1_devices_heartbeats_partial_update"></a>
### PATCH /hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/
#### Parameters
|Type|Name|Schema|
|---|---|---|
-|**Path**|**device_local_id** <br>*required*|string|
+|**Path**|**device_local_id** <br>*required*|integer|
|**Path**|**uuid** <br>*required*|string|
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**app_version** <br>*optional*|**Example** : `"string"`|string|
-|**build_fingerprint** <br>*optional*|**Example** : `"string"`|string|
-|**date** <br>*optional*|**Example** : `"string"`|string|
-|**device_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**radio_version** <br>*optional*|**Example** : `"string"`|string|
-|**uptime** <br>*optional*|**Example** : `"string"`|string|
-|**uuid** <br>*optional*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [HeartBeat](#heartbeat)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**200**|[HeartBeat](#heartbeat)|
#### Tags
-* heartbeats
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/devices/string/heartbeats/string/
+/hiccup/api/v1/devices/string/heartbeats/0/
```
##### Request body
-```
-json :
+```json
{
- "uptime" : "string",
+ "id" : "string",
"uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
"build_fingerprint" : "string",
"radio_version" : "string",
- "date" : "string",
- "app_version" : "string",
- "device_local_id" : "string"
+ "created_at" : "string"
}
```
-<a name="logfiles_read"></a>
-### GET /hiccup/api/v1/logfiles/{pk}/
+#### Example HTTP response
-#### Parameters
+##### Response 200
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
-|Type|Name|Schema|
-|---|---|---|
-|**Path**|**pk** <br>*required*|string|
-|**Query**|**limit** <br>*optional*|string|
-|**Query**|**offset** <br>*optional*|string|
+
+<a name="hiccup_api_v1_heartbeats_create"></a>
+### POST /hiccup/api/v1/heartbeats/
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [HeartBeat](#heartbeat)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
+|**201**|[HeartBeat](#heartbeat)|
#### Tags
-* logfiles
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/logfiles/string/
+/hiccup/api/v1/heartbeats/
```
-##### Request query
-```
-json :
+##### Request body
+```json
{
- "limit" : "string",
- "offset" : "string"
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
}
```
-<a name="logfiles_update"></a>
-### PUT /hiccup/api/v1/logfiles/{pk}/
+#### Example HTTP response
+
+##### Response 201
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_heartbeats_list"></a>
+### GET /hiccup/api/v1/heartbeats/
#### Parameters
-|Type|Name|Schema|
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**build_fingerprint** <br>*optional*||string|
+|**Query**|**device** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**radio_version** <br>*optional*||string|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[Response 200](#hiccup_api_v1_heartbeats_list-response-200)|
+
+<a name="hiccup_api_v1_heartbeats_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
|---|---|---|
-|**Path**|**pk** <br>*required*|string|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[heartbeat](#heartbeat)" ]`|< [HeartBeat](#heartbeat) > array|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/heartbeats/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_api_v1_heartbeats_read"></a>
+### GET /hiccup/api/v1/heartbeats/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this heart beat.|integer|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[HeartBeat](#heartbeat)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/heartbeats/0/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_heartbeats_update"></a>
+### PUT /hiccup/api/v1/heartbeats/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this heart beat.|integer|
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**crashreport** <br>*required*|**Example** : `"string"`|string|
-|**crashreport_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**logfile** <br>*required*|**Example** : `"string"`|string|
-|**logfile_type** <br>*optional*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [HeartBeat](#heartbeat)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**200**|[HeartBeat](#heartbeat)|
#### Tags
-* logfiles
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/logfiles/string/
+/hiccup/api/v1/heartbeats/0/
```
##### Request body
-```
-json :
+```json
{
- "logfile" : "string",
- "crashreport" : "string",
- "crashreport_local_id" : "string",
- "logfile_type" : "string"
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
}
```
-<a name="logfiles_destroy"></a>
-### DELETE /hiccup/api/v1/logfiles/{pk}/
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_heartbeats_delete"></a>
+### DELETE /hiccup/api/v1/heartbeats/{id}/
#### Parameters
-|Type|Name|Schema|
-|---|---|---|
-|**Path**|**pk** <br>*required*|string|
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this heart beat.|integer|
#### Responses
@@ -1032,103 +1852,353 @@
#### Tags
-* logfiles
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/logfiles/string/
+/hiccup/api/v1/heartbeats/0/
```
-<a name="logfiles_partial_update"></a>
-### PATCH /hiccup/api/v1/logfiles/{pk}/
+<a name="hiccup_api_v1_heartbeats_partial_update"></a>
+### PATCH /hiccup/api/v1/heartbeats/{id}/
#### Parameters
-|Type|Name|Schema|
-|---|---|---|
-|**Path**|**pk** <br>*required*|string|
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this heart beat.|integer|
#### Body parameter
*Name* : data
-*Flags* : optional
-
-
-|Name|Description|Schema|
-|---|---|---|
-|**crashreport** <br>*optional*|**Example** : `"string"`|string|
-|**crashreport_local_id** <br>*optional*|**Example** : `"string"`|string|
-|**logfile** <br>*optional*|**Example** : `"string"`|string|
-|**logfile_type** <br>*optional*|**Example** : `"string"`|string|
+*Flags* : required
+*Type* : [HeartBeat](#heartbeat)
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
-
-
-#### Consumes
-
-* `application/json`
+|**200**|[HeartBeat](#heartbeat)|
#### Tags
-* logfiles
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/api/v1/logfiles/string/
+/hiccup/api/v1/heartbeats/0/
```
##### Request body
-```
-json :
+```json
{
- "logfile" : "string",
- "crashreport" : "string",
- "crashreport_local_id" : "string",
- "logfile_type" : "string"
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
}
```
-<a name="docs_read"></a>
-### GET /hiccup/docs/
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : "string",
+ "uuid" : "string",
+ "device_local_id" : 0,
+ "date" : "string",
+ "app_version" : 0,
+ "uptime" : "string",
+ "build_fingerprint" : "string",
+ "radio_version" : "string",
+ "created_at" : "string"
+}
+```
+
+
+<a name="hiccup_api_v1_logfiles_list"></a>
+### GET /hiccup/api/v1/logfiles/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
+|**200**|[Response 200](#hiccup_api_v1_logfiles_list-response-200)|
+
+<a name="hiccup_api_v1_logfiles_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[logfile](#logfile)" ]`|< [LogFile](#logfile) > array|
#### Tags
-* docs
+* hiccup
#### Example HTTP request
##### Request path
```
-/hiccup/docs/
+/hiccup/api/v1/logfiles/
```
-<a name="device_overview_read"></a>
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_api_v1_logfiles_read"></a>
+### GET /hiccup/api/v1/logfiles/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this log file.|integer|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[LogFile](#logfile)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/logfiles/0/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : 0,
+ "logfile_type" : "string",
+ "logfile" : "string",
+ "crashreport_local_id" : 0,
+ "created_at" : "string",
+ "crashreport" : 0
+}
+```
+
+
+<a name="hiccup_api_v1_logfiles_update"></a>
+### PUT /hiccup/api/v1/logfiles/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this log file.|integer|
+
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [LogFile](#logfile)
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[LogFile](#logfile)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/logfiles/0/
+```
+
+
+##### Request body
+```json
+{
+ "id" : 0,
+ "logfile_type" : "string",
+ "logfile" : "string",
+ "crashreport_local_id" : 0,
+ "created_at" : "string",
+ "crashreport" : 0
+}
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : 0,
+ "logfile_type" : "string",
+ "logfile" : "string",
+ "crashreport_local_id" : 0,
+ "created_at" : "string",
+ "crashreport" : 0
+}
+```
+
+
+<a name="hiccup_api_v1_logfiles_delete"></a>
+### DELETE /hiccup/api/v1/logfiles/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this log file.|integer|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**204**|No Content|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/logfiles/0/
+```
+
+
+<a name="hiccup_api_v1_logfiles_partial_update"></a>
+### PATCH /hiccup/api/v1/logfiles/{id}/
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id** <br>*required*|A unique integer value identifying this log file.|integer|
+
+
+#### Body parameter
+*Name* : data
+*Flags* : required
+*Type* : [LogFile](#logfile)
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[LogFile](#logfile)|
+
+
+#### Tags
+
+* hiccup
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup/api/v1/logfiles/0/
+```
+
+
+##### Request body
+```json
+{
+ "id" : 0,
+ "logfile_type" : "string",
+ "logfile" : "string",
+ "crashreport_local_id" : 0,
+ "created_at" : "string",
+ "crashreport" : 0
+}
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+{
+ "id" : 0,
+ "logfile_type" : "string",
+ "logfile" : "string",
+ "crashreport_local_id" : 0,
+ "created_at" : "string",
+ "crashreport" : 0
+}
+```
+
+
+<a name="hiccup_stats_api_v1_device_overview_read"></a>
### GET /hiccup_stats/api/v1/device_overview/{uuid}/
+#### Description
+Get some general statistics for a device.
+
+Args:
+ request: Http request
+ uuid: The UUID of the device
+ format: Optional response format parameter
+
+Returns: Some general information of the device in a dictionary.
+
+
#### Parameters
|Type|Name|Schema|
@@ -1145,7 +2215,7 @@
#### Tags
-* device_overview
+* hiccup_stats
#### Example HTTP request
@@ -1156,9 +2226,20 @@
```
-<a name="device_report_history_read"></a>
+<a name="hiccup_stats_api_v1_device_report_history_read"></a>
### GET /hiccup_stats/api/v1/device_report_history/{uuid}/
+#### Description
+Get the report history of a device.
+
+Args:
+ request: Http request
+ uuid: The UUID of the device
+ format: Optional response format parameter
+
+Returns: The report history of the requested device.
+
+
#### Parameters
|Type|Name|Schema|
@@ -1175,7 +2256,7 @@
#### Tags
-* device_report_history
+* hiccup_stats
#### Example HTTP request
@@ -1186,9 +2267,20 @@
```
-<a name="device_update_history_read"></a>
+<a name="hiccup_stats_api_v1_device_update_history_read"></a>
### GET /hiccup_stats/api/v1/device_update_history/{uuid}/
+#### Description
+Get the update history of a device.
+
+Args:
+ request: Http request
+ uuid: The UUID of the device
+ format: Optional response format parameter
+
+Returns: The update history of the requested device.
+
+
#### Parameters
|Type|Name|Schema|
@@ -1205,7 +2297,7 @@
#### Tags
-* device_update_history
+* hiccup_stats
#### Example HTTP request
@@ -1216,9 +2308,20 @@
```
-<a name="logfile_download_read"></a>
+<a name="hiccup_stats_api_v1_logfile_download_read"></a>
### GET /hiccup_stats/api/v1/logfile_download/{id}/
+#### Description
+Get a logfile.
+
+Args:
+ request: Http request
+ id_logfile: The id of the log file
+ format: Optional response format parameter
+
+Returns: The log file with the corresponding id.
+
+
#### Parameters
|Type|Name|Schema|
@@ -1235,7 +2338,7 @@
#### Tags
-* logfile_download
+* hiccup_stats
#### Example HTTP request
@@ -1246,9 +2349,149 @@
```
-<a name="status_read"></a>
+<a name="hiccup_stats_api_v1_radio_version_daily_list"></a>
+### GET /hiccup_stats/api/v1/radio_version_daily/
+
+#### Description
+View for listing RadioVersionDaily instances.
+
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**date** <br>*optional*||string|
+|**Query**|**date_end** <br>*optional*||string|
+|**Query**|**date_start** <br>*optional*||string|
+|**Query**|**heartbeats** <br>*optional*||number|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**other** <br>*optional*||number|
+|**Query**|**prob_crashes** <br>*optional*||number|
+|**Query**|**smpl** <br>*optional*||number|
+|**Query**|**version** <br>*optional*||string|
+|**Query**|**version__is_beta_release** <br>*optional*||string|
+|**Query**|**version__is_official_release** <br>*optional*||string|
+|**Query**|**version__radio_version** <br>*optional*||string|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[Response 200](#hiccup_stats_api_v1_radio_version_daily_list-response-200)|
+
+<a name="hiccup_stats_api_v1_radio_version_daily_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[radioversiondaily](#radioversiondaily)" ]`|< [RadioVersionDaily](#radioversiondaily) > array|
+
+
+#### Tags
+
+* hiccup_stats
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup_stats/api/v1/radio_version_daily/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_stats_api_v1_radio_versions_list"></a>
+### GET /hiccup_stats/api/v1/radio_versions/
+
+#### Description
+View for listing RadioVersion instances.
+
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**first_seen_after** <br>*optional*||string|
+|**Query**|**first_seen_before** <br>*optional*||string|
+|**Query**|**first_seen_on** <br>*optional*||string|
+|**Query**|**heartbeats** <br>*optional*||number|
+|**Query**|**is_beta_release** <br>*optional*||string|
+|**Query**|**is_official_release** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**other** <br>*optional*||number|
+|**Query**|**prob_crashes** <br>*optional*||number|
+|**Query**|**radio_version** <br>*optional*||string|
+|**Query**|**released_after** <br>*optional*||string|
+|**Query**|**released_before** <br>*optional*||string|
+|**Query**|**released_on** <br>*optional*||string|
+|**Query**|**smpl** <br>*optional*||number|
+
+
+#### Responses
+
+|HTTP Code|Schema|
+|---|---|
+|**200**|[Response 200](#hiccup_stats_api_v1_radio_versions_list-response-200)|
+
+<a name="hiccup_stats_api_v1_radio_versions_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[radioversion](#radioversion)" ]`|< [RadioVersion](#radioversion) > array|
+
+
+#### Tags
+
+* hiccup_stats
+
+
+#### Example HTTP request
+
+##### Request path
+```
+/hiccup_stats/api/v1/radio_versions/
+```
+
+
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
+```
+
+
+<a name="hiccup_stats_api_v1_status_list"></a>
### GET /hiccup_stats/api/v1/status/
+#### Description
+Get the number of devices, crashreports and heartbeats.
+
+Args:
+ request: Http request
+ format: Optional response format parameter
+
+Returns: The number of devices, crashreports and heartbeats.
+
+
#### Responses
|HTTP Code|Schema|
@@ -1258,7 +2501,7 @@
#### Tags
-* status
+* hiccup_stats
#### Example HTTP request
@@ -1269,38 +2512,52 @@
```
-<a name="version_daily_read"></a>
+<a name="hiccup_stats_api_v1_version_daily_list"></a>
### GET /hiccup_stats/api/v1/version_daily/
+#### Description
+View for listing VersionDaily instances.
+
+
#### Parameters
-|Type|Name|Schema|
-|---|---|---|
-|**Query**|**date** <br>*optional*|string|
-|**Query**|**date_end** <br>*optional*|string|
-|**Query**|**date_start** <br>*optional*|string|
-|**Query**|**heartbeats** <br>*optional*|string|
-|**Query**|**limit** <br>*optional*|string|
-|**Query**|**offset** <br>*optional*|string|
-|**Query**|**other** <br>*optional*|string|
-|**Query**|**prob_crashes** <br>*optional*|string|
-|**Query**|**smpl** <br>*optional*|string|
-|**Query**|**version** <br>*optional*|string|
-|**Query**|**version__build_fingerprint** <br>*optional*|string|
-|**Query**|**version__is_beta_release** <br>*optional*|string|
-|**Query**|**version__is_official_release** <br>*optional*|string|
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**date** <br>*optional*||string|
+|**Query**|**date_end** <br>*optional*||string|
+|**Query**|**date_start** <br>*optional*||string|
+|**Query**|**heartbeats** <br>*optional*||number|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**other** <br>*optional*||number|
+|**Query**|**prob_crashes** <br>*optional*||number|
+|**Query**|**smpl** <br>*optional*||number|
+|**Query**|**version** <br>*optional*||string|
+|**Query**|**version__build_fingerprint** <br>*optional*||string|
+|**Query**|**version__is_beta_release** <br>*optional*||string|
+|**Query**|**version__is_official_release** <br>*optional*||string|
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
+|**200**|[Response 200](#hiccup_stats_api_v1_version_daily_list-response-200)|
+
+<a name="hiccup_stats_api_v1_version_daily_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[versiondaily](#versiondaily)" ]`|< [VersionDaily](#versiondaily) > array|
#### Tags
-* version_daily
+* hiccup_stats
#### Example HTTP request
@@ -1311,61 +2568,62 @@
```
-##### Request query
-```
-json :
-{
- "date" : "string",
- "date_end" : "string",
- "date_start" : "string",
- "heartbeats" : "string",
- "limit" : "string",
- "offset" : "string",
- "other" : "string",
- "prob_crashes" : "string",
- "smpl" : "string",
- "version" : "string",
- "version__build_fingerprint" : "string",
- "version__is_beta_release" : "string",
- "version__is_official_release" : "string"
-}
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
```
-<a name="versions_read"></a>
+<a name="hiccup_stats_api_v1_versions_list"></a>
### GET /hiccup_stats/api/v1/versions/
+#### Description
+View for listing versions.
+
+
#### Parameters
-|Type|Name|Schema|
-|---|---|---|
-|**Query**|**build_fingerprint** <br>*optional*|string|
-|**Query**|**first_seen_after** <br>*optional*|string|
-|**Query**|**first_seen_before** <br>*optional*|string|
-|**Query**|**first_seen_on** <br>*optional*|string|
-|**Query**|**heartbeats** <br>*optional*|string|
-|**Query**|**is_beta_release** <br>*optional*|string|
-|**Query**|**is_official_release** <br>*optional*|string|
-|**Query**|**limit** <br>*optional*|string|
-|**Query**|**offset** <br>*optional*|string|
-|**Query**|**other** <br>*optional*|string|
-|**Query**|**prob_crashes** <br>*optional*|string|
-|**Query**|**released_after** <br>*optional*|string|
-|**Query**|**released_before** <br>*optional*|string|
-|**Query**|**released_on** <br>*optional*|string|
-|**Query**|**smpl** <br>*optional*|string|
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Query**|**build_fingerprint** <br>*optional*||string|
+|**Query**|**first_seen_after** <br>*optional*||string|
+|**Query**|**first_seen_before** <br>*optional*||string|
+|**Query**|**first_seen_on** <br>*optional*||string|
+|**Query**|**heartbeats** <br>*optional*||number|
+|**Query**|**is_beta_release** <br>*optional*||string|
+|**Query**|**is_official_release** <br>*optional*||string|
+|**Query**|**limit** <br>*optional*|Number of results to return per page.|integer|
+|**Query**|**offset** <br>*optional*|The initial index from which to return the results.|integer|
+|**Query**|**other** <br>*optional*||number|
+|**Query**|**prob_crashes** <br>*optional*||number|
+|**Query**|**released_after** <br>*optional*||string|
+|**Query**|**released_before** <br>*optional*||string|
+|**Query**|**released_on** <br>*optional*||string|
+|**Query**|**smpl** <br>*optional*||number|
#### Responses
|HTTP Code|Schema|
|---|---|
-|**200**|No Content|
+|**200**|[Response 200](#hiccup_stats_api_v1_versions_list-response-200)|
+
+<a name="hiccup_stats_api_v1_versions_list-response-200"></a>
+**Response 200**
+
+|Name|Description|Schema|
+|---|---|---|
+|**count** <br>*required*|**Example** : `0`|integer|
+|**next** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**previous** <br>*optional*|**Example** : `"string"`|string (uri)|
+|**results** <br>*required*|**Example** : `[ "[version](#version)" ]`|< [Version](#version) > array|
#### Tags
-* versions
+* hiccup_stats
#### Example HTTP request
@@ -1376,31 +2634,169 @@
```
-##### Request query
-```
-json :
-{
- "build_fingerprint" : "string",
- "first_seen_after" : "string",
- "first_seen_before" : "string",
- "first_seen_on" : "string",
- "heartbeats" : "string",
- "is_beta_release" : "string",
- "is_official_release" : "string",
- "limit" : "string",
- "offset" : "string",
- "other" : "string",
- "prob_crashes" : "string",
- "released_after" : "string",
- "released_before" : "string",
- "released_on" : "string",
- "smpl" : "string"
-}
+#### Example HTTP response
+
+##### Response 200
+```json
+"object"
```
+<a name="definitions"></a>
+## Definitions
+
+<a name="crashreport"></a>
+### CrashReport
+
+|Name|Description|Schema|
+|---|---|---|
+|**app_version** <br>*required*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**boot_reason** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**build_fingerprint** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**created_at** <br>*optional* <br>*read-only*|**Example** : `"string"`|string (date-time)|
+|**date** <br>*required*|**Example** : `"string"`|string (date-time)|
+|**device_local_id** <br>*optional*|**Example** : `0`|integer|
+|**id** <br>*optional* <br>*read-only*|**Example** : `"string"`|string|
+|**is_fake_report** <br>*optional*|**Example** : `true`|boolean|
+|**logfiles** <br>*optional* <br>*read-only*|**Example** : `[ "string" ]`|< string (uri) > array|
+|**next_logfile_key** <br>*optional*|**Minimum value** : `0` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**power_off_reason** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**power_on_reason** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**radio_version** <br>*optional*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**uptime** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**uuid** <br>*required*|**Length** : `1 - 64` <br>**Example** : `"string"`|string|
+
+
+<a name="device"></a>
+### Device
+
+|Name|Description|Schema|
+|---|---|---|
+|**board_date** <br>*required*|**Example** : `"string"`|string (date-time)|
+|**chipset** <br>*optional*|**Maximal length** : `200` <br>**Example** : `"string"`|string|
+|**id** <br>*optional* <br>*read-only*|**Example** : `0`|integer|
+|**imei** <br>*optional*|**Maximal length** : `32` <br>**Example** : `"string"`|string|
+|**last_heartbeat** <br>*required*|**Example** : `"string"`|string (date-time)|
+|**next_per_crashreport_key** <br>*optional*|**Minimum value** : `0` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**next_per_heartbeat_key** <br>*optional*|**Minimum value** : `0` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**token** <br>*optional*|**Maximal length** : `200` <br>**Example** : `"string"`|string|
+|**user** <br>*required*|**Example** : `0`|integer|
+|**uuid** <br>*optional* <br>*read-only*|**Minimum length** : `1` <br>**Example** : `"string"`|string|
+
+
+<a name="devicecreate"></a>
+### DeviceCreate
+
+|Name|Description|Schema|
+|---|---|---|
+|**board_date** <br>*required*|**Example** : `"string"`|string (date-time)|
+|**chipset** <br>*required*|**Maximal length** : `200` <br>**Example** : `"string"`|string|
+
+
+<a name="deviceregisterresponseschema"></a>
+### DeviceRegisterResponseSchema
+
+|Name|Description|Schema|
+|---|---|---|
+|**token** <br>*optional*|**Maximal length** : `200` <br>**Example** : `"string"`|string|
+|**uuid** <br>*optional* <br>*read-only*|**Minimum length** : `1` <br>**Example** : `"string"`|string|
+
+
+<a name="heartbeat"></a>
+### HeartBeat
+
+|Name|Description|Schema|
+|---|---|---|
+|**app_version** <br>*required*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**build_fingerprint** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**created_at** <br>*optional* <br>*read-only*|**Example** : `"string"`|string (date-time)|
+|**date** <br>*required*|**Example** : `"string"`|string (date-time)|
+|**device_local_id** <br>*optional*|**Example** : `0`|integer|
+|**id** <br>*optional* <br>*read-only*|**Example** : `"string"`|string|
+|**radio_version** <br>*optional*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**uptime** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**uuid** <br>*required*|**Length** : `1 - 64` <br>**Example** : `"string"`|string|
+
+
+<a name="logfile"></a>
+### LogFile
+
+|Name|Description|Schema|
+|---|---|---|
+|**crashreport** <br>*required*|**Example** : `0`|integer|
+|**crashreport_local_id** <br>*optional*|**Minimum value** : `0` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**created_at** <br>*optional* <br>*read-only*|**Example** : `"string"`|string (date-time)|
+|**id** <br>*optional* <br>*read-only*|**Example** : `0`|integer|
+|**logfile** <br>*optional* <br>*read-only*|**Example** : `"string"`|string (uri)|
+|**logfile_type** <br>*optional*|**Length** : `1 - 36` <br>**Example** : `"string"`|string|
+
+
+<a name="radioversion"></a>
+### RadioVersion
+
+|Name|Description|Schema|
+|---|---|---|
+|**first_seen_on** <br>*required*|**Example** : `"string"`|string (date)|
+|**heartbeats** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**id** <br>*optional* <br>*read-only*|**Example** : `0`|integer|
+|**is_beta_release** <br>*optional*|**Example** : `true`|boolean|
+|**is_official_release** <br>*optional*|**Example** : `true`|boolean|
+|**other** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**prob_crashes** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**radio_version** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**released_on** <br>*required*|**Example** : `"string"`|string (date)|
+|**smpl** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+
+
+<a name="radioversiondaily"></a>
+### RadioVersionDaily
+
+|Name|Description|Schema|
+|---|---|---|
+|**date** <br>*required*|**Example** : `"string"`|string (date)|
+|**heartbeats** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**id** <br>*optional* <br>*read-only*|**Example** : `0`|integer|
+|**other** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**prob_crashes** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**radio_version** <br>*required*|**Minimum length** : `1` <br>**Example** : `"string"`|string|
+|**smpl** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**version** <br>*required*|**Example** : `0`|integer|
+
+
+<a name="version"></a>
+### Version
+
+|Name|Description|Schema|
+|---|---|---|
+|**build_fingerprint** <br>*required*|**Length** : `1 - 200` <br>**Example** : `"string"`|string|
+|**first_seen_on** <br>*required*|**Example** : `"string"`|string (date)|
+|**heartbeats** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**id** <br>*optional* <br>*read-only*|**Example** : `0`|integer|
+|**is_beta_release** <br>*optional*|**Example** : `true`|boolean|
+|**is_official_release** <br>*optional*|**Example** : `true`|boolean|
+|**other** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**prob_crashes** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**released_on** <br>*required*|**Example** : `"string"`|string (date)|
+|**smpl** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+
+
+<a name="versiondaily"></a>
+### VersionDaily
+
+|Name|Description|Schema|
+|---|---|---|
+|**build_fingerprint** <br>*required*|**Minimum length** : `1` <br>**Example** : `"string"`|string|
+|**date** <br>*required*|**Example** : `"string"`|string (date)|
+|**heartbeats** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**id** <br>*optional* <br>*read-only*|**Example** : `0`|integer|
+|**other** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**prob_crashes** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**smpl** <br>*optional*|**Minimum value** : `-2147483648` <br>**Maximum value** : `2147483647` <br>**Example** : `0`|integer|
+|**version** <br>*required*|**Example** : `0`|integer|
+
+
<a name="securityscheme"></a>