update docs

Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
absmach · Jun 11, 2024 · 55b01fc · 55b01fc
1 parent 4f9abae
commit 55b01fc
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 39 deletions.
diff --git a/api/openapi/auth.yml b/api/openapi/auth.yml
@@ -306,39 +306,6 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /domains/users/{memberID}:
-    get:
-      tags:
-        - Domains
-      summary: List users in a domain
-      description: |
-        Retrieves a list of users in a domain. Due to performance concerns, data
-        is retrieved in subsets. The API must ensure that the entire
-        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/Limit"
-        - $ref: "#/components/parameters/Offset"
-        - $ref: "#/components/parameters/Metadata"
-        - $ref: "#/components/parameters/Status"
-      security:
-        - bearerAuth: []
-      responses:
-        "200":
-          $ref: "#/components/responses/DomainsPageRes"
-        "400":
-          description: Failed due to malformed query parameters.
-        "401":
-          description: |
-            Missing or invalid access token provided.
-            This endpoint is available only for administrators.
-        "404":
-          description: A non-existent entity request.
-        "422":
-          description: Database can't process request.
-        "500":
-          $ref: "#/components/responses/ServiceError"
   /keys:
     post:
       operationId: issueKey

diff --git a/api/openapi/things.yml b/api/openapi/things.yml
@@ -401,7 +401,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /things/channels/{chanID}:
+  /things/channels:
     get:
       operationId: listThingsInaChannel
       summary: List of things connected to specified channel
@@ -415,6 +415,7 @@ paths:
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/Limit"
         - $ref: "#/components/parameters/Connected"
+        - $ref: "#/components/parameters/Channel"
       responses:
         "200":
           $ref: "#/components/responses/ThingsPageRes"
@@ -431,7 +432,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /things/users/{memberID}:
+  /things/users:
     get:
       operationId: listThingsAssignedToUser
       summary: List of things connected to specified user
@@ -445,6 +446,7 @@ paths:
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/Limit"
         - $ref: "#/components/parameters/Connected"
+        - $ref: "#/components/parameters/User"
       responses:
         "200":
           $ref: "#/components/responses/ThingsPageRes"
@@ -791,7 +793,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /channels/users/{memberID}:
+  /channels/users:
     get:
       operationId: listChannelsConnectedToUser
       summary: List of channels connected to specified user
@@ -804,6 +806,7 @@ paths:
         - $ref: "#/components/parameters/MemberID"
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/Limit"
+        - $ref: "#/components/parameters/User"
       responses:
         "200":
           $ref: "#/components/responses/ChannelPageRes"
@@ -820,7 +823,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /channels/groups/{memberID}:
+  /channels/groups:
     get:
       operationId: listChannelsConnectedToGroup
       summary: List of channels connected to specified group
@@ -833,6 +836,7 @@ paths:
         - $ref: "#/components/parameters/MemberID"
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/Limit"
+        - $ref: "#/components/parameters/Group"
       responses:
         "200":
           $ref: "#/components/responses/ChannelPageRes"
@@ -963,7 +967,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /channels/things/{thingID}:
+  /channels/things:
     get:
       operationId: listChannelsConnectedToThing
       summary: List of channels connected to specified thing
@@ -976,6 +980,7 @@ paths:
         - $ref: "#/components/parameters/ThingID"
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/Limit"
+        - $ref: "#/components/parameters/Thing"
       responses:
         "200":
           $ref: "#/components/responses/ChannelPageRes"
@@ -1657,6 +1662,46 @@ components:
       required: true
       example: bb7edb32-2eac-4aad-aebe-ed96fe073879
 
+    Channel:
+      name: channel
+      description: Unique channel identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: true
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
+    User:
+      name: user
+      description: Unique user identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: true
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
+    Group:
+      name: group
+      description: Unique group identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: true
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
+    Thing:
+      name: thing
+      description: Unique thing identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: true
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
     ParentId:
       name: parentId
       description: Unique parent identifier for a channel.

diff --git a/api/openapi/users.yml b/api/openapi/users.yml
@@ -371,7 +371,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /users/groups/{groupID}:
+  /members:
     get:
       operationId: listUsersInGroup
       tags:
@@ -391,6 +391,11 @@ paths:
         - $ref: "#/components/parameters/Metadata"
         - $ref: "#/components/parameters/GroupName"
         - $ref: "#/components/parameters/ParentID"
+        - $ref: "#/components/parameters/Group"
+        - $ref: "#/components/parameters/Domain"
+        - $ref: "#/components/parameters/Channel"
+        - $ref: "#/components/parameters/Thing"
+        - $ref: "#/components/parameters/User"
       responses:
         "200":
           $ref: "#/components/responses/MembersPageRes"
@@ -1649,6 +1654,46 @@ components:
       required: true
       example: bb7edb32-2eac-4aad-aebe-ed96fe073879
 
+    Channel:
+      name: channel
+      description: Unique channel identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: false
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
+    User:
+      name: user
+      description: Unique user identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: false
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
+    Group:
+      name: group
+      description: Unique group identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: false
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
+    Thing:
+      name: thing
+      description: Unique thing identifier.
+      in: query
+      schema:
+        type: sting
+        format: uuid
+      required: false
+      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
+
     MemberID:
       name: memberID
       description: Unique member identifier.