opensource/magistrala
1
0
Fork 0
mirror of https://github.com/absmach/magistrala.git synced 2026-06-23 04:10:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

NOISSUE - Rename YAML files extension (#2782)

Browse Source 
Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>
This commit is contained in:
Dušan Borovčanin
2025-03-31 10:51:43 +02:00
committed by GitHub
parent 878860d249
commit e56b86823e
48 changed files with 244 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug_report.yml → .github/ISSUE_TEMPLATE/bug_report.yaml
View File
.github/ISSUE_TEMPLATE/config.yml → .github/ISSUE_TEMPLATE/config.yaml
View File
.github/ISSUE_TEMPLATE/feature_request.yml → .github/ISSUE_TEMPLATE/feature_request.yaml
View File
.github/dependabot.yml → .github/dependabot.yaml
View File
.github/workflows/api-tests.yml → .github/workflows/api-tests.yaml
+28 -28
View File
@@ -8,7 +8,7 @@ on:
branches:
- main
paths:
- ".github/workflows/api-tests.yml"
- ".github/workflows/api-tests.yaml"
- "api/**"
- "auth/api/http/**"
- "certs/api/**"
@@ -69,55 +69,55 @@ jobs:
with:
filters: |
journal:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/journal.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/journal.yaml"
- "journal/api/**"
auth:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/auth.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/auth.yaml"
- "auth/api/http/**"
certs:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/certs.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/certs.yaml"
- "certs/api/**"
domains:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/domains.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/domains.yaml"
- "domains/api/http/**"
http:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/http.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/http.yaml"
- "http/api/**"
clients:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/clients.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/clients.yaml"
- "clients/api/http/**"
channels:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/channels.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/channels.yaml"
- "channels/api/http/**"
groups:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/groups.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/groups.yaml"
- "groups/api/http/**"
users:
- ".github/workflows/api-tests.yml"
- "apidocs/openapi/users.yml"
- ".github/workflows/api-tests.yaml"
- "apidocs/openapi/users.yaml"
- "users/api/**"
- name: Run Users API tests
if: steps.changes.outputs.users == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/users.yml
schema: apidocs/openapi/users.yaml
base-url: ${{ env.USERS_URL }}
checks: all
report: false
@@ -127,7 +127,7 @@ jobs:
if: steps.changes.outputs.groups == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/groups.yml
schema: apidocs/openapi/groups.yaml
base-url: ${{ env.GROUPS_URL }}
checks: all
report: false
@@ -137,7 +137,7 @@ jobs:
if: steps.changes.outputs.clients == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/clients.yml
schema: apidocs/openapi/clients.yaml
base-url: ${{ env.CLIENTS_URL }}
checks: all
report: false
@@ -147,7 +147,7 @@ jobs:
if: steps.changes.outputs.channels == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/channels.yml
schema: apidocs/openapi/channels.yaml
base-url: ${{ env.CHANNELS_URL }}
checks: all
report: false
@@ -157,7 +157,7 @@ jobs:
if: steps.changes.outputs.http == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/http.yml
schema: apidocs/openapi/http.yaml
base-url: ${{ env.HTTP_ADAPTER_URL }}
checks: all
report: false
@@ -167,7 +167,7 @@ jobs:
if: steps.changes.outputs.auth == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/auth.yml
schema: apidocs/openapi/auth.yaml
base-url: ${{ env.AUTH_URL }}
checks: all
report: false
@@ -177,7 +177,7 @@ jobs:
if: steps.changes.outputs.domains == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/domains.yml
schema: apidocs/openapi/domains.yaml
base-url: ${{ env.DOMAIN_URL }}
checks: all
report: false
@@ -187,7 +187,7 @@ jobs:
if: steps.changes.outputs.journal == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/journal.yml
schema: apidocs/openapi/journal.yaml
base-url: ${{ env.JOURNAL_URL }}
checks: all
report: false
@@ -197,7 +197,7 @@ jobs:
if: steps.changes.outputs.certs == 'true'
uses: schemathesis/action@v1
with:
schema: apidocs/openapi/certs.yml
schema: apidocs/openapi/certs.yaml
base-url: ${{ env.CERTS_URL }}
checks: all
report: false
.github/workflows/build.yml → .github/workflows/build.yaml
+1 -1
View File
@@ -36,7 +36,7 @@ jobs:
with:
token: ${{ secrets.CODECOV }}
files: ./coverage/*.out
codecov_yml_path: tools/config/codecov.yml
codecov_yml_path: tools/config/.codecov.yaml
verbose: true
- name: Set up Docker Build
.github/workflows/check-generated-files.yml → .github/workflows/check-generated-files.yaml
+2 -2
View File
@@ -36,14 +36,14 @@ jobs:
base: main
filters: |
proto:
- ".github/workflows/check-generated-files.yml"
- ".github/workflows/check-generated-files.yaml"
- "auth.proto"
- "auth/*.pb.go"
- "pkg/messaging/message.proto"
- "pkg/messaging/*.pb.go"
mocks:
- ".github/workflows/check-generated-files.yml"
- ".github/workflows/check-generated-files.yaml"
- "pkg/sdk/sdk.go"
- "users/postgres/clients.go"
- "users/clients.go"
.github/workflows/swagger-ui.yaml
+1 -1
View File
@@ -20,7 +20,7 @@ jobs:
uses: blokovi/swagger-ui-action@main
with:
dir: "./api/openapi"
pattern: "*.yml"
pattern: "*.yaml"
debug: "true"
- name: Deploy to GitHub Pages
.github/workflows/tests.yml → .github/workflows/tests.yaml
+3 -3
View File
@@ -35,7 +35,7 @@ jobs:
uses: golangci/golangci-lint-action@v6
with:
version: v1.60.3
args: --config ./tools/config/golangci.yml
args: --config ./tools/config/.golangci.yaml
- name: Build all Binaries
run: |
@@ -73,7 +73,7 @@ jobs:
base: main
filters: |
workflow:
- ".github/workflows/tests.yml"
- ".github/workflows/tests.yaml"
auth:
- "auth/**"
@@ -364,5 +364,5 @@ jobs:
with:
token: ${{ secrets.CODECOV }}
files: ./coverage/*.out
codecov_yml_path: tools/config/codecov.yml
codecov_yml_path: tools/config/.codecov.yaml
verbose: true
Makefile
+9 -9
View File
@@ -13,11 +13,11 @@ GOARCH ?= amd64
VERSION ?= $(shell git describe --abbrev=0 --tags 2>/dev/null || echo 'unknown')
COMMIT ?= $(shell git rev-parse HEAD)
TIME ?= $(shell date +%F_%T)
USER_REPO ?= $(shell git remote get-url origin | sed -e 's/.*\/\([^/]*\)\/\([^/]*\).*/\1_\2/' )
USER_REPO ?= $(shell git remote get-url origin | sed -E 's#.*[:/]([^/:]+)/([^/.]+)(\.git)?#\1_\2#')
empty:=
space:= $(empty) $(empty)
# Docker compose project name should follow this guidelines: https://docs.docker.com/compose/reference/#use--p-to-specify-a-project-name
DOCKER_PROJECT ?= $(shell echo $(subst $(space),,$(USER_REPO)) | tr -c -s '[:alnum:][=-=]' '_' | tr '[:upper:]' '[:lower:]')
DOCKER_PROJECT ?= $(shell echo $(subst $(space),,$(USER_REPO)) | sed -E 's/[^a-zA-Z0-9]/_/g' | tr '[:upper:]' '[:lower:]')
DOCKER_COMPOSE_COMMANDS_SUPPORTED := up down config restart
DEFAULT_DOCKER_COMPOSE_COMMAND := up
GRPC_MTLS_CERT_FILES_EXISTS = 0
@@ -105,7 +105,7 @@ clean:
cleandocker:
# Stops containers and removes containers, networks, volumes, and images created by up
docker compose -f docker/docker-compose.yml -p $(DOCKER_PROJECT) down --rmi all -v --remove-orphans
docker compose -f docker/docker-compose.yaml -p $(DOCKER_PROJECT) down --rmi all -v --remove-orphans
ifdef pv
# Remove unused volumes
@@ -120,7 +120,7 @@ install:
mocks:
@which mockery > /dev/null || go install github.com/vektra/mockery/v2@$(MOCKERY_VERSION)
@unset MOCKERY_VERSION && go generate ./...
mockery --config ./tools/config/mockery.yaml
mockery --config ./tools/config/.mockery.yaml
DIRS = consumers readers postgres internal
@@ -148,7 +148,7 @@ define test_api_service
fi
@if [ "$(svc)" = "http" ]; then \
st run api/openapi/$(svc).yml \
st run api/openapi/$(svc).yaml \
--checks all \
--base-url $(2) \
--header "Authorization: Client $(CLIENT_SECRET)" \
@@ -156,7 +156,7 @@ define test_api_service
--hypothesis-suppress-health-check=filter_too_much \
--stateful=links; \
else \
st run api/openapi/$(svc).yml \
st run api/openapi/$(svc).yaml \
--checks all \
--base-url $(2) \
--header "Authorization: Bearer $(USER_TOKEN)" \
@@ -253,13 +253,13 @@ endif
endif
run: check_certs
docker compose -f docker/docker-compose.yml --env-file docker/.env -p $(DOCKER_PROJECT) $(DOCKER_COMPOSE_COMMAND) $(args)
docker compose -f docker/docker-compose.yaml --env-file docker/.env -p $(DOCKER_PROJECT) $(DOCKER_COMPOSE_COMMAND) $(args)
run_addons: check_certs
$(foreach SVC,$(RUN_ADDON_ARGS),$(if $(filter $(SVC),$(ADDON_SERVICES) $(EXTERNAL_SERVICES)),,$(error Invalid Service $(SVC))))
@for SVC in $(RUN_ADDON_ARGS); do \
SMQ_ADDONS_CERTS_PATH_PREFIX="../." docker compose -f docker/addons/$$SVC/docker-compose.yml -p $(DOCKER_PROJECT) --env-file ./docker/.env $(DOCKER_COMPOSE_COMMAND) $(args) & \
SMQ_ADDONS_CERTS_PATH_PREFIX="../." docker compose -f docker/addons/$$SVC/docker-compose.yaml -p $(DOCKER_PROJECT) --env-file ./docker/.env $(DOCKER_COMPOSE_COMMAND) $(args) & \
done
run_live: check_certs
GOPATH=$(go env GOPATH) docker compose -f docker/docker-compose.yml -f docker/docker-compose-live.yaml --env-file docker/.env -p $(DOCKER_PROJECT) $(DOCKER_COMPOSE_COMMAND) $(args)
GOPATH=$(go env GOPATH) docker compose -f docker/docker-compose.yaml -f docker/docker-compose-live.yaml --env-file docker/.env -p $(DOCKER_PROJECT) $(DOCKER_COMPOSE_COMMAND) $(args)
README.md
+3 -3
View File
@@ -6,9 +6,9 @@
**Made with ❤️ by [Abstract Machines](https://abstractmachines.fr/)**
[![Build Status](https://github.com/absmach/supermq/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/absmach/supermq/actions/workflows/build.yml)
[![Build Status](https://github.com/absmach/supermq/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/absmach/supermq/actions/workflows/build.yaml)
[![Check License Header](https://github.com/absmach/supermq/actions/workflows/check-license.yaml/badge.svg?branch=main)](https://github.com/absmach/supermq/actions/workflows/check-license.yaml)
[![Check Generated Files](https://github.com/absmach/supermq/actions/workflows/check-generated-files.yml/badge.svg?branch=main)](https://github.com/absmach/supermq/actions/workflows/check-generated-files.yml)
[![Check Generated Files](https://github.com/absmach/supermq/actions/workflows/check-generated-files.yaml/badge.svg?branch=main)](https://github.com/absmach/supermq/actions/workflows/check-generated-files.yaml)
[![Go Report Card](https://goreportcard.com/badge/github.com/absmach/supermq)](https://goreportcard.com/report/github.com/absmach/supermq)
[![Coverage](https://codecov.io/gh/absmach/supermq/graph/badge.svg?token=nPCEr5nW8S)](https://codecov.io/gh/absmach/supermq)
[![License](https://img.shields.io/badge/license-Apache%20v2.0-blue.svg)](LICENSE)
@@ -51,7 +51,7 @@ Clone the repository and start SuperMQ services:
```bash
git clone https://github.com/absmach/supermq.git
cd supermq
docker compose -f docker/docker-compose.yml --env-file docker/.env up
docker compose -f docker/docker-compose.yaml --env-file docker/.env up
```
Or use the [Makefile](Makefile) for a simpler command:
apidocs/asyncapi/mqtt.yml → apidocs/asyncapi/mqtt.yaml
+1 -1
View File
@@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
asyncapi: '2.6.0'
id: 'https://github.com/absmach/supermq/blob/main/api/asyncapi/mqtt.yml'
id: 'https://github.com/absmach/supermq/blob/main/api/asyncapi/mqtt.yaml'
info:
title: SuperMQ MQTT Adapter
version: '1.0.0'
apidocs/asyncapi/websocket.yml → apidocs/asyncapi/websocket.yaml
+1 -1
View File
@@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
asyncapi: 2.6.0
id: 'https://github.com/absmach/supermq/blob/main/api/asyncapi/websocket.yml'
id: 'https://github.com/absmach/supermq/blob/main/api/asyncapi/websocket.yaml'
info:
title: SuperMQ 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.
apidocs/openapi/auth.yml → apidocs/openapi/auth.yaml
+1 -1
View File
@@ -824,7 +824,7 @@ components:
content:
application/health+json:
schema:
$ref: "./schemas/health_info.yml"
$ref: "./schemas/health_info.yaml"
securitySchemes:
bearerAuth:
apidocs/openapi/certs.yml → apidocs/openapi/certs.yaml
+5 -5
View File
@@ -35,7 +35,7 @@ paths:
tags:
- certs
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
requestBody:
$ref: "#/components/requestBodies/CertReq"
responses:
@@ -63,7 +63,7 @@ paths:
tags:
- certs
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/CertID"
responses:
"200":
@@ -89,7 +89,7 @@ paths:
tags:
- certs
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/CertID"
responses:
"200":
@@ -117,7 +117,7 @@ paths:
tags:
- certs
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/ClientID"
responses:
"200":
@@ -302,7 +302,7 @@ components:
content:
application/health+json:
schema:
$ref: "./schemas/health_info.yml"
$ref: "./schemas/health_info.yaml"
securitySchemes:
bearerAuth:
apidocs/openapi/channels.yml → apidocs/openapi/channels.yaml
+15 -15
View File
@@ -50,7 +50,7 @@ paths:
security:
- bearerAuth: []
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
responses:
"201":
$ref: "#/components/responses/ChannelCreateRes"
@@ -84,7 +84,7 @@ paths:
security:
- bearerAuth: []
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Metadata"
@@ -118,7 +118,7 @@ paths:
security:
- bearerAuth: []
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
responses:
"201":
$ref: "#/components/responses/ChannelsCreateRes"
@@ -148,7 +148,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
security:
- bearerAuth: []
@@ -178,7 +178,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
security:
- bearerAuth: []
@@ -211,7 +211,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
security:
- bearerAuth: []
@@ -240,7 +240,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
security:
- bearerAuth: []
@@ -275,7 +275,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
security:
- bearerAuth: []
@@ -306,7 +306,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
security:
- bearerAuth: []
@@ -337,7 +337,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
requestBody:
$ref: "#/components/requestBodies/ChannelParentGroupReq"
@@ -367,7 +367,7 @@ paths:
tags:
- Channels
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
requestBody:
$ref: "#/components/requestBodies/ChannelParentGroupReq"
@@ -397,7 +397,7 @@ paths:
Connect clients specified by IDs to channels specified by IDs.
Channel and client are owned by user identified using the provided access token.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
tags:
- Connections
requestBody:
@@ -430,7 +430,7 @@ paths:
Disconnect clients specified by IDs from channels specified by IDs.
Channel and client are owned by user identified using the provided access token.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
tags:
- Connections
requestBody:
@@ -464,7 +464,7 @@ paths:
tags:
- Connections
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
requestBody:
$ref: "#/components/requestBodies/ChannelConnReq"
@@ -493,7 +493,7 @@ paths:
tags:
- Connections
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/chanID"
requestBody:
$ref: "#/components/requestBodies/ChannelConnReq"
apidocs/openapi/clients.yml → apidocs/openapi/clients.yaml
+56 -56
View File
@@ -47,7 +47,7 @@ paths:
Adds new client to the list of clients owned by user identified using
the provided access token.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
requestBody:
$ref: "#/components/requestBodies/ClientCreateReq"
responses:
@@ -81,7 +81,7 @@ paths:
dataset is consumed either by making subsequent requests, or by
increasing the subset size of the initial request.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Metadata"
@@ -115,7 +115,7 @@ paths:
Adds a list of new clients to the list of clients owned by user identified using
the provided access token.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
tags:
- Clients
requestBody:
@@ -147,7 +147,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
security:
- bearerAuth: []
@@ -177,7 +177,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
requestBody:
$ref: "#/components/requestBodies/ClientUpdateReq"
@@ -210,7 +210,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
security:
- bearerAuth: []
@@ -238,7 +238,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
requestBody:
$ref: "#/components/requestBodies/ClientUpdateTagsReq"
@@ -270,7 +270,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
requestBody:
$ref: "#/components/requestBodies/ClientUpdateSecretReq"
@@ -305,7 +305,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
security:
- bearerAuth: []
@@ -336,7 +336,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
security:
- bearerAuth: []
@@ -367,7 +367,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
requestBody:
$ref: "#/components/requestBodies/ClientParentGroupReq"
@@ -397,7 +397,7 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
requestBody:
$ref: "#/components/requestBodies/ClientParentGroupReq"
@@ -428,8 +428,8 @@ paths:
tags:
- Clients
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "users.yml#/components/parameters/UserID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "users.yaml#/components/parameters/UserID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Metadata"
@@ -464,15 +464,15 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/CreateRoleReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/CreateRoleReq"
security:
- bearerAuth: []
responses:
"201":
$ref: "./schemas/roles.yml#/components/responses/CreateRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/CreateRoleRes"
"400":
description: Failed due to malformed client's ID.
"401":
@@ -497,7 +497,7 @@ paths:
dataset is consumed either by making subsequent requests, or by
increasing the subset size of the initial request.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
@@ -505,7 +505,7 @@ paths:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRolesRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRolesRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -529,13 +529,13 @@ paths:
description: |
Retrieves members from role for the specific client.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListEntityMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/ListEntityMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -559,14 +559,14 @@ paths:
description: |
Retrieves a specific client role that is identified by the role name.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/GetRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/GetRoleRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -589,16 +589,16 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/UpdateRoleReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/UpdateRoleReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/GetRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/GetRoleRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -621,9 +621,9 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -652,16 +652,16 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleActionsReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/AddRoleActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/AddRoleActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -684,14 +684,14 @@ paths:
description: |
Retrieves a list of client role actions.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRoleActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRoleActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -715,11 +715,11 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleActionsReq"
security:
- bearerAuth: []
responses:
@@ -748,9 +748,9 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -779,16 +779,16 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleMembersReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/AddRoleMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/AddRoleMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -811,14 +811,14 @@ paths:
description: |
Retrieves a list of client role members.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRoleMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRoleMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -842,11 +842,11 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleMembersReq"
security:
- bearerAuth: []
responses:
@@ -875,9 +875,9 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/clientID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -906,12 +906,12 @@ paths:
description: |
Retrieves a list of available actions.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListAvailableActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/ListAvailableActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
apidocs/openapi/domains.yml → apidocs/openapi/domains.yaml
+30 -30
View File
@@ -242,12 +242,12 @@ paths:
parameters:
- $ref: "#/components/parameters/DomainID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/CreateRoleReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/CreateRoleReq"
security:
- bearerAuth: []
responses:
"201":
$ref: "./schemas/roles.yml#/components/responses/CreateRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/CreateRoleRes"
"400":
description: Failed due to malformed domain's ID.
"401":
@@ -279,7 +279,7 @@ paths:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRolesRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRolesRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -304,12 +304,12 @@ paths:
Retrieves a specific domain role that is identified by the role name.
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/GetRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/GetRoleRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -333,14 +333,14 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/UpdateRoleReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/UpdateRoleReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/GetRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/GetRoleRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -364,7 +364,7 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -393,12 +393,12 @@ paths:
description: |
Retrieves members from role for the specific domain.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListEntityMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/ListEntityMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -423,14 +423,14 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleActionsReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/AddRoleActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/AddRoleActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -454,12 +454,12 @@ paths:
Retrieves a list of domain role actions.
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRoleActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRoleActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -484,9 +484,9 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleActionsReq"
security:
- bearerAuth: []
responses:
@@ -516,7 +516,7 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -546,14 +546,14 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleMembersReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/AddRoleMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/AddRoleMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -577,12 +577,12 @@ paths:
Retrieves a list of domain role members.
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRoleMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRoleMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -607,9 +607,9 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleMembersReq"
security:
- bearerAuth: []
responses:
@@ -639,7 +639,7 @@ paths:
- Roles
parameters:
- $ref: "#/components/parameters/DomainID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -668,12 +668,12 @@ paths:
description: |
Retrieves a list of available actions.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListAvailableActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/ListAvailableActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -1373,7 +1373,7 @@ components:
content:
application/health+json:
schema:
$ref: "./schemas/health_info.yml"
$ref: "./schemas/health_info.yaml"
securitySchemes:
bearerAuth:
apidocs/openapi/groups.yml → apidocs/openapi/groups.yaml
+56 -56
View File
@@ -47,7 +47,7 @@ paths:
Creates new group that can be used for grouping entities. New account will
be uniquely identified by its identity.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
requestBody:
$ref: "#/components/requestBodies/GroupCreateReq"
security:
@@ -85,7 +85,7 @@ paths:
security:
- bearerAuth: []
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Level"
@@ -118,7 +118,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
@@ -146,7 +146,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
@@ -179,7 +179,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
@@ -206,7 +206,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
@@ -239,7 +239,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
@@ -277,7 +277,7 @@ paths:
security:
- bearerAuth: []
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "#/components/parameters/Level"
- $ref: "#/components/parameters/Tree"
@@ -307,7 +307,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
requestBody:
$ref: "#/components/requestBodies/GroupParentReq"
@@ -337,7 +337,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
requestBody:
$ref: "#/components/requestBodies/GroupParentReq"
@@ -368,7 +368,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
requestBody:
$ref: "#/components/requestBodies/GroupChildrenReq"
@@ -402,7 +402,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
requestBody:
$ref: "#/components/requestBodies/GroupChildrenReq"
@@ -441,7 +441,7 @@ paths:
security:
- bearerAuth: []
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
@@ -475,7 +475,7 @@ paths:
tags:
- Groups
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
@@ -508,15 +508,15 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/CreateRoleReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/CreateRoleReq"
security:
- bearerAuth: []
responses:
"201":
$ref: "./schemas/roles.yml#/components/responses/CreateRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/CreateRoleRes"
"400":
description: Failed due to malformed group's ID.
"401":
@@ -541,7 +541,7 @@ paths:
dataset is consumed either by making subsequent requests, or by
increasing the subset size of the initial request.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Offset"
@@ -549,7 +549,7 @@ paths:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRolesRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRolesRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -573,13 +573,13 @@ paths:
description: |
Retrieves members from role for the specific group.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListEntityMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/ListEntityMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -603,14 +603,14 @@ paths:
description: |
Retrieves a specific group role that is identified by the role name.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/GetRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/GetRoleRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -633,16 +633,16 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/UpdateRoleReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/UpdateRoleReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/GetRoleRes"
$ref: "./schemas/roles.yaml#/components/responses/GetRoleRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -665,9 +665,9 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -696,16 +696,16 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleActionsReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/AddRoleActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/AddRoleActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -728,14 +728,14 @@ paths:
description: |
Retrieves a list of group role actions.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRoleActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRoleActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -759,11 +759,11 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleActionsReq"
security:
- bearerAuth: []
responses:
@@ -792,9 +792,9 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -823,16 +823,16 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleMembersReq"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/AddRoleMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/AddRoleMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -855,14 +855,14 @@ paths:
description: |
Retrieves a list of group role members.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListRoleMembersRes"
$ref: "./schemas/roles.yaml#/components/responses/ListRoleMembersRes"
"400":
description: Failed due to malformed query parameters.
"401":
@@ -886,11 +886,11 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
requestBody:
$ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
$ref: "./schemas/roles.yaml#/components/requestBodies/AddRoleMembersReq"
security:
- bearerAuth: []
responses:
@@ -919,9 +919,9 @@ paths:
tags:
- Roles
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
- $ref: "#/components/parameters/GroupID"
- $ref: "./schemas/roles.yml#/components/parameters/RoleID"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleID"
security:
- bearerAuth: []
responses:
@@ -950,12 +950,12 @@ paths:
description: |
Retrieves a list of available actions.
parameters:
- $ref: "auth.yml#/components/parameters/DomainID"
- $ref: "auth.yaml#/components/parameters/DomainID"
security:
- bearerAuth: []
responses:
"200":
$ref: "./schemas/roles.yml#/components/responses/ListAvailableActionsRes"
$ref: "./schemas/roles.yaml#/components/responses/ListAvailableActionsRes"
"400":
description: Failed due to malformed query parameters.
"401":
apidocs/openapi/http.yml → apidocs/openapi/http.yaml
+1 -1
View File
@@ -161,7 +161,7 @@ components:
content:
application/health+json:
schema:
$ref: "./schemas/health_info.yml"
$ref: "./schemas/health_info.yaml"
securitySchemes:
bearerAuth:
apidocs/openapi/journal.yml → apidocs/openapi/journal.yaml
+1 -1
View File
@@ -323,7 +323,7 @@ components:
content:
application/health+json:
schema:
$ref: "./schemas/health_info.yml"
$ref: "./schemas/health_info.yaml"
ServiceError:
description: Unexpected server-side error occurred.
apidocs/openapi/schemas/health_info.yml → apidocs/openapi/schemas/health_info.yaml
View File
apidocs/openapi/schemas/roles.yml → apidocs/openapi/schemas/roles.yaml
View File
apidocs/openapi/twins.yml → apidocs/openapi/twins.yaml
+1 -1
View File
@@ -417,7 +417,7 @@ components:
content:
application/health+json:
schema:
$ref: "./schemas/health_info.yml"
$ref: "./schemas/health_info.yaml"
securitySchemes:
bearerAuth:
apidocs/openapi/users.yml → apidocs/openapi/users.yaml
View File
auth/README.md
+2 -2
View File
@@ -106,7 +106,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service itself is distributed as Docker container. Check the [`auth`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml) service section in docker-compose file to see how service is deployed.
The service itself is distributed as Docker container. Check the [`auth`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml) service section in docker-compose file to see how service is deployed.
Running this service outside of container requires working instance of the postgres database, SpiceDB, and Jaeger server.
To start the service outside of the container, execute the following shell script:
@@ -444,6 +444,6 @@ When a PAT is used for authentication:
## Usage
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=auth.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=auth.yaml).
[doc]: https://docs.supermq.abstractmachines.fr
certs/README.md
+1 -1
View File
@@ -67,7 +67,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service is distributed as Docker container. Check the [`certs`](https://github.com/absmach/supermq/blob/main/docker/addons/certs/docker-compose.yml) service section in docker-compose file to see how the service is deployed.
The service is distributed as Docker container. Check the [`certs`](https://github.com/absmach/supermq/blob/main/docker/addons/certs/docker-compose.yaml) service section in docker-compose file to see how the service is deployed.
Running this service outside of container requires working instance of the auth service, clients service, postgres database, vault and Jaeger server.
To start the service outside of the container, execute the following shell script:
clients/README.md
+2 -2
View File
@@ -55,7 +55,7 @@ default values.
## Deployment
The service itself is distributed as Docker container. Check the [`clients `](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml#L167-L194) service section in
The service itself is distributed as Docker container. Check the [`clients `](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml#L167-L194) service section in
docker-compose file to see how service is deployed.
To start the service outside of the container, execute the following shell script:
@@ -117,6 +117,6 @@ To run service in a standalone mode, set `Clients_STANDALONE_EMAIL` and `Clients
## Usage
For more information about service capabilities and its usage, please check out
the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=clients-openapi.yml).
the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=clients-openapi.yaml).
[doc]: https://docs.supermq.abstractmachines.fr
coap/README.md
+1 -1
View File
@@ -30,7 +30,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service itself is distributed as Docker container. Check the [`coap-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml) service section in docker-compose file to see how service is deployed.
The service itself is distributed as Docker container. Check the [`coap-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml) service section in docker-compose file to see how service is deployed.
Running this service outside of container requires working instance of the message broker service, clients service and Jaeger server.
To start the service outside of the container, execute the following shell script:
consumers/README.md
+1 -1
View File
@@ -13,6 +13,6 @@ For an in-depth explanation of the usage of `consumers`, as well as thorough
understanding of SuperMQ, please check out the [official documentation][doc].
For more information about service capabilities and its usage, please check out
the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yml).
the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yaml).
[doc]: https://docs.supermq.abstractmachines.fr
docker/README.md
+3 -3
View File
@@ -13,11 +13,11 @@ Follow the [official documentation](https://docs.docker.com/compose/install/).
Run the following commands from the project root directory.
```bash
docker compose -f docker/docker-compose.yml up
docker compose -f docker/docker-compose.yaml up
```
```bash
docker compose -f docker/addons/<path>/docker-compose.yml up
docker compose -f docker/addons/<path>/docker-compose.yaml up
```
To pull docker images from a specific release you need to change the value of `SMQ_RELEASE_TAG` in `.env` before running these commands.
@@ -33,7 +33,7 @@ Events store: This is used by SuperMQ services to store events for distributed p
This is the same as MESSAGE_BROKER. This can either be 'NATS' or 'RabbitMQ' or 'Redis'. If Redis is used as an events store, then RabbitMQ or NATS is used as a message broker.
The current deployment strategy for SuperMQ in `docker/docker-compose.yml` is to use RabbitMQ as a MQTT_BROKER and NATS as a MESSAGE_BROKER and EVENTS_STORE.
The current deployment strategy for SuperMQ in `docker/docker-compose.yaml` is to use RabbitMQ as a MQTT_BROKER and NATS as a MESSAGE_BROKER and EVENTS_STORE.
Therefore, the following combinations are possible:
docker/addons/certs/config.yml → docker/addons/certs/config.yaml
View File
docker/addons/certs/docker-compose.yml → docker/addons/certs/docker-compose.yaml
+2 -2
View File
@@ -3,7 +3,7 @@
# This docker-compose file contains optional certs services. Since it's optional, this file is
# dependent of docker-compose file from <project_root>/docker. In order to run this services, execute command:
# docker compose -f docker/docker-compose.yml -f docker/addons/certs/docker-compose.yml up
# docker compose -f docker/docker-compose.yaml -f docker/addons/certs/docker-compose.yaml up
# from project root.
networks:
@@ -118,7 +118,7 @@ services:
AM_JAEGER_URL: ${SMQ_JAEGER_URL}
AM_JAEGER_TRACE_RATIO: ${SMQ_JAEGER_TRACE_RATIO}
volumes:
- ./config.yml:/config/config.yml
- ./config.yaml:/config/config.yaml
ports:
- 9010:9010
- 7012:7012
docker/addons/journal/docker-compose.yml → docker/addons/journal/docker-compose.yaml
+1 -1
View File
@@ -4,7 +4,7 @@
# This docker-compose file contains optional Postgres and journal services
# for SuperMQ platform. Since these are optional, this file is dependent of docker-compose file
# from <project_root>/docker. In order to run these services, execute command:
# docker-compose -f docker/docker-compose.yml -f docker/addons/journal/docker-compose.yml up
# docker-compose -f docker/docker-compose.yaml -f docker/addons/journal/docker-compose.yaml up
# from project root. PostgreSQL default port (5432) is exposed, so you can use various tools for database
# inspection and data visualization.
docker/addons/prometheus/docker-compose.yml → docker/addons/prometheus/docker-compose.yaml
+7 -7
View File
@@ -2,9 +2,9 @@
# SPDX-License-Identifier: Apache-2.0
# This docker-compose file contains optional Prometheus and Grafana service for SuperMQ platform.
# Since this service is optional, this file is dependent of docker-compose.yml file
# Since this service is optional, this file is dependent of docker-compose.yaml file
# from <project_root>/docker. In order to run this service, execute command:
# docker compose -f docker/addons/prometheus/docker-compose.yml up
# docker compose -f docker/addons/prometheus/docker-compose.yaml up
# from project root.
networks:
@@ -24,8 +24,8 @@ services:
- supermq-base-net
volumes:
- type: bind
source: ./metrics/prometheus.yml
target: /etc/prometheus/prometheus.yml
source: ./metrics/prometheus.yaml
target: /etc/prometheus/prometheus.yaml
- supermq-prometheus-volume:/prometheus
grafana:
@@ -43,10 +43,10 @@ services:
- supermq-base-net
volumes:
- type: bind
source: ./grafana/datasource.yml
target: /etc/grafana/provisioning/datasources/datasource.yml
source: ./grafana/datasource.yaml
target: /etc/grafana/provisioning/datasources/datasource.yaml
- type: bind
source: ./grafana/dashboard.yml
source: ./grafana/dashboard.yaml
target: /etc/grafana/provisioning/dashboards/main.yaml
- type: bind
source: ./grafana/example-dashboard.json
docker/addons/prometheus/grafana/dashboard.yml → docker/addons/prometheus/grafana/dashboard.yaml
View File
docker/addons/prometheus/grafana/datasource.yml → docker/addons/prometheus/grafana/datasource.yaml
View File
docker/addons/prometheus/metrics/prometheus.yml → docker/addons/prometheus/metrics/prometheus.yaml
View File
docker/addons/vault/docker-compose.yml → docker/addons/vault/docker-compose.yaml
+1 -1
View File
@@ -4,7 +4,7 @@
# This docker-compose file contains optional Vault service for SuperMQ platform.
# Since this is optional, this file is dependent of docker-compose file
# from <project_root>/docker. In order to run these services, execute command:
# docker compose -f docker/docker-compose.yml -f docker/addons/vault/docker-compose.yml up
# docker compose -f docker/docker-compose.yaml -f docker/addons/vault/docker-compose.yaml up
# from project root. Vault default port (8200) is exposed, so you can use Vault CLI tool for
# vault inspection and administration, as well as access the UI.
docker/docker-compose.yml → docker/docker-compose.yaml
View File
docker/nginx/snippets/ssl.conf
+1 -1
View File
@@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
# These paths are set to its default values as
# a volume in the docker/docker-compose.yml file.
# a volume in the docker/docker-compose.yaml file.
ssl_certificate /etc/ssl/certs/supermq-server.crt;
ssl_certificate_key /etc/ssl/private/supermq-server.key;
ssl_dhparam /etc/ssl/certs/dhparam.pem;
http/README.md
+2 -2
View File
@@ -26,7 +26,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service itself is distributed as Docker container. Check the [`http-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml) service section in docker-compose file to see how service is deployed.
The service itself is distributed as Docker container. Check the [`http-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml) service section in docker-compose file to see how service is deployed.
Running this service outside of container requires working instance of the message broker service, clients service and Jaeger server.
To start the service outside of the container, execute the following shell script:
@@ -68,4 +68,4 @@ Setting `SMQ_CLIENTS_GRPC_CLIENT_CERT` and `SMQ_CLIENTS_GRPC_CLIENT_KEY` will en
## Usage
HTTP Authorization request header contains the credentials to authenticate a Client. The authorization header can be a plain Client key or a Client key encoded as a password for Basic Authentication. In case the Basic Authentication schema is used, the username is ignored. For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=http.yml).
HTTP Authorization request header contains the credentials to authenticate a Client. The authorization header can be a plain Client key or a Client key encoded as a password for Basic Authentication. In case the Basic Authentication schema is used, the username is ignored. For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=http.yaml).
mqtt/README.md
+2 -2
View File
@@ -34,7 +34,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service itself is distributed as Docker container. Check the [`mqtt-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml) service section in docker-compose file to see how service is deployed.
The service itself is distributed as Docker container. Check the [`mqtt-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml) service section in docker-compose file to see how service is deployed.
Running this service outside of container requires working instance of the message broker service, clients service and Jaeger server.
To start the service outside of the container, execute the following shell script:
@@ -80,4 +80,4 @@ $GOBIN/supermq-mqtt
Setting `SMQ_CLIENTS_GRPC_CLIENT_CERT` and `SMQ_CLIENTS_GRPC_CLIENT_KEY` will enable TLS against the clients service. The service expects a file in PEM format for both the certificate and the key. Setting `SMQ_CLIENTS_GRPC_SERVER_CERTS` will enable TLS against the clients service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs.
For more information about service capabilities and its usage, please check out the API documentation [API](https://github.com/absmach/supermq/blob/main/api/asyncapi/mqtt.yml).
For more information about service capabilities and its usage, please check out the API documentation [API](https://github.com/absmach/supermq/blob/main/api/asyncapi/mqtt.yaml).
tools/config/codecov.yml → tools/config/.codecov.yaml
View File
tools/config/golangci.yml → tools/config/.golangci.yaml
View File
tools/config/mockery.yaml → tools/config/.mockery.yaml
View File
users/README.md
+2 -2
View File
@@ -58,7 +58,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service itself is distributed as Docker container. Check the [`users`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml) service section in docker-compose file to see how service is deployed.
The service itself is distributed as Docker container. Check the [`users`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml) service section in docker-compose file to see how service is deployed.
To start the service outside of the container, execute the following shell script:
@@ -127,6 +127,6 @@ Setting `SMQ_AUTH_GRPC_CLIENT_CERT` and `SMQ_AUTH_GRPC_CLIENT_KEY` will enable T
## Usage
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=users-openapi.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=users-openapi.yaml).
[doc]: https://docs.supermq.abstractmachines.fr
ws/README.md
+1 -1
View File
@@ -26,7 +26,7 @@ The service is configured using the environment variables presented in the follo
## Deployment
The service is distributed as Docker container. Check the [`ws-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yml) service section in docker-compose file to see how the service is deployed.
The service is distributed as Docker container. Check the [`ws-adapter`](https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml) service section in docker-compose file to see how the service is deployed.
Running this service outside of container requires working instance of the message broker service, clients service and Jaeger server.
To start the service outside of the container, execute the following shell script: