SMQ-2570 - Update user and groups api docs (#2581)

Signed-off-by: Felix Gateru <[email protected]>
absmach · Dec 11, 2024 · 901ed73 · 901ed73
1 parent b444046
commit 901ed73
Show file tree

Hide file tree

Showing 16 changed files with 1,805 additions and 713 deletions.
diff --git a/.github/workflows/api-tests.yml b/.github/workflows/api-tests.yml
@@ -152,7 +152,17 @@ jobs:
           checks: all
           report: false
           args: '--header "Authorization: Bearer ${{ env.USER_TOKEN }}" --contrib-openapi-formats-uuid --hypothesis-suppress-health-check=filter_too_much --stateful=links'
-
+
+      - name: Run Groups API tests
+        if: steps.changes.outputs.groups == 'true'
+        uses: schemathesis/action@v1
+        with:
+          schema: api/openapi/groups.yml
+          base-url: ${{ env.GROUPS_URL }}
+          checks: all
+          report: false
+          args: '--header "Authorization: Bearer ${{ env.USER_TOKEN }}" --contrib-openapi-formats-uuid --hypothesis-suppress-health-check=filter_too_much --stateful=links'
+
       - name: Run Clients API tests
         if: steps.changes.outputs.clients == 'true'
         uses: schemathesis/action@v1

diff --git a/api/openapi/bootstrap.yml b/api/openapi/bootstrap.yml
@@ -13,7 +13,7 @@ info:
   license:
     name: Apache 2.0
     url: https://github.com/absmach/supermq/blob/main/LICENSE
-  version: 0.14.0
+  version: 0.15.1
 
 servers:
   - url: http://localhost:9013
@@ -88,6 +88,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /{domainID}/clients/configs/{configId}:
     get:
       operationId: getConfig
@@ -167,6 +168,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /{domainID}/clients/configs/certs/{configId}:
     patch:
       operationId: updateConfigCerts
@@ -199,6 +201,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /{domainID}/clients/configs/connections/{configId}:
     put:
       operationId: updateConfigConnections
@@ -230,6 +233,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /clients/bootstrap/{externalId}:
     get:
       operationId: getBootstrapConfig
@@ -255,6 +259,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /clients/bootstrap/secure/{externalId}:
     get:
       operationId: getSecureBootstrapConfig
@@ -281,6 +286,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /{domainID}/clients/state/{configId}:
     put:
       operationId: updateConfigState
@@ -310,6 +316,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /health:
     get:
       summary: Retrieves service health check info.

diff --git a/api/openapi/certs.yml b/api/openapi/certs.yml
@@ -13,7 +13,7 @@ info:
   license:
     name: Apache 2.0
     url: https://github.com/absmach/supermq/blob/main/LICENSE
-  version: 0.14.0
+  version: 0.15.1
 
 servers:
   - url: http://localhost:9019
@@ -53,6 +53,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /{domainID}/certs/{certID}:
     get:
       operationId: getCert
@@ -106,6 +107,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /{domainID}/serials/{clientID}:
     get:
       operationId: getSerials
@@ -133,6 +135,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
   /health:
     get:
       summary: Retrieves service health check info.

diff --git a/api/openapi/clients.yml b/api/openapi/clients.yml
@@ -867,6 +867,35 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
+  /{domainID}/clients/roles/available-actions:
+    get:
+      operationId: listAvailableActions
+      tags:
+        - Roles
+      summary: Retrieves available actions.
+      description: |
+        Retrieves a list of available actions. 
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
+      security:
+        - bearerAuth: []
+      responses:
+        "200":
+          $ref: "./schemas/roles.yml#/components/responses/ListAvailableActionsRes"
+        "400":
+          description: Failed due to malformed query parameters.
+        "401":
+          description: |
+            Missing or invalid access token provided.
+        "403":
+          description: Failed to perform authorization over the entity.
+        "404":
+          description: A non-existent entity request.
+        "422":
+          description: Database can't process request.
+        "500":
+          $ref: "#/components/responses/ServiceError"
+
   /health:
     get:
       summary: Retrieves service health check info.

diff --git a/api/openapi/domains.yml b/api/openapi/domains.yml
@@ -637,6 +637,35 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
+
+  /domains/roles/available-actions:
+    get:
+      operationId: listAvailableActions
+      tags:
+        - Roles
+      summary: Retrieves available actions.
+      description: |
+        Retrieves a list of available actions. 
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
+      security:
+        - bearerAuth: []
+      responses:
+        "200":
+          $ref: "./schemas/roles.yml#/components/responses/ListAvailableActionsRes"
+        "400":
+          description: Failed due to malformed query parameters.
+        "401":
+          description: |
+            Missing or invalid access token provided.
+        "403":
+          description: Failed to perform authorization over the entity.
+        "404":
+          description: A non-existent entity request.
+        "422":
+          description: Database can't process request.
+        "500":
+          $ref: "#/components/responses/ServiceError"
 
   /health:
     get: