📝 Update openapi spec

didx-xyz · Dec 2, 2024 · d128a5e · d128a5e
1 parent 478e4f5
commit d128a5e
Show file tree

Hide file tree

Showing 4 changed files with 902 additions and 274 deletions.
diff --git a/openapi/tenant-admin-openapi.json b/openapi/tenant-admin-openapi.json
@@ -187,7 +187,7 @@
       "get": {
         "tags": ["sse"],
         "summary": "Subscribe To A Wallet Event By Topic, Field, And Desired State",
-        "description": "Wait for a desired state to be reached for some event for this wallet and topic,\nfiltering for payloads that contain `field:field_id`.\n\nParameters:\n-----------\n    wallet_id: The ID of the wallet subscribing to the events.\n    topic: The topic to which the wallet is subscribing.\n    field: The field to which the wallet is subscribing.\n    field_id: The ID of the field subscribing to the events.\n    desired_state: The desired state to be reached.",
+        "description": "Subscribe to SSE events wait for a desired state with a field filter.\n---\n***This endpoint can't be called on the swagger UI, as it requires a stream response.***\n\nWait for a desired state to be reached for some event for this wallet and topic,\nfiltering for payloads that contain `field:field_id`.\n\nexample: `/{wallet_id}/credentials/connection_id/some-uuid/done` will stream a credential exchange event on a\nspecific connection with state done.\nThe field and field ID pair must be present in the payload (other than state) for the event to be streamed.\nThe stream will be closed after the event is returned.\n\nParameters:\n-----------\n    wallet_id:\n        The ID of the wallet subscribing to the events.\n    topic:\n        The topic to which the wallet is subscribing.\n    field:\n        The field to which the wallet is subscribing.\n    field_id:\n        The ID of the field subscribing to the events.\n    desired_state:\n        The desired state to be reached.\n    look_back:\n        Number of seconds to look back for events before subscribing.",
         "operationId": "Subscribe_to_a_Wallet_Event_by_Topic__Field__and_Desired_State_v1_sse__wallet_id___topic___field___field_id___desired_state__get",
         "security": [{ "APIKeyHeader": [] }],
         "parameters": [
@@ -200,6 +200,18 @@
             "in": "path",
             "required": true,
             "schema": { "type": "string", "title": "Desired State" }
+          },
+          {
+            "name": "look_back",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [{ "type": "integer" }, { "type": "null" }],
+              "description": "Number of seconds to look back for events",
+              "default": 60,
+              "title": "Look Back"
+            },
+            "description": "Number of seconds to look back for events"
           }
         ],
         "responses": {
@@ -250,7 +262,7 @@
             "anyOf": [{ "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" }],
             "title": "Extra Settings",
             "description": "Optional per-tenant settings to configure wallet behaviour for advanced users.",
-            "examples": [{ "ACAPY_AUTO_PING_CONNECTION": true }]
+            "examples": [{ "ACAPY_AUTO_ACCEPT_INVITES": false }]
           }
         },
         "type": "object",
@@ -341,7 +353,7 @@
             "anyOf": [{ "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" }],
             "title": "Extra Settings",
             "description": "Optional per-tenant settings to configure wallet behaviour for advanced users.",
-            "examples": [{ "ACAPY_AUTO_PING_CONNECTION": true }]
+            "examples": [{ "ACAPY_AUTO_ACCEPT_INVITES": false }]
           }
         },
         "type": "object",

diff --git a/openapi/tenant-admin-openapi.yaml b/openapi/tenant-admin-openapi.yaml
@@ -235,13 +235,21 @@ paths:
       tags:
         - sse
       summary: Subscribe To A Wallet Event By Topic, Field, And Desired State
-      description: "Wait for a desired state to be reached for some event for this\
-        \ wallet and topic,\nfiltering for payloads that contain `field:field_id`.\n\
-        \nParameters:\n-----------\n    wallet_id: The ID of the wallet subscribing\
-        \ to the events.\n    topic: The topic to which the wallet is subscribing.\n\
-        \    field: The field to which the wallet is subscribing.\n    field_id: The\
-        \ ID of the field subscribing to the events.\n    desired_state: The desired\
-        \ state to be reached."
+      description: "Subscribe to SSE events wait for a desired state with a field\
+        \ filter.\n---\n***This endpoint can't be called on the swagger UI, as it\
+        \ requires a stream response.***\n\nWait for a desired state to be reached\
+        \ for some event for this wallet and topic,\nfiltering for payloads that contain\
+        \ `field:field_id`.\n\nexample: `/{wallet_id}/credentials/connection_id/some-uuid/done`\
+        \ will stream a credential exchange event on a\nspecific connection with state\
+        \ done.\nThe field and field ID pair must be present in the payload (other\
+        \ than state) for the event to be streamed.\nThe stream will be closed after\
+        \ the event is returned.\n\nParameters:\n-----------\n    wallet_id:\n   \
+        \     The ID of the wallet subscribing to the events.\n    topic:\n      \
+        \  The topic to which the wallet is subscribing.\n    field:\n        The\
+        \ field to which the wallet is subscribing.\n    field_id:\n        The ID\
+        \ of the field subscribing to the events.\n    desired_state:\n        The\
+        \ desired state to be reached.\n    look_back:\n        Number of seconds\
+        \ to look back for events before subscribing."
       operationId: Subscribe_to_a_Wallet_Event_by_Topic__Field__and_Desired_State_v1_sse__wallet_id___topic___field___field_id___desired_state__get
       security:
         - APIKeyHeader: []
@@ -276,6 +284,17 @@ paths:
           schema:
             type: string
             title: Desired State
+        - name: look_back
+          in: query
+          required: false
+          schema:
+            anyOf:
+              - type: integer
+              - type: "null"
+            description: Number of seconds to look back for events
+            default: 60
+            title: Look Back
+          description: Number of seconds to look back for events
       responses:
         "200":
           description: Successful Response
@@ -344,7 +363,7 @@ components:
           description: Optional per-tenant settings to configure wallet behaviour
             for advanced users.
           examples:
-            - ACAPY_AUTO_PING_CONNECTION: true
+            - ACAPY_AUTO_ACCEPT_INVITES: false
       type: object
       required:
         - wallet_label
@@ -511,7 +530,7 @@ components:
           description: Optional per-tenant settings to configure wallet behaviour
             for advanced users.
           examples:
-            - ACAPY_AUTO_PING_CONNECTION: true
+            - ACAPY_AUTO_ACCEPT_INVITES: false
       type: object
       title: UpdateTenantRequest
     ValidationError: