2020-10-09 15:25:09 +02:00
|
|
|
openapi: 3.0.1
|
|
|
|
|
info:
|
|
|
|
|
title: Mainflux Provision service
|
|
|
|
|
description: HTTP API for Provision service
|
|
|
|
|
version: "1.0.0"
|
|
|
|
|
|
|
|
|
|
paths:
|
|
|
|
|
/mapping:
|
|
|
|
|
post:
|
|
|
|
|
summary: Adds new device to proxy
|
|
|
|
|
description: Adds new device to proxy
|
|
|
|
|
tags:
|
|
|
|
|
- provision
|
|
|
|
|
parameters:
|
|
|
|
|
- $ref: "#/components/parameters/Authorization"
|
|
|
|
|
requestBody:
|
|
|
|
|
$ref: "#/components/requestBodies/ProvisionReq"
|
|
|
|
|
responses:
|
2020-12-15 00:20:42 +01:00
|
|
|
'201':
|
2020-10-09 15:25:09 +02:00
|
|
|
description: Created
|
2020-12-15 00:20:42 +01:00
|
|
|
'400':
|
2020-10-09 15:25:09 +02:00
|
|
|
description: Failed due to malformed JSON.
|
2020-12-15 00:20:42 +01:00
|
|
|
'403':
|
2020-10-09 15:25:09 +02:00
|
|
|
description: Unauthorized.
|
2020-12-15 00:20:42 +01:00
|
|
|
'500':
|
2020-10-09 15:25:09 +02:00
|
|
|
description: Unexpected server-side error ocurred.
|
|
|
|
|
get:
|
|
|
|
|
summary: Gets current mapping.
|
|
|
|
|
description: Gets current mapping. This can be used in UI
|
|
|
|
|
so that when bootstrap config is created from UI matches
|
|
|
|
|
configuration created with provision service.
|
|
|
|
|
tags:
|
|
|
|
|
- provision
|
|
|
|
|
parameters:
|
|
|
|
|
- $ref: "#/components/parameters/Authorization"
|
|
|
|
|
responses:
|
2020-12-15 00:20:42 +01:00
|
|
|
'200':
|
2020-10-09 15:25:09 +02:00
|
|
|
$ref: "#/components/responses/ProvisionRes"
|
2020-12-15 00:20:42 +01:00
|
|
|
'403':
|
2020-10-09 15:25:09 +02:00
|
|
|
description: Unauthorized.
|
2020-12-15 00:20:42 +01:00
|
|
|
'500':
|
2020-10-09 15:25:09 +02:00
|
|
|
description: Unexpected server-side error ocurred.
|
|
|
|
|
|
|
|
|
|
components:
|
|
|
|
|
|
|
|
|
|
parameters:
|
|
|
|
|
Authorization:
|
|
|
|
|
name: Authorization
|
|
|
|
|
description: User's access token. Used instead of credentials in env or config.toml.
|
|
|
|
|
in: header
|
|
|
|
|
schema:
|
|
|
|
|
type: string
|
2021-01-27 11:42:55 +01:00
|
|
|
format: jwt
|
2020-10-09 15:25:09 +02:00
|
|
|
required: false
|
|
|
|
|
|
|
|
|
|
requestBodies:
|
|
|
|
|
ProvisionReq:
|
|
|
|
|
description: MAC address of device or other identifier
|
|
|
|
|
content:
|
|
|
|
|
application/json:
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
|
|
|
|
required:
|
|
|
|
|
- external_id
|
|
|
|
|
- external_key
|
|
|
|
|
properties:
|
|
|
|
|
external_id:
|
|
|
|
|
type: string
|
|
|
|
|
external_key:
|
|
|
|
|
type: string
|
|
|
|
|
name:
|
|
|
|
|
type: string
|
|
|
|
|
|
|
|
|
|
responses:
|
|
|
|
|
ProvisionRes:
|
|
|
|
|
description: Current mapping JSON representation.
|
|
|
|
|
content:
|
|
|
|
|
application/json:
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
