mirror of
https://github.com/mainflux/mainflux.git
synced 2025-05-11 19:29:16 +08:00
9864b27271
* Add req body to token req Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Shorten summaries and add/remove keys Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com> * Add single quotes to html response codes Signed-off-by: Darko Draskovic <darko.draskovic@gmail.com>
137 lines
3.9 KiB
YAML
137 lines
3.9 KiB
YAML
openapi: 3.0.1
|
|
info:
|
|
title: Mainflux reader service
|
|
description: HTTP API for reading messages.
|
|
version: "1.0.0"
|
|
|
|
paths:
|
|
/channels/{chanId}/messages:
|
|
get:
|
|
summary: Retrieves messages sent to single channel
|
|
description: |
|
|
Retrieves a list of messages sent to specific channel. Due to
|
|
performance concerns, data is retrieved in subsets. The API readers must
|
|
ensure that the entire dataset is consumed either by making subsequent
|
|
requests, or by increasing the subset size of the initial request.
|
|
tags:
|
|
- messages
|
|
parameters:
|
|
- $ref: "#/components/parameters/Authorization"
|
|
- $ref: "#/components/parameters/Limit"
|
|
- $ref: "#/components/parameters/Offset"
|
|
- $ref: "#/components/parameters/ChanId"
|
|
responses:
|
|
'200':
|
|
$ref: "#/components/responses/MessagesPageRes"
|
|
'400':
|
|
description: Failed due to malformed query parameters.
|
|
'403':
|
|
description: Missing or invalid access token provided.
|
|
'500':
|
|
$ref: "#/components/responses/ServiceError"
|
|
|
|
components:
|
|
schemas:
|
|
MessagesPage:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
description: Total number of items that are present on the system.
|
|
offset:
|
|
type: number
|
|
description: Number of items that were skipped during retrieval.
|
|
limit:
|
|
type: number
|
|
description: Size of the subset that was retrieved.
|
|
messages:
|
|
type: array
|
|
minItems: 0
|
|
uniqueItems: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
channel:
|
|
type: integer
|
|
description: Unique channel id.
|
|
publisher:
|
|
type: integer
|
|
description: Unique publisher id.
|
|
protocol:
|
|
type: string
|
|
description: Protocol name.
|
|
name:
|
|
type: string
|
|
description: Measured parameter name.
|
|
unit:
|
|
type: string
|
|
description: Value unit.
|
|
value:
|
|
type: number
|
|
description: Measured value in number.
|
|
stringValue:
|
|
type: string
|
|
description: Measured value in string format.
|
|
boolValue:
|
|
type: boolean
|
|
description: Measured value in boolean format.
|
|
dataValue:
|
|
type: string
|
|
description: Measured value in binary format.
|
|
valueSum:
|
|
type: number
|
|
description: Sum value.
|
|
time:
|
|
type: number
|
|
description: Time of measurement.
|
|
updateTime:
|
|
type: number
|
|
description: Time of updating measurement.
|
|
|
|
parameters:
|
|
Authorization:
|
|
name: Authorization
|
|
description: Thing access token.
|
|
in: header
|
|
schema:
|
|
type: string
|
|
required: true
|
|
ChanId:
|
|
name: chanId
|
|
description: Unique channel identifier.
|
|
in: path
|
|
schema:
|
|
type: integer
|
|
minimum: 1
|
|
required: true
|
|
Limit:
|
|
name: limit
|
|
description: Size of the subset to retrieve.
|
|
in: query
|
|
schema:
|
|
type: integer
|
|
default: 10
|
|
maximum: 100
|
|
minimum: 1
|
|
required: false
|
|
Offset:
|
|
name: offset
|
|
description: Number of items to skip during retrieval.
|
|
in: query
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
minimum: 0
|
|
required: false
|
|
|
|
responses:
|
|
MessagesPageRes:
|
|
description: Data retrieved.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/MessagesPage"
|
|
|
|
ServiceError:
|
|
description: Unexpected server-side error occurred.
|