mirror of
https://github.com/mainflux/mainflux.git
synced 2025-05-11 19:29:16 +08:00
dfa6d8ba0d
* Fix authn swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Fix certs swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Fix http swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Fix provision swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Fix readers swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Fix things swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Fix users swagger Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Add missing description strings and improve naming in definitions Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com>
117 lines
3.1 KiB
YAML
117 lines
3.1 KiB
YAML
swagger: "2.0"
|
|
info:
|
|
title: Mainflux http adapter
|
|
description: HTTP API for sending messages through communication channels.
|
|
version: "1.0.0"
|
|
paths:
|
|
/channels/{id}/messages:
|
|
post:
|
|
summary: Sends message to the communication channel
|
|
description: |
|
|
Sends message to the communication channel. Messages can be sent as
|
|
JSON formatted SenML or as blob.
|
|
tags:
|
|
- messages
|
|
consumes:
|
|
- "application/senml+json"
|
|
- "text/plain"
|
|
produces: []
|
|
parameters:
|
|
- name: Authorization
|
|
description: Access token.
|
|
in: header
|
|
type: string
|
|
required: true
|
|
- name: id
|
|
description: Unique channel identifier.
|
|
in: path
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
- name: message
|
|
description: |
|
|
Message to be distributed. Since the platform expects messages to be
|
|
properly formatted SenML in order to be post-processed, clients are
|
|
obliged to specify Content-Type header for each published message.
|
|
Note that all messages that aren't SenML will be accepted and published,
|
|
but no post-processing will be applied.
|
|
in: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/SenMLArray'
|
|
responses:
|
|
202:
|
|
description: Message is accepted for processing.
|
|
400:
|
|
description: Message discarded due to its malformed content.
|
|
403:
|
|
description: Message discarded due to missing or invalid credentials.
|
|
404:
|
|
description: Message discarded due to invalid channel id.
|
|
415:
|
|
description: Message discarded due to invalid or missing content type.
|
|
500:
|
|
description: Unexpected server-side error occurred.
|
|
definitions:
|
|
SenMLRecord:
|
|
type: object
|
|
properties:
|
|
bn:
|
|
type: string
|
|
description: Base Name
|
|
bt:
|
|
type: number
|
|
format: double
|
|
description: Base Time
|
|
bu:
|
|
type: number
|
|
format: double
|
|
description: Base Unit
|
|
bv:
|
|
type: number
|
|
format: double
|
|
description: Base Value
|
|
bs:
|
|
type: number
|
|
format: double
|
|
description: Base Sum
|
|
bver:
|
|
type: number
|
|
format: double
|
|
description: Version
|
|
n:
|
|
type: string
|
|
description: Name
|
|
u:
|
|
type: string
|
|
description: Unit
|
|
v:
|
|
type: number
|
|
format: double
|
|
description: Value
|
|
vs:
|
|
type: string
|
|
description: String Value
|
|
vb:
|
|
type: boolean
|
|
description: Boolean Value
|
|
vd:
|
|
type: string
|
|
description: Data Value
|
|
s:
|
|
type: number
|
|
format: double
|
|
description: Value Sum
|
|
t:
|
|
type: number
|
|
format: double
|
|
description: Time
|
|
ut:
|
|
type: number
|
|
format: double
|
|
description: Update Time
|
|
SenMLArray:
|
|
type: array
|
|
items:
|
|
$ref: "#/definitions/SenMLRecord"
|