Skip to content

Commit

Permalink
linter run
Browse files Browse the repository at this point in the history
Signed-off-by: Musilah <[email protected]>
  • Loading branch information
Musilah committed Mar 22, 2024
1 parent afe81c7 commit c9649be
Show file tree
Hide file tree
Showing 31 changed files with 456 additions and 476 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check-generated-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
with:
go-version: 1.21.x
cache-dependency-path: "go.sum"

- name: Check for changes in go.mod
run: |
go mod tidy
Expand Down
9 changes: 4 additions & 5 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To accomplish this, we created a public ledger. The list of organizations and us
Where users themselves directly maintain the list.

## Adding yourself as an adopter

If you are using Magistrala, please consider adding yourself as an adopter with a brief description of your use case by opening a pull request to this file and adding a section describing your adoption of Magistrala technology.

**Please send PRs to add or remove organizations/users**
Expand All @@ -20,17 +21,15 @@ T: Type of adaptation: Evaluation, Core Technology, Production Usage (optional)
```

## Requirements
* You must represent the user or organization listed. Do NOT add entries on behalf of other organizations or individuals.
Pull request commit must be [signed](https://docs.github.com/en/github/authenticating-to-github/signing-commits) and auto-checked with [ Developer Certificate of Origin (DCO)](https://probot.github.io/apps/dco/)
* There is no minimum requirement or adaptation size, but we request to list permanent deployments only, i.e., no demo or trial deployments. Commercial or production use is not required. A well-done home lab setup can be equally impressive as a large-scale commercial deployment.

- You must represent the user or organization listed. Do NOT add entries on behalf of other organizations or individuals.
Pull request commit must be [signed](https://docs.github.com/en/github/authenticating-to-github/signing-commits) and auto-checked with [ Developer Certificate of Origin (DCO)](https://probot.github.io/apps/dco/)
- There is no minimum requirement or adaptation size, but we request to list permanent deployments only, i.e., no demo or trial deployments. Commercial or production use is not required. A well-done home lab setup can be equally impressive as a large-scale commercial deployment.

**The list of organizations/users that have publicly shared the usage of Magistrala:**

**Note**: Several other organizations/users couldn't publicly share their usage details but are active project contributors and Magistrala Community members.


## Adopters list (alphabetical)


**Note:** The list is maintained by the users themselves. If you find yourself on this list, and you think it's inappropriate. Please contact [project maintainers](https://github.com/absmach/magistrala/blob/master/MAINTAINERS) and you will be permanently removed from the list.
41 changes: 20 additions & 21 deletions api/asyncapi/mqtt.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Copyright (c) Abstract Machines
# SPDX-License-Identifier: Apache-2.0

asyncapi: '2.6.0'
id: 'https://github.com/absmach/magistrala/blob/master/api/asyncapi/mqtt.yml'
asyncapi: "2.6.0"
id: "https://github.com/absmach/magistrala/blob/master/api/asyncapi/mqtt.yml"
info:
title: Magistrala MQTT Adapter
version: '1.0.0'
version: "1.0.0"
contact:
name: Magistrala Team
url: 'https://github.com/absmach/magistrala'
url: "https://github.com/absmach/magistrala"
email: [email protected]
description: |
MQTT adapter provides an MQTT API for sending messages through the platform. MQTT adapter uses [mProxy](https://github.com/absmach/mproxy) for proxying traffic between client and MQTT broker.
Additionally, the MQTT adapter and the message broker are replicating the traffic between brokers.
license:
name: Apache 2.0
url: 'https://github.com/absmach/magistrala/blob/master/LICENSE'


url: "https://github.com/absmach/magistrala/blob/master/LICENSE"

defaultContentType: application/json

servers:
Expand All @@ -29,35 +28,35 @@ servers:
variables:
port:
description: Secure connection (TLS) is available through port 8883.
default: '1883'
default: "1883"
enum:
- '1883'
- '8883'
security:
- "1883"
- "8883"
security:
- user-password: []

channels:
channels/{channelID}/messages/{subtopic}:
parameters:
channelID:
$ref: '#/components/parameters/channelID'
$ref: "#/components/parameters/channelID"
in: path
required: true
subtopic:
$ref: '#/components/parameters/subtopic'
in: path
$ref: "#/components/parameters/subtopic"
in: path
required: false

publish:
traits:
- $ref: '#/components/operationTraits/mqtt'
- $ref: "#/components/operationTraits/mqtt"
message:
$ref: '#/components/messages/jsonMsg'
$ref: "#/components/messages/jsonMsg"
subscribe:
traits:
- $ref: '#/components/operationTraits/mqtt'
- $ref: "#/components/operationTraits/mqtt"
message:
$ref: '#/components/messages/jsonMsg'
$ref: "#/components/messages/jsonMsg"

components:
messages:
Expand Down Expand Up @@ -96,14 +95,14 @@ components:
description: Arbitrary message subtopic.
schema:
type: string
default: ''
default: ""

securitySchemes:
user-password:
type: userPassword
description: |
username is thing ID connected to the channel defined in the mqtt topic and
password is thing key corresponding to the thing ID
password is thing key corresponding to the thing ID
operationTraits:
mqtt:
Expand Down
30 changes: 15 additions & 15 deletions api/asyncapi/websocket.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
# SPDX-License-Identifier: Apache-2.0

asyncapi: 2.6.0
id: 'https://github.com/absmach/magistrala/blob/master/api/asyncapi/websocket.yml'
id: "https://github.com/absmach/magistrala/blob/master/api/asyncapi/websocket.yml"
info:
title: Magistrala WebSocket adapter
description: WebSocket adapter provides a WebSocket API for sending messages through communication channels. WebSocket adapter uses [mProxy](https://github.com/absmach/mproxy) for proxying traffic between client and MQTT broker.
version: '1.0.0'
version: "1.0.0"
contact:
name: Magistrala Team
url: 'https://github.com/absmach/magistrala'
url: "https://github.com/absmach/magistrala"
email: [email protected]
license:
name: Apache 2.0
url: 'https://github.com/absmach/magistrala/blob/master/LICENSE'
url: "https://github.com/absmach/magistrala/blob/master/LICENSE"
tags:
- name: WebSocket
defaultContentType: application/json

servers:
dev:
url: 'ws://{host}:{port}'
url: "ws://{host}:{port}"
protocol: ws
description: Default WebSocket Adapter URL
variables:
Expand All @@ -29,43 +29,43 @@ servers:
default: localhost
port:
description: Magistrala WebSocket Adapter port
default: '8186'
default: "8186"

channels:
'channels/{channelID}/messages/{subtopic}':
"channels/{channelID}/messages/{subtopic}":
parameters:
channelID:
$ref: '#/components/parameters/channelID'
$ref: "#/components/parameters/channelID"
in: path
required: true
subtopic:
$ref: '#/components/parameters/subtopic'
$ref: "#/components/parameters/subtopic"
in: path
required: false
publish:
summary: Publish messages to a channel
operationId: publishToChannel
message:
$ref: '#/components/messages/jsonMsg'
$ref: "#/components/messages/jsonMsg"
messageId: publishMessage
bindings:
ws:
method: POST
query:
subtopic: '{$request.query.subtopic}'
subtopic: "{$request.query.subtopic}"
security:
- bearerAuth: []
subscribe:
summary: Subscribe to receive messages from a channel
operationId: subscribeToChannel
message:
$ref: '#/components/messages/jsonMsg'
$ref: "#/components/messages/jsonMsg"
messageId: subscribeMessage
bindings:
ws:
method: GET
query:
subtopic: '{$request.query.subtopic}'
subtopic: "{$request.query.subtopic}"
security:
- bearerAuth: []
/version:
Expand All @@ -92,7 +92,7 @@ components:
summary: Arbitrary JSON array or object.
contentType: application/json
payload:
$ref: '#/components/schemas/jsonMsg'
$ref: "#/components/schemas/jsonMsg"
schemas:
jsonMsg:
type: object
Expand Down Expand Up @@ -134,7 +134,7 @@ components:
description: Arbitrary message subtopic.
schema:
type: string
default: ''
default: ""
securitySchemes:
bearerAuth:
type: http
Expand Down
2 changes: 1 addition & 1 deletion api/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This folder contains an OpenAPI specifications for Magistrala API.

View specification in Swagger UI at [api.mainflux.io](https://api.mainflux.io)
View specification in Swagger UI at [api.mainflux.io](https://api.mainflux.io)
11 changes: 10 additions & 1 deletion api/openapi/auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ paths:
dataset is consumed either by making subsequent requests, or by
increasing the subset size of the initial request.
parameters:
- $ref: "users.yml#/components/parameters/MemberID"
- $ref: "#/components/parameters/MemberID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Metadata"
Expand Down Expand Up @@ -797,6 +797,15 @@ components:
schema:
type: string
required: false
MemberID:
name: memberID
description: Unique member identifier.
in: path
schema:
type: string
format: uuid
required: true
example: bb7edb32-2eac-4aad-aebe-ed96fe073879

requestBodies:
DomainCreateReq:
Expand Down
Loading

0 comments on commit c9649be

Please sign in to comment.