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 - Update API docs (#3211)

Browse Source 
Signed-off-by: nyagamunene <stevenyaga2014@gmail.com>
This commit is contained in:
Steve Munene
2025-10-30 19:37:01 +03:00
committed by GitHub
parent d02747a56f
commit 9650dde716
5 changed files with 43 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apidocs/openapi/channels.yaml
+3 -31
View File
@@ -93,9 +93,9 @@ paths:
- $ref: "#/components/parameters/Status"
- $ref: "#/components/parameters/ChannelName"
- $ref: "#/components/parameters/ID"
- $ref: "#/components/parameters/Actions"
- $ref: "#/components/parameters/RoleID"
- $ref: "#/components/parameters/RoleName"
- $ref: "./schemas/roles.yaml#/components/parameters/ActionsQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleIDQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleNameQuery"
- $ref: "#/components/parameters/AccessType"
- $ref: "#/components/parameters/OnlyTotal"
- $ref: "#/components/parameters/Client"
@@ -888,34 +888,6 @@ components:
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Actions:
name: actions
description: Lists channels that the user has the given actions on. Multiple actions can be specified separated by comma.
in: query
schema:
type: string
required: false
example: "action1,action2"
RoleID:
name: role_id
description: List channels that the user has the given role ID on.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
RoleName:
name: role_name
description: List channels that the user has the given role name on.
in: query
schema:
type: string
required: false
example: admin
AccessType:
name: access_type
description: Type of access the user has on the channel.
apidocs/openapi/clients.yaml
+3 -31
View File
@@ -91,9 +91,9 @@ paths:
- $ref: "#/components/parameters/ClientName"
- $ref: "#/components/parameters/Tags"
- $ref: "#/components/parameters/ID"
- $ref: "#/components/parameters/Actions"
- $ref: "#/components/parameters/RoleID"
- $ref: "#/components/parameters/RoleName"
- $ref: "./schemas/roles.yaml#/components/parameters/ActionsQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleIDQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleNameQuery"
- $ref: "#/components/parameters/AccessType"
- $ref: "#/components/parameters/OnlyTotal"
- $ref: "#/components/parameters/Channel"
@@ -1282,34 +1282,6 @@ components:
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Actions:
name: actions
description: Lists clients that the user has the given actions on. Multiple actions can be specified separated by comma.
in: query
schema:
type: string
required: false
example: "action1,action2"
RoleID:
name: role_id
description: List clients that the user has the given role ID on.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
RoleName:
name: role_name
description: List clients that the user has the given role name on.
in: query
schema:
type: string
required: false
example: admin
AccessType:
name: access_type
description: Type of access the user has on the client.
apidocs/openapi/domains.yaml
+3 -28
View File
@@ -78,9 +78,9 @@ paths:
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/Status"
- $ref: "#/components/parameters/DomainName"
- $ref: "#/components/parameters/Actions"
- $ref: "#/components/parameters/RoleID"
- $ref: "#/components/parameters/RoleName"
- $ref: "./schemas/roles.yaml#/components/parameters/ActionsQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleIDQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleNameQuery"
- $ref: "#/components/parameters/AccessType"
- $ref: "#/components/parameters/OnlyTotal"
tags:
@@ -1260,31 +1260,6 @@ components:
- desc
required: false
example: desc
Actions:
name: actions
description: Lists domains that the user has the given actions on. Multiple actions can be specified separated by comma.
in: query
schema:
type: string
required: false
example: "action1,action2"
RoleID:
name: role_id
description: List domains that the user has the given role ID on.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
RoleName:
name: role_name
description: List domains that the user has the given role name on.
in: query
schema:
type: string
required: false
example: admin
AccessType:
name: access_type
description: Type of access the user has on the domain.
apidocs/openapi/groups.yaml
+4 -32
View File
@@ -97,9 +97,9 @@ paths:
- $ref: "#/components/parameters/RootGroup"
- $ref: "#/components/parameters/Status"
- $ref: "#/components/parameters/ID"
- $ref: "#/components/parameters/Actions"
- $ref: "#/components/parameters/RoleID"
- $ref: "#/components/parameters/RoleName"
- $ref: "./schemas/roles.yaml#/components/parameters/ActionsQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleIDQuery"
- $ref: "./schemas/roles.yaml#/components/parameters/RoleNameQuery"
- $ref: "#/components/parameters/AccessType"
- $ref: "#/components/parameters/OnlyTotal"
responses:
@@ -1569,36 +1569,8 @@ components:
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Actions:
name: actions
description: Lists groups that the user has the given actions on. Multiple actions can be specified separated by comma.
in: query
schema:
type: string
required: false
example: "action1,action2"
RoleID:
name: role_id
description: List groups that the user has the given role ID on.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
RoleName:
name: role_name
description: List groups that the user has the given role name on.
in: query
schema:
type: string
required: false
example: admin
AccessType:
AccessType:
name: access_type
description: Type of access the user has on the group.
in: query
apidocs/openapi/schemas/roles.yaml
+30 -5
View File
@@ -6,12 +6,12 @@ components:
NewRole:
type: object
properties:
role_id:
id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Role unique identifier.
role_name:
name:
type: string
description: Role's name.
example: "roleName"
@@ -44,12 +44,12 @@ components:
Role:
type: object
properties:
role_id:
id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Role unique identifier.
role_name:
name:
type: string
description: Role's name.
example: "roleName"
@@ -82,7 +82,7 @@ components:
CreateRoleObj:
type: object
properties:
role_name:
name:
type: string
description: Role's name.
example: "roleName"
@@ -270,6 +270,31 @@ components:
type: string
required: true
example: "roleID"
RoleIDQuery:
name: role_id
description: Filter by role ID.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
RoleNameQuery:
name: role_name
description: Filter by role name.
in: query
schema:
type: string
required: false
example: admin
ActionsQuery:
name: actions
description: Filter by actions. Multiple actions can be specified separated by comma.
in: query
schema:
type: string
required: false
example: "action1,action2"
requestBodies:
CreateRoleReq: