Add #14 Add service read organisation logo and cover image endpoints

decentralised-dataexchange · Oct 25, 2023 · eda8792 · eda8792
1 parent 019e915
commit eda8792
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 0 deletions.
diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml
@@ -2527,6 +2527,33 @@ paths:
       x-specification-pii-or-sensitive: 'False'
       x-specification-scenario: ''
       x-specification-usecase: UC-C-PIC-A-004
+  /config/privacy-dashboard:
+    get:
+      deprecated: false
+      description: Read privacy dashboard
+      operationId: readPrivacyDashboard
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  hostName:
+                    type: string
+                  version:
+                    type: string
+                  state:
+                    type: int
+                  stateStr:
+                    type: string
+                required:
+                  - privacydashboard
+                type: object
+          description: OK
+      security:
+        - BearerAuth: []
+      tags:
+        - config
   /onboard/admin:
     put:
       description: UPDATE - Update organisation admin
@@ -3219,6 +3246,30 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
+  /service/organisation/coverimage:
+    get:
+      deprecated: false
+      description: Read organization cover image
+      operationId: serviceReadOrganisationCoverImage
+      responses:
+        '200':
+          headers: {}
+      security:
+        - BearerAuth: []
+      tags:
+        - service
+  /service/organisation/logoimage:
+    get:
+      deprecated: false
+      description: Read organization logo image
+      operationId: serviceReadOrganisationLogoImage
+      responses:
+        '200':
+          headers: {}
+      security:
+        - BearerAuth: []
+      tags:
+        - service
   /service/idp/open-id:
     get:
       description: READ - Read an IDP

diff --git a/openapi/v2023.8.2/index.yaml b/openapi/v2023.8.2/index.yaml
@@ -186,6 +186,9 @@ paths:
       $ref: "./paths/configUpdateApiKey.yaml"
     delete:
       $ref: "./paths/configDeleteApiKey.yaml"
+  /config/privacy-dashboard:
+    get:
+      $ref: "./paths/configReadPrivacyDashboard.yaml"
   /onboard/admin:
     put:
       $ref: "./paths/onboardUpdateAdmin.yaml"
@@ -242,6 +245,12 @@ paths:
   /onboard/verify/phone:
     post:
       $ref: ./paths/verifyPhone.yaml
+  /service/organisation/coverimage:
+    get:
+      $ref: ./paths/serviceReadOrganisationCoverImage.yaml
+  /service/organisation/logoimage:
+    get:
+      $ref: ./paths/serviceReadOrganisationLogoImage.yaml
   /service/idp/open-id:
     get:
       $ref: ./paths/serviceReadIdp.yaml

diff --git a/openapi/v2023.8.2/paths/configPrivacyDashboard.yaml b/openapi/v2023.8.2/paths/configPrivacyDashboard.yaml
diff --git a/openapi/v2023.8.2/paths/configReadPrivacyDashboard.yaml b/openapi/v2023.8.2/paths/configReadPrivacyDashboard.yaml
@@ -0,0 +1,25 @@
+deprecated: false
+description: Read privacy dashboard
+operationId: readPrivacyDashboard
+responses:
+  '200':
+    content:
+      application/json:
+        schema:
+          properties:
+            hostName: 
+              type: string      
+            version:
+              type: string
+            state:
+              type: int
+            stateStr:
+              type: string
+          required:
+          - privacydashboard
+          type: object
+    description: OK
+security:
+- BearerAuth: []
+tags:
+- config
diff --git a/openapi/v2023.8.2/paths/serviceReadOrganisationCoverImage.yaml b/openapi/v2023.8.2/paths/serviceReadOrganisationCoverImage.yaml
@@ -0,0 +1,10 @@
+deprecated: false
+description: Read organization cover image
+operationId: serviceReadOrganisationCoverImage
+responses:
+  '200':
+    headers: {}
+security:
+- BearerAuth: []
+tags:
+- service
diff --git a/openapi/v2023.8.2/paths/serviceReadOrganisationLogoImage.yaml b/openapi/v2023.8.2/paths/serviceReadOrganisationLogoImage.yaml
@@ -0,0 +1,10 @@
+deprecated: false
+description: Read organization logo image
+operationId: serviceReadOrganisationLogoImage
+responses:
+  '200':
+    headers: {}
+security:
+- BearerAuth: []
+tags:
+- service