Add #37 Add service read image endpoint

decentralised-dataexchange · Nov 7, 2023 · b81d174 · b81d174
1 parent 34e1235
commit b81d174
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 2 deletions.
diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml
@@ -3179,7 +3179,24 @@ paths:
               schema:
                 properties:
                   organisation:
-                    $ref: '#/paths/~1onboard~1organisation/get/responses/200/content/application~1json/schema/properties/organisation'
+                    items:
+                      allOf:
+                        - $ref: '#/paths/~1onboard~1organisation/get/responses/200/content/application~1json/schema/properties/organisation'
+                        - type: object
+                          title: OrganisationExtras
+                          properties:
+                            coverImageId:
+                              type: string
+                              description: id of cover image
+                            coverImageUrl:
+                              type: string
+                              description: Cover image url
+                            logoImageId:
+                              type: string
+                              description: Logo image id
+                            logoImageUrl:
+                              type: string
+                              description: Logo image url
                 required:
                   - organisation
                 type: object
@@ -3990,6 +4007,18 @@ paths:
           description: bad input parameter
       security:
         - BearerAuth: []
+  '/service/image/{imageId}':
+    get:
+      deprecated: false
+      description: Get organization image
+      operationId: serviceReadOrganisationImage
+      responses:
+        '200':
+          headers: {}
+      security:
+        - BearerAuth: []
+      tags:
+        - service
   /audit/admin/logs:
     get:
       operationId: auditAdminLogs

diff --git a/openapi/v2023.8.2/definitions/OrganisationExtras.yaml b/openapi/v2023.8.2/definitions/OrganisationExtras.yaml
@@ -0,0 +1,16 @@
+type: object
+title: OrganisationExtras
+properties:
+  coverImageId:
+    type: string
+    description: "Cover image id"
+  coverImageUrl:
+    type: string
+    description: "Cover image url"
+  logoImageId:
+    type: string
+    description: "Logo image id"
+  logoImageUrl:
+    type: string
+    description: "Logo image url"
+
diff --git a/openapi/v2023.8.2/index.yaml b/openapi/v2023.8.2/index.yaml
@@ -317,6 +317,9 @@ paths:
   /service/individuals:
     get:
       $ref: ./paths/serviceListIndividuals.yaml
+  /service/image/{imageId}:
+    get:
+      $ref: ./paths/serviceReadOrganisationImage.yaml
   /audit/admin/logs:
     get:
       $ref: ./paths/auditAdminLogs.yaml

diff --git a/openapi/v2023.8.2/paths/serviceReadOrganisation.yaml b/openapi/v2023.8.2/paths/serviceReadOrganisation.yaml
@@ -8,7 +8,10 @@ responses:
         schema:
           properties:
             organisation:
-              $ref: ../definitions/Organisation.yaml
+              items:
+                allOf:
+                  - $ref: ../definitions/Organisation.yaml
+                  - $ref: "../definitions/OrganisationExtras.yaml"
           required:
           - organisation
           type: object

diff --git a/openapi/v2023.8.2/paths/serviceReadOrganisationImage.yaml b/openapi/v2023.8.2/paths/serviceReadOrganisationImage.yaml
@@ -0,0 +1,10 @@
+deprecated: false
+description: Get organization image
+operationId: serviceReadOrganisationImage
+responses:
+  '200':
+    headers: {}
+security:
+- BearerAuth: []
+tags:
+- service