MG-2441 - Add domain ID to API

api/openapi/bootstrap.yml

@@ -27,7 +27,7 @@ tags:
       url: https://docs.magistrala.abstractmachines.fr/
 
 paths:
-  /things/configs:
+  /domains/{domainID}/things/configs:
     post:
       operationId: createConfig
       summary: Adds new config
@@ -36,6 +36,8 @@ paths:
         the provided access token.
       tags:
         - configs
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       requestBody:
         $ref: "#/components/requestBodies/ConfigCreateReq"
       responses:
@@ -70,6 +72,7 @@ paths:
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/Limit"
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/State"
@@ -85,13 +88,14 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /things/configs/{configId}:
+  /domains/{domainID}/things/configs/{configId}:
     get:
       operationId: getConfig
       summary: Retrieves config info (with channels).
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ConfigId"
       responses:
         "200":
@@ -118,6 +122,7 @@ paths:
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ConfigId"
       requestBody:
         $ref: "#/components/requestBodies/ConfigUpdateReq"
@@ -147,6 +152,7 @@ paths:
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ConfigId"
       responses:
         "204":
@@ -161,7 +167,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /things/configs/certs/{configId}:
+  /domains/{domainID}/things/configs/certs/{configId}:
     patch:
       operationId: updateConfigCerts
       summary: Updates certs
@@ -171,6 +177,7 @@ paths:
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ConfigId"
       requestBody:
         $ref: "#/components/requestBodies/ConfigCertUpdateReq"
@@ -192,7 +199,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /things/configs/connections/{configId}:
+  /domains/{domainID}/things/configs/connections/{configId}:
     put:
       operationId: updateConfigConnections
       summary: Updates channels the thing is connected to
@@ -202,6 +209,7 @@ paths:
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ConfigId"
       requestBody:
         $ref: "#/components/requestBodies/ConfigConnUpdateReq"
@@ -273,7 +281,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /things/state/{configId}:
+  /domains/{domainID}/things/state/{configId}:
     put:
       operationId: updateConfigState
       summary: Updates Config state.
@@ -283,6 +291,7 @@ paths:
       tags:
         - configs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ConfigId"
       requestBody:
         $ref: "#/components/requestBodies/ConfigStateUpdateReq"

api/openapi/certs.yml

@@ -27,13 +27,15 @@ tags:
       url: https://docs.magistrala.abstractmachines.fr/
 
 paths:
-  /certs:
+  /domains/{domainID}/certs:
     post:
       operationId: createCert
       summary: Creates a certificate for thing
       description: Creates a certificate for thing
       tags:
         - certs
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       requestBody:
         $ref: "#/components/requestBodies/CertReq"
       responses:
@@ -51,7 +53,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /certs/{certID}:
+  /domains/{domainID}/certs/{certID}:
     get:
       operationId: getCert
       summary: Retrieves a certificate
@@ -60,6 +62,7 @@ paths:
       tags:
         - certs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/CertID"
       responses:
         "200":
@@ -85,6 +88,7 @@ paths:
       tags:
         - certs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/CertID"
       responses:
         "200":
@@ -100,7 +104,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  /serials/{thingID}:
+  /domains/{domainID}/serials/{thingID}:
     get:
       operationId: getSerials
       summary: Retrieves certificates' serial IDs
@@ -109,6 +113,7 @@ paths:
       tags:
         - certs
       parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/ThingID"
       responses:
         "200":

api/openapi/invitations.yml

@@ -27,14 +27,16 @@ tags:
       url: https://docs.magistrala.abstractmachines.fr/
 
 paths:
-  /invitations:
+  /domains/{domainID}/invitations:
     post:
       operationId: sendInvitation
       tags:
         - Invitations
       summary: Send invitation
       description: |
         Send invitation to user to join domain.
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       requestBody:
         $ref: "#/components/requestBodies/SendInvitationReq"
       security:
@@ -70,7 +72,7 @@ paths:
         - $ref: "#/components/parameters/Offset"
         - $ref: "#/components/parameters/UserID"
         - $ref: "#/components/parameters/InvitedBy"
-        - $ref: "#/components/parameters/DomainID"
+        - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/Relation"
         - $ref: "#/components/parameters/State"
       security:
@@ -91,7 +93,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /invitations/accept:
+  /domains/{domainID}/invitations/accept:
     post:
       operationId: acceptInvitation
       summary: Accept invitation
@@ -101,8 +103,8 @@ paths:
         - Invitations
       security:
         - bearerAuth: []
-      requestBody:
-        $ref: "#/components/requestBodies/AcceptInvitationReq"
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       responses:
         "204":
           description: Invitation accepted.
@@ -115,7 +117,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /invitations/reject:
+  /domains/{domainID}/invitations/reject:
     post:
       operationId: rejectInvitation
       summary: Reject invitation
@@ -125,8 +127,8 @@ paths:
         - Invitations
       security:
         - bearerAuth: []
-      requestBody:
-        $ref: "#/components/requestBodies/AcceptInvitationReq"
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       responses:
         "204":
           description: Invitation rejected.
@@ -139,7 +141,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /invitations/{user_id}/{domain_id}:
+  /domains/{domainID}/invitations/users/{user_id}:
     get:
       operationId: getInvitation
       summary: Retrieves a specific invitation
@@ -149,7 +151,7 @@ paths:
         - Invitations
       parameters:
         - $ref: "#/components/parameters/user_id"
-        - $ref: "#/components/parameters/domain_id"
+        - $ref: "auth.yml#/components/parameters/DomainID"
       security:
         - bearerAuth: []
       responses:
@@ -175,7 +177,7 @@ paths:
         - Invitations
       parameters:
         - $ref: "#/components/parameters/user_id"
-        - $ref: "#/components/parameters/domain_id"
+        - $ref: "auth.yml#/components/parameters/DomainID"
       security:
         - bearerAuth: []
       responses:
@@ -212,11 +214,6 @@ components:
           format: uuid
           example: bb7edb32-2eac-4aad-aebe-ed96fe073879
           description: User unique identifier.
-        domain_id:
-          type: string
-          format: uuid
-          example: bb7edb32-2eac-4aad-aebe-ed96fe073879
-          description: Domain unique identifier.
         relation:
           type: string
           enum:
@@ -238,7 +235,6 @@ components:
           description: Resend invitation.
       required:
         - user_id
-        - domain_id
         - relation
 
     Invitation:
@@ -394,26 +390,6 @@ components:
       required: true
       example: bb7edb32-2eac-4aad-aebe-ed96fe073879
 
-    DomainID:
-      name: domain_id
-      description: Unique identifier for a domain.
-      in: query
-      schema:
-        type: string
-        format: uuid
-      required: false
-      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
-
-    domain_id:
-      name: domain_id
-      description: Unique identifier for a domain.
-      in: path
-      schema:
-        type: string
-        format: uuid
-      required: true
-      example: bb7edb32-2eac-4aad-aebe-ed96fe073879
-
     InvitedBy:
       name: invited_by
       description: Unique identifier for a user that invited the user.
@@ -466,22 +442,6 @@ components:
           schema:
             $ref: "#/components/schemas/SendInvitationReqObj"
 
-    AcceptInvitationReq:
-      description: JSON-formatted document describing request for accepting invitation
-      required: true
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              domain_id:
-                type: string
-                format: uuid
-                example: bb7edb32-2eac-4aad-aebe-ed96fe073879
-                description: Domain unique identifier.
-            required:
-              - domain_id
-
   responses:
     InvitationRes:
       description: Data retrieved.

api/openapi/provision.yml

@@ -27,12 +27,14 @@ tags:
       url: https://docs.magistrala.abstractmachines.fr/
 
 paths:
-  /mapping:
+  /domains/{domainID}/mapping:
     post:
       summary: Adds new device to proxy
       description: Adds new device to proxy
       tags:
         - provision
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       requestBody:
         $ref: "#/components/requestBodies/ProvisionReq"
       responses:
@@ -55,6 +57,8 @@ paths:
         configuration created with provision service.
       tags:
         - provision
+      parameters:
+        - $ref: "auth.yml#/components/parameters/DomainID"
       responses:
         "200":
           $ref: "#/components/responses/ProvisionRes"