Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update swagger (2023-10-25) #50

Merged
merged 1 commit into from
Oct 26, 2023
Merged

Update swagger (2023-10-25) #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
238 changes: 236 additions & 2 deletions api/public_api.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,32 @@
"tags": ["Users"]
}
},
"/public/v1/query/get_wallet": {
"post": {
"summary": "Get Wallet",
"description": "Get details about a Wallet",
"operationId": "GetWallet",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetWalletResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetWalletRequest"
}
}
],
"tags": ["Wallets"]
}
},
"/public/v1/query/list_activities": {
"post": {
"summary": "List Activities",
Expand Down Expand Up @@ -325,6 +351,58 @@
"tags": ["Users"]
}
},
"/public/v1/query/list_wallet_accounts": {
"post": {
"summary": "List Wallets Accounts",
"description": "List all Accounts wirhin a Wallet",
"operationId": "GetWalletAccounts",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetWalletAccountsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetWalletAccountsRequest"
}
}
],
"tags": ["Wallets"]
}
},
"/public/v1/query/list_wallets": {
"post": {
"summary": "List Wallets",
"description": "List all Wallets within an Organization",
"operationId": "GetWallets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetWalletsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetWalletsRequest"
}
}
],
"tags": ["Wallets"]
}
},
"/public/v1/query/whoami": {
"post": {
"summary": "Who am I?",
Expand Down Expand Up @@ -1003,8 +1081,8 @@
},
"/public/v1/submit/update_allowed_origins": {
"post": {
"summary": "Update Allowable Origins",
"description": "Update the allowable origins for credentials and requests",
"summary": "Update Allowed Origins",
"description": "Update the origins WebAuthN credentials are allowed to sign requests from. Setting this on a Parent-Organization applies to all Sub-Organizations.",
"operationId": "UpdateAllowedOrigins",
"responses": {
"200": {
Expand Down Expand Up @@ -3220,6 +3298,82 @@
},
"required": ["users"]
},
"GetWalletAccountsRequest": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Unique identifier for a given Organization."
},
"walletId": {
"type": "string",
"description": "Unique identifier for a given Wallet."
}
},
"required": ["organizationId", "walletId"]
},
"GetWalletAccountsResponse": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/WalletAccount"
},
"description": "A list of Accounts generated from a Wallet that share a common seed"
}
},
"required": ["accounts"]
},
"GetWalletRequest": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Unique identifier for a given Organization."
},
"walletId": {
"type": "string",
"description": "Unique identifier for a given Wallet."
}
},
"required": ["organizationId", "walletId"]
},
"GetWalletResponse": {
"type": "object",
"properties": {
"wallet": {
"$ref": "#/definitions/Wallet",
"description": "A collection of deterministically generated cryptographic public / private key pairs that share a common seed"
}
},
"required": ["wallet"]
},
"GetWalletsRequest": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Unique identifier for a given Organization."
}
},
"required": ["organizationId"]
},
"GetWalletsResponse": {
"type": "object",
"properties": {
"wallets": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Wallet"
},
"description": "A list of Wallets."
}
},
"required": ["wallets"]
},
"GetWhoamiRequest": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -4840,6 +4994,86 @@
"createdAt"
]
},
"Wallet": {
"type": "object",
"properties": {
"walletId": {
"type": "string",
"description": "Unique identifier for a given Wallet."
},
"walletName": {
"type": "string",
"description": "Human-readable name for a Wallet."
},
"createdAt": {
"$ref": "#/definitions/external.data.v1.Timestamp"
},
"updatedAt": {
"$ref": "#/definitions/external.data.v1.Timestamp"
},
"exported": {
"type": "boolean",
"description": "True when a given Wallet is exported, false otherwise."
}
},
"required": [
"walletId",
"walletName",
"createdAt",
"updatedAt",
"exported"
]
},
"WalletAccount": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The Organization the Account belongs to."
},
"walletId": {
"type": "string",
"description": "The Wallet the Account was derived from."
},
"curve": {
"$ref": "#/definitions/common.v1.Curve",
"description": "Cryptographic curve used to generate the Account."
},
"pathFormat": {
"$ref": "#/definitions/PathFormat",
"description": "Path format used to generate the Account."
},
"path": {
"type": "string",
"description": "Path used to generate the Account."
},
"addressFormat": {
"$ref": "#/definitions/common.v1.AddressFormat",
"description": "Address format used to generate the Acccount."
},
"address": {
"type": "string",
"description": "Address generated using the Wallet seed and Account parameters."
},
"createdAt": {
"$ref": "#/definitions/external.data.v1.Timestamp"
},
"updatedAt": {
"$ref": "#/definitions/external.data.v1.Timestamp"
}
},
"required": [
"organizationId",
"walletId",
"curve",
"pathFormat",
"path",
"addressFormat",
"address",
"createdAt",
"updatedAt"
]
},
"WalletAccountParams": {
"type": "object",
"properties": {
Expand Down