Skip to content

Commit

Permalink
📝 Update openapi specs (#1006)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ff137
ff137 authored Sep 3, 2024
1 parent f5a75fd commit 6df55dd
Show file tree
Hide file tree
Showing 4 changed files with 629 additions and 127 deletions.
79 changes: 58 additions & 21 deletions openapi/tenant-admin-openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
"info": {
"title": "CloudAPI-Multitenant-Admin",
"description": "\nWelcome to the Aries CloudAPI Python project.\n\nIn addition to the traditional HTTP-based endpoints described below, we also offer WebSocket endpoints for\nreal-time interfacing with webhook events.\n\nWebSocket endpoints are authenticated. This means that only users with valid authentication tokens can establish\na WebSocket connection, and they can only subscribe to their own wallet's events. However, Admin users have the\nability to subscribe by topic, or to any wallet in their group.\n\nOur WebSocket endpoints are as follows:\n\n1. `/v1/ws/`: This endpoint allows admins to receive all webhook events for their group.\n\n2. `/v1/ws/{wallet_id}`: This endpoint allows admins (or authenticated users holding this wallet) to receive webhook\nevents for a specific wallet ID.\n\n3. `/v1/ws/{wallet_id}/{topic}`: Similar to above, but subscribing to a specific topic.\n\n4. `/v1/ws/topic/{topic}`: This endpoint allows admins to receive all webhook events on a specific topic (e.g.\n`connections`, `credentials`, `proofs`, `endorsements`).\n\nFor authentication, the WebSocket headers should include `x-api-key`: `<your key>`.\n\nPlease refer to our API documentation for more details about our authentication mechanism, as well as for information\nabout the available topics.\n",
"version": "0.12.1"
"version": "1.0.0"
},
"servers": [{ "url": "/tenant-admin" }],
"paths": {
"/v1/tenants": {
"post": {
Expand Down Expand Up @@ -40,6 +41,42 @@
"in": "query",
"required": false,
"schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Wallet Name" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }],
"description": "Number of results to return",
"default": 1000,
"title": "Limit"
},
"description": "Number of results to return"
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }],
"description": "Offset for pagination",
"default": 0,
"title": "Offset"
},
"description": "Offset for pagination"
},
{
"name": "descending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to return results in descending order. Results are ordered by record created time.",
"default": true,
"title": "Descending"
},
"description": "Whether to return results in descending order. Results are ordered by record created time."
}
],
"responses": {
Expand Down Expand Up @@ -237,13 +274,13 @@
"required": false,
"schema": {
"type": "number",
"maximum": 30.0,
"maximum": 10.0,
"minimum": 0.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 30.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 10.0,
"title": "Look Back"
},
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
}
],
"responses": {
Expand Down Expand Up @@ -271,13 +308,13 @@
"required": false,
"schema": {
"type": "number",
"maximum": 30.0,
"maximum": 10.0,
"minimum": 0.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 30.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 10.0,
"title": "Look Back"
},
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
}
],
"responses": {
Expand Down Expand Up @@ -311,13 +348,13 @@
"required": false,
"schema": {
"type": "number",
"maximum": 30.0,
"maximum": 10.0,
"minimum": 0.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 30.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 10.0,
"title": "Look Back"
},
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
}
],
"responses": {
Expand Down Expand Up @@ -347,13 +384,13 @@
"required": false,
"schema": {
"type": "number",
"maximum": 30.0,
"maximum": 10.0,
"minimum": 0.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 30.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 10.0,
"title": "Look Back"
},
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
}
],
"responses": {
Expand Down Expand Up @@ -389,13 +426,13 @@
"required": false,
"schema": {
"type": "number",
"maximum": 30.0,
"maximum": 10.0,
"minimum": 0.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 30.0,
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned.",
"default": 10.0,
"title": "Look Back"
},
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 30.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
"description": "The duration in seconds to look back in time, defining the window of additional webhook events that should be included, prior to the initial connection of the stream. The default value will include events up to 10.0 seconds ago, and represents the maximum value for this setting. Setting to 0 means only events after the connection is established will be returned."
}
],
"responses": {
Expand Down
Loading

0 comments on commit 6df55dd

Please sign in to comment.