Add #13 Add read status endpoint

decentralised-dataexchange · Oct 26, 2023 · 115882f · 115882f
1 parent eda8792
commit 115882f
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 2 deletions.
diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml
@@ -3246,6 +3246,30 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
+  /onboard/status:
+    get:
+      deprecated: false
+      description: READ - Read status
+      operationId: onboardReadStatus
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  applicationMode:
+                    type: string
+                  version:
+                    type: string
+                  candidate:
+                    type: string
+                  revision:
+                    type: string
+          description: OK
+      security:
+        - BearerAuth: []
+      tags:
+        - onboard
   /service/organisation/coverimage:
     get:
       deprecated: false
@@ -3323,7 +3347,7 @@ paths:
     get:
       deprecated: false
       description: Read organization
-      operationId: readOrganisation
+      operationId: serviceReadOrganisation
       responses:
         '200':
           content:

diff --git a/openapi/v2023.8.2/index.yaml b/openapi/v2023.8.2/index.yaml
@@ -245,6 +245,9 @@ paths:
   /onboard/verify/phone:
     post:
       $ref: ./paths/verifyPhone.yaml
+  /onboard/status:
+    get:
+      $ref: ./paths/onboardReadStatus.yaml
   /service/organisation/coverimage:
     get:
       $ref: ./paths/serviceReadOrganisationCoverImage.yaml

diff --git a/openapi/v2023.8.2/paths/configReadPrivacyDashboard.yaml b/openapi/v2023.8.2/paths/configReadPrivacyDashboard.yaml
@@ -7,7 +7,7 @@ responses:
       application/json:
         schema:
           properties:
-            hostName: 
+            hostname: 
               type: string      
             version:
               type: string

diff --git a/openapi/v2023.8.2/paths/onboardReadStatus.yaml b/openapi/v2023.8.2/paths/onboardReadStatus.yaml
@@ -0,0 +1,22 @@
+deprecated: false
+description: READ - Read status
+operationId: onboardReadStatus
+responses:
+  "200":
+    content:
+      application/json:
+        schema:
+          properties:
+            applicationMode: 
+              type: string      
+            version:
+              type: string
+            candidate:
+              type: string
+            revision:
+              type: string
+    description: OK
+security:
+  - BearerAuth: []
+tags:
+  - onboard