Upd: Read data sharing UI

Signed-off-by: George J Padayatti <[email protected]>
decentralised-dataexchange · Nov 12, 2023 · 42600e8 · 42600e8
1 parent ebd1426
commit 42600e8
Show file tree

Hide file tree

Showing 3 changed files with 139 additions and 0 deletions.
diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml
@@ -4063,6 +4063,75 @@ paths:
         - BearerAuth: []
       tags:
         - service
+  /service/data-sharing:
+    get:
+      description: READ - Data sharing UI
+      operationId: serviceReadDataSharingUi
+      parameters:
+        - name: dataAgreementId
+          in: query
+          description: ID for data agreement
+          required: true
+          schema:
+            type: string
+        - name: accessToken
+          in: query
+          description: Access token for authentication
+          required: false
+          schema:
+            type: string
+        - name: apiKey
+          in: query
+          description: API key for authorization
+          required: false
+          schema:
+            type: string
+        - name: individualId
+          in: query
+          description: ID for the individual
+          required: false
+          schema:
+            type: string
+        - name: thirdPartyOrgName
+          in: query
+          description: Name of the third-party organization
+          required: true
+          schema:
+            type: string
+        - name: thirdPartyOrgLogoImageUrl
+          in: query
+          description: URL for the third-party organization's logo image
+          required: false
+          schema:
+            type: string
+        - name: dataSharingUiRedirectUrl
+          in: query
+          description: Redirect URL for data sharing UI
+          required: true
+          schema:
+            type: string
+        - name: authorisationCode
+          in: query
+          description: Authorization code
+          required: false
+          schema:
+            type: string
+        - name: authorisationRedirectUrl
+          in: query
+          description: Redirect URL for authorization
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Ok
+        '400':
+          description: bad input parameter
+      security:
+        - BearerAuth: []
+      summary: READ - Data sharing UI
+      tags:
+        - service
   /audit/admin/logs:
     get:
       operationId: auditAdminLogs

diff --git a/openapi/v2023.11.1/index.yaml b/openapi/v2023.11.1/index.yaml
@@ -324,6 +324,9 @@ paths:
   /service/image/{imageId}:
     get:
       $ref: ./paths/serviceReadOrganisationImage.yaml
+  /service/data-sharing:
+    get:
+      $ref: ./paths/serviceReadDataSharingUi.yaml
   /audit/admin/logs:
     get:
       $ref: ./paths/auditAdminLogs.yaml

diff --git a/openapi/v2023.11.1/paths/serviceReadDataSharingUi.yaml b/openapi/v2023.11.1/paths/serviceReadDataSharingUi.yaml
@@ -0,0 +1,67 @@
+description: READ - Data sharing UI
+operationId: serviceReadDataSharingUi
+parameters:
+  - name: dataAgreementId
+    in: query
+    description: ID for data agreement
+    required: true
+    schema:
+      type: string
+  - name: accessToken
+    in: query
+    description: Access token for authentication
+    required: false
+    schema:
+      type: string
+  - name: apiKey
+    in: query
+    description: API key for authorization
+    required: false
+    schema:
+      type: string
+  - name: individualId
+    in: query
+    description: ID for the individual
+    required: false
+    schema:
+      type: string
+  - name: thirdPartyOrgName
+    in: query
+    description: Name of the third-party organization
+    required: true
+    schema:
+      type: string
+  - name: thirdPartyOrgLogoImageUrl
+    in: query
+    description: URL for the third-party organization's logo image
+    required: false
+    schema:
+      type: string
+  - name: dataSharingUiRedirectUrl
+    in: query
+    description: Redirect URL for data sharing UI
+    required: true
+    schema:
+      type: string
+  - name: authorisationCode
+    in: query
+    description: Authorization code
+    required: false
+    schema:
+      type: string
+  - name: authorisationRedirectUrl
+    in: query
+    description: Redirect URL for authorization
+    required: false
+    schema:
+      type: string
+responses:
+  "200":
+    description: Ok
+  "400":
+    description: bad input parameter
+security:
+  - BearerAuth: []
+summary: READ - Data sharing UI
+tags:
+  - service