Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MF-549 - Rename Profile to Config and Channel to Profile #550

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
12 changes: 6 additions & 6 deletions api/asyncapi/mqtt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ servers:
- '1883'
- '8883'
username:
description: Thing ID connected to the channel defined in the MQTT topic.
description: Thing ID connected to the profile defined in the MQTT topic.
password:
description: Thing Key corresponding to the Thing ID.

channels:
channels/{channelId}/messages/{subtopic}:
profiles/{profileId}/messages/{subtopic}:
parameters:
channelId:
$ref: '#/components/parameters/channelId'
profileId:
$ref: '#/components/parameters/profileId'
subtopic:
$ref: '#/components/parameters/subtopic'
publish:
Expand Down Expand Up @@ -74,8 +74,8 @@ components:
```

parameters:
channelId:
description: Channel ID connected to the Thing ID defined in the username.
profileId:
description: Profile ID connected to the Thing ID defined in the username.
schema:
type: string
format: uuid
Expand Down
12 changes: 6 additions & 6 deletions api/openapi/http.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
openapi: 3.0.1
info:
title: Mainflux http adapter
description: HTTP API for sending messages through communication channels.
description: HTTP API for sending messages through communication profiles.
version: "1.0.0"
paths:
/channels/{id}/messages:
/profiles/{id}/messages:
post:
summary: Sends message to the communication channel
summary: Sends message
description: |
Sends message to the communication channel. Messages can be sent as
Sends message. Messages can be sent as
JSON formatted SenML or as blob.
tags:
- messages
Expand All @@ -24,7 +24,7 @@ paths:
"401":
description: Missing or invalid access token provided.
"404":
description: Message discarded due to invalid channel id.
description: Message discarded due to invalid profile id.
"415":
description: Message discarded due to invalid or missing content type.
'500':
Expand Down Expand Up @@ -107,7 +107,7 @@ components:
parameters:
ID:
name: id
description: Unique channel identifier.
description: Unique profile identifier.
in: path
schema:
type: string
Expand Down
18 changes: 9 additions & 9 deletions api/openapi/readers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ info:
version: "1.0.0"

paths:
/channels/{chanId}/messages:
/profiles/{profileId}/messages:
get:
summary: Retrieves messages sent to single channel
summary: Retrieves messages sent to single profile
description: |
Retrieves a list of messages sent to specific channel. Due to
Retrieves a list of messages sent to specific profile. 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/ChanId"
- $ref: "#/components/parameters/ProfileId"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Name"
Expand Down Expand Up @@ -67,9 +67,9 @@ components:
items:
type: object
properties:
channel:
profile:
type: integer
description: Unique channel id.
description: Unique profile id.
protocol:
type: string
description: Protocol name.
Expand Down Expand Up @@ -102,9 +102,9 @@ components:
description: Time of updating measurement.

parameters:
ChanId:
name: chanId
description: Unique channel identifier.
ProfileId:
name: profileId
description: Unique profile identifier.
in: path
schema:
type: string
Expand Down
Loading
Loading