Add docstrings for OpenApi documentation for keria rest endpoints (We…

…bOfTrust#252) * Add docstrings for OpenApi documentation for keria rest endpoints * Uncomment operation resource end * Fix specing test --------- Co-authored-by: Rubel Hassan Mollik <rubel.hassan@outlook.com>
pfeairheller · Jun 6, 2024 · 6702a30 · 6702a30
1 parent 6b33043
commit 6702a30
Show file tree

Hide file tree

Showing 6 changed files with 454 additions and 41 deletions.
diff --git a/src/keria/app/agenting.py b/src/keria/app/agenting.py
@@ -904,11 +904,11 @@ def on_get(req, rep):
            - Key Event Log
         parameters:
           - in: path
-            name: prefix
+            name: pre
+            description: qb64 identifier prefix of KEL to load
             schema:
               type: string
             required: true
-            description: qb64 identifier prefix of KEL to load
         responses:
            200:
               description: Key event log and key state of identifier
@@ -955,7 +955,7 @@ def on_get(req, rep):
            - Key Event Log
         parameters:
           - in: path
-            name: prefix
+            name: pre
             schema:
               type: string
             required: true
@@ -1013,12 +1013,13 @@ def on_post(req, rep):
             content:
               application/json:
                 schema:
-                    description: OOBI
-                    properties:
+                  description: OOBI
+                  oneOf:
+                    - type: object
+                      properties:
                         oobialias:
                           type: string
                           description: alias to assign to the identifier resolved from this OOBI
-                          required: false
                         url:
                           type: string
                           description:  URL OOBI
@@ -1165,13 +1166,24 @@ def on_post(req, rep):
                       identifier along with the KEL and all associated signatures and receipts
         tags:
           - Query
-        parameters:
-          - in: body
-            name: pre
-            schema:
-              type: string
-            required: true
-            description: qb64 identifier prefix of KEL to load
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                    - pre
+                properties:
+                  pre:
+                    type: string
+                    description: qb64 identifier prefix of KEL to load
+                  anchor:
+                    type: string
+                    description: Anchor
+                  sn:
+                    type: string
+                    description: Serial number
         responses:
            200:
               description: Key event log and key state of identifier