blob: 4ad2a40b833ba2bc58317317c34bc260116b9941 [file] [log] [blame]
{
"swagger": "2.0",
"info": {
"title": "Hiccup API",
"description": "",
"version": ""
},
"paths": {
"/hiccup/api/v1/devices/": {
"post": {
"tags": [
"devices"
],
"consumes": [
"application/json"
],
"responses": {
"201": {
"description": ""
}
},
"parameters": [
{
"schema": {
"required": [
"board_date",
"last_heartbeat",
"user"
],
"type": "object",
"properties": {
"board_date": {
"type": "string",
"description": ""
},
"next_per_heartbeat_key": {
"type": "string",
"description": ""
},
"next_per_crashreport_key": {
"type": "string",
"description": ""
},
"token": {
"type": "string",
"description": ""
},
"user": {
"type": "string",
"description": ""
},
"imei": {
"type": "string",
"description": ""
},
"chipset": {
"type": "string",
"description": ""
},
"last_heartbeat": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "devices_create"
}
},
"/hiccup/api/v1/devices/register/": {
"post": {
"tags": [
"register"
],
"responses": {
"201": {
"description": ""
}
},
"parameters": [],
"operationId": "register_create"
}
},
"/hiccup/api/v1/devices/{device__uuid}/crashreports/{device_local_id}/": {
"get": {
"tags": [
"crashreports"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "device__uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"description": "",
"required": false,
"type": "string",
"name": "limit",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "offset",
"in": "query"
}
],
"operationId": "crashreports_read"
},
"put": {
"tags": [
"crashreports"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "device__uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"schema": {
"required": [
"uuid",
"date",
"app_version",
"uptime",
"build_fingerprint",
"boot_reason",
"power_on_reason",
"power_off_reason"
],
"type": "object",
"properties": {
"uptime": {
"type": "string",
"description": ""
},
"is_fake_report": {
"type": "string",
"description": ""
},
"uuid": {
"type": "string",
"description": ""
},
"boot_reason": {
"type": "string",
"description": ""
},
"power_on_reason": {
"type": "string",
"description": ""
},
"build_fingerprint": {
"type": "string",
"description": ""
},
"power_off_reason": {
"type": "string",
"description": ""
},
"radio_version": {
"type": "string",
"description": ""
},
"next_logfile_key": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": ""
},
"app_version": {
"type": "string",
"description": ""
},
"device_local_id": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "crashreports_update"
},
"patch": {
"tags": [
"crashreports"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "device__uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"schema": {
"type": "object",
"properties": {
"uptime": {
"type": "string",
"description": ""
},
"is_fake_report": {
"type": "string",
"description": ""
},
"uuid": {
"type": "string",
"description": ""
},
"boot_reason": {
"type": "string",
"description": ""
},
"power_on_reason": {
"type": "string",
"description": ""
},
"build_fingerprint": {
"type": "string",
"description": ""
},
"power_off_reason": {
"type": "string",
"description": ""
},
"radio_version": {
"type": "string",
"description": ""
},
"next_logfile_key": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": ""
},
"app_version": {
"type": "string",
"description": ""
},
"device_local_id": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "crashreports_partial_update"
},
"delete": {
"tags": [
"crashreports"
],
"responses": {
"204": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "device__uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
}
],
"operationId": "crashreports_destroy"
}
},
"/hiccup/api/v1/devices/{uuid}/": {
"get": {
"tags": [
"devices"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"description": "",
"required": false,
"type": "string",
"name": "limit",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "offset",
"in": "query"
}
],
"operationId": "devices_read"
},
"put": {
"tags": [
"devices"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"schema": {
"required": [
"board_date",
"last_heartbeat",
"user"
],
"type": "object",
"properties": {
"board_date": {
"type": "string",
"description": ""
},
"next_per_heartbeat_key": {
"type": "string",
"description": ""
},
"next_per_crashreport_key": {
"type": "string",
"description": ""
},
"token": {
"type": "string",
"description": ""
},
"user": {
"type": "string",
"description": ""
},
"imei": {
"type": "string",
"description": ""
},
"chipset": {
"type": "string",
"description": ""
},
"last_heartbeat": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "devices_update"
},
"patch": {
"tags": [
"devices"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"schema": {
"type": "object",
"properties": {
"board_date": {
"type": "string",
"description": ""
},
"next_per_heartbeat_key": {
"type": "string",
"description": ""
},
"next_per_crashreport_key": {
"type": "string",
"description": ""
},
"token": {
"type": "string",
"description": ""
},
"user": {
"type": "string",
"description": ""
},
"imei": {
"type": "string",
"description": ""
},
"chipset": {
"type": "string",
"description": ""
},
"last_heartbeat": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "devices_partial_update"
},
"delete": {
"tags": [
"devices"
],
"responses": {
"204": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
}
],
"operationId": "devices_destroy"
}
},
"/hiccup/api/v1/devices/{uuid}/crashreports/": {
"post": {
"tags": [
"crashreports"
],
"consumes": [
"application/json"
],
"responses": {
"201": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"schema": {
"required": [
"uuid",
"date",
"app_version",
"uptime",
"build_fingerprint",
"boot_reason",
"power_on_reason",
"power_off_reason"
],
"type": "object",
"properties": {
"uptime": {
"type": "string",
"description": ""
},
"is_fake_report": {
"type": "string",
"description": ""
},
"uuid": {
"type": "string",
"description": ""
},
"boot_reason": {
"type": "string",
"description": ""
},
"power_on_reason": {
"type": "string",
"description": ""
},
"build_fingerprint": {
"type": "string",
"description": ""
},
"power_off_reason": {
"type": "string",
"description": ""
},
"radio_version": {
"type": "string",
"description": ""
},
"next_logfile_key": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": ""
},
"app_version": {
"type": "string",
"description": ""
},
"device_local_id": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "crashreports_create"
}
},
"/hiccup/api/v1/devices/{uuid}/crashreports/{device_local_id}/logfile_put/{filename}/": {
"post": {
"tags": [
"logfile_put"
],
"responses": {
"201": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "filename",
"in": "path"
}
],
"operationId": "logfile_put_create"
}
},
"/hiccup/api/v1/devices/{uuid}/heartbeats/": {
"post": {
"tags": [
"heartbeats"
],
"consumes": [
"application/json"
],
"responses": {
"201": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"schema": {
"required": [
"uuid",
"date",
"app_version",
"uptime",
"build_fingerprint"
],
"type": "object",
"properties": {
"uptime": {
"type": "string",
"description": ""
},
"uuid": {
"type": "string",
"description": ""
},
"build_fingerprint": {
"type": "string",
"description": ""
},
"radio_version": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": ""
},
"app_version": {
"type": "string",
"description": ""
},
"device_local_id": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "heartbeats_create"
}
},
"/hiccup/api/v1/devices/{uuid}/heartbeats/{device_local_id}/": {
"get": {
"tags": [
"heartbeats"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"description": "",
"required": false,
"type": "string",
"name": "limit",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "offset",
"in": "query"
}
],
"operationId": "heartbeats_read"
},
"put": {
"tags": [
"heartbeats"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"schema": {
"required": [
"uuid",
"date",
"app_version",
"uptime",
"build_fingerprint"
],
"type": "object",
"properties": {
"uptime": {
"type": "string",
"description": ""
},
"uuid": {
"type": "string",
"description": ""
},
"build_fingerprint": {
"type": "string",
"description": ""
},
"radio_version": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": ""
},
"app_version": {
"type": "string",
"description": ""
},
"device_local_id": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "heartbeats_update"
},
"patch": {
"tags": [
"heartbeats"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
},
{
"schema": {
"type": "object",
"properties": {
"uptime": {
"type": "string",
"description": ""
},
"uuid": {
"type": "string",
"description": ""
},
"build_fingerprint": {
"type": "string",
"description": ""
},
"radio_version": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": ""
},
"app_version": {
"type": "string",
"description": ""
},
"device_local_id": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "heartbeats_partial_update"
},
"delete": {
"tags": [
"heartbeats"
],
"responses": {
"204": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
},
{
"description": "",
"required": true,
"type": "string",
"name": "device_local_id",
"in": "path"
}
],
"operationId": "heartbeats_destroy"
}
},
"/hiccup/api/v1/logfiles/{pk}/": {
"get": {
"tags": [
"logfiles"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "pk",
"in": "path"
},
{
"description": "",
"required": false,
"type": "string",
"name": "limit",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "offset",
"in": "query"
}
],
"operationId": "logfiles_read"
},
"put": {
"tags": [
"logfiles"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "pk",
"in": "path"
},
{
"schema": {
"required": [
"logfile",
"crashreport"
],
"type": "object",
"properties": {
"logfile": {
"type": "string",
"description": ""
},
"crashreport": {
"type": "string",
"description": ""
},
"crashreport_local_id": {
"type": "string",
"description": ""
},
"logfile_type": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "logfiles_update"
},
"patch": {
"tags": [
"logfiles"
],
"consumes": [
"application/json"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "pk",
"in": "path"
},
{
"schema": {
"type": "object",
"properties": {
"logfile": {
"type": "string",
"description": ""
},
"crashreport": {
"type": "string",
"description": ""
},
"crashreport_local_id": {
"type": "string",
"description": ""
},
"logfile_type": {
"type": "string",
"description": ""
}
}
},
"name": "data",
"in": "body"
}
],
"operationId": "logfiles_partial_update"
},
"delete": {
"tags": [
"logfiles"
],
"responses": {
"204": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "pk",
"in": "path"
}
],
"operationId": "logfiles_destroy"
}
},
"/hiccup/docs/": {
"get": {
"tags": [
"docs"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [],
"operationId": "docs_read"
}
},
"/hiccup_stats/api/v1/device_overview/{uuid}/": {
"get": {
"tags": [
"device_overview"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
}
],
"operationId": "device_overview_read"
}
},
"/hiccup_stats/api/v1/device_report_history/{uuid}/": {
"get": {
"tags": [
"device_report_history"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
}
],
"operationId": "device_report_history_read"
}
},
"/hiccup_stats/api/v1/device_update_history/{uuid}/": {
"get": {
"tags": [
"device_update_history"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "uuid",
"in": "path"
}
],
"operationId": "device_update_history_read"
}
},
"/hiccup_stats/api/v1/logfile_download/{id}/": {
"get": {
"tags": [
"logfile_download"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": true,
"type": "string",
"name": "id",
"in": "path"
}
],
"operationId": "logfile_download_read"
}
},
"/hiccup_stats/api/v1/status/": {
"get": {
"tags": [
"status"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [],
"operationId": "status_read"
}
},
"/hiccup_stats/api/v1/version_daily/": {
"get": {
"tags": [
"version_daily"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": false,
"type": "string",
"name": "limit",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "offset",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "date",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "heartbeats",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "prob_crashes",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "smpl",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "other",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "version",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "date_start",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "date_end",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "version__build_fingerprint",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "version__is_official_release",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "version__is_beta_release",
"in": "query"
}
],
"operationId": "version_daily_read"
}
},
"/hiccup_stats/api/v1/versions/": {
"get": {
"tags": [
"versions"
],
"responses": {
"200": {
"description": ""
}
},
"parameters": [
{
"description": "",
"required": false,
"type": "string",
"name": "limit",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "offset",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "is_official_release",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "is_beta_release",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "first_seen_on",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "released_on",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "heartbeats",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "prob_crashes",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "smpl",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "other",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "build_fingerprint",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "first_seen_before",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "first_seen_after",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "released_before",
"in": "query"
},
{
"description": "",
"required": false,
"type": "string",
"name": "released_after",
"in": "query"
}
],
"operationId": "versions_read"
}
}
},
"securityDefinitions": {
"basic": {
"type": "basic"
}
}
}