Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
94 changes: 48 additions & 46 deletions api-specs/openrpc-dapp-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/StatusEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/StatusEvent"
}
},
"description": "Returns the current status of the wallet gateway session."
Expand All @@ -23,7 +23,7 @@
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/StatusEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/StatusEvent"
}
},
"description": "Ensures ledger connectivity and returns the connected network information along with the user access token. Network ID should follow CAIP-2 and represent the synchronizerId."
Expand All @@ -34,7 +34,7 @@
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/Null"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/Null"
}
},
"description": "Invoke a disconnect of the wallet gateway session."
Expand Down Expand Up @@ -69,7 +69,7 @@
"name": "params",
"schema": {
"title": "prepareReturnParams",
"$ref": "#/components/schemas/JsPrepareSubmissionRequest"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/JsPrepareSubmissionRequest"
}
}
],
Expand All @@ -79,7 +79,7 @@
"title": "prepareReturnResult",
"properties": {
"response": {
"$ref": "#/components/schemas/JsPrepareSubmissionResponse"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/JsPrepareSubmissionResponse"
}
},
"required": ["response"]
Expand All @@ -94,7 +94,7 @@
"name": "params",
"schema": {
"title": "prepareExecuteParams",
"$ref": "#/components/schemas/JsPrepareSubmissionRequest"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/JsPrepareSubmissionRequest"
}
}
],
Expand All @@ -105,7 +105,7 @@
"type": "object",
"properties": {
"tx": {
"$ref": "#/components/schemas/TxChangedExecutedEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedExecutedEvent"
}
},
"required": ["tx"]
Expand All @@ -120,30 +120,14 @@
"name": "params",
"schema": {
"title": "ledgerApiParams",
"type": "object",
"properties": {
"requestMethod": {
"title": "requestMethod",
"type": "string",
"enum": ["GET", "POST", "PUT", "DELETE"]
},
"resource": {
"title": "resource",
"type": "string"
},
"body": {
"title": "body",
"type": "string"
}
},
"required": ["requestMethod", "resource"]
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/LedgerApiRequest"
}
}
],
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/LedgerApiResult"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/LedgerApiResult"
}
},
"description": "Proxy for the JSON-API endpoints. Injects authorization headers automatically."
Expand All @@ -154,7 +138,7 @@
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/AccountsChangedEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/AccountsChangedEvent"
}
}
},
Expand All @@ -164,7 +148,7 @@
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/RequestAccountsResult"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/RequestAccountsResult"
}
},
"description": "Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used."
Expand All @@ -175,7 +159,7 @@
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/TxChangedEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedEvent"
}
}
}
Expand Down Expand Up @@ -209,7 +193,7 @@
"description": "The URL of the Wallet Gateway."
},
"userUrl": {
"$ref": "#/components/schemas/UserUrl"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/UserUrl"
}
},
"required": ["id", "clientType"]
Expand Down Expand Up @@ -238,10 +222,10 @@
"description": "Structure representing the request for prepare and execute calls",
"properties": {
"commandId": {
"$ref": "#/components/schemas/CommandId"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/CommandId"
},
"commands": {
"$ref": "#/components/schemas/JsCommands"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/JsCommands"
},
"actAs": {
"title": "actAs",
Expand All @@ -266,7 +250,7 @@
"type": "array",
"description": "List of contract IDs to be disclosed with the command.",
"items": {
"$ref": "#/components/schemas/DisclosedContract"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/DisclosedContract"
}
},
"synchronizerId": {
Expand Down Expand Up @@ -336,6 +320,27 @@
}
}
},
"LedgerApiRequest": {
"title": "LedgerApiRequest",
"type": "object",
"description": "Ledger API request structure",
"properties": {
"requestMethod": {
"title": "requestMethod",
"type": "string",
"enum": ["GET", "POST", "PUT", "DELETE"]
},
"resource": {
"title": "resource",
"type": "string"
},
"body": {
"title": "body",
"type": "string"
}
},
"required": ["requestMethod", "resource"]
},
"AccountsChangedEvent": {
"title": "AccountsChangedEvent",
"type": "array",
Expand Down Expand Up @@ -370,7 +375,7 @@
"description": "The status of the transaction."
},
"commandId": {
"$ref": "#/components/schemas/CommandId"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/CommandId"
}
},
"required": ["status", "commandId"]
Expand Down Expand Up @@ -412,10 +417,10 @@
"description": "The status of the transaction."
},
"commandId": {
"$ref": "#/components/schemas/CommandId"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/CommandId"
},
"payload": {
"$ref": "#/components/schemas/TxChangedSignedPayload"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedSignedPayload"
}
},
"required": ["status", "commandId", "payload"]
Expand Down Expand Up @@ -451,10 +456,10 @@
"description": "The status of the transaction."
},
"commandId": {
"$ref": "#/components/schemas/CommandId"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/CommandId"
},
"payload": {
"$ref": "#/components/schemas/TxChangedExecutedPayload"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedExecutedPayload"
}
},
"required": ["status", "commandId", "payload"]
Expand All @@ -472,7 +477,7 @@
"description": "The status of the transaction."
},
"commandId": {
"$ref": "#/components/schemas/CommandId"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/CommandId"
}
},
"required": ["status", "commandId"]
Expand All @@ -482,16 +487,16 @@
"description": "Event emitted when a transaction changes.",
"oneOf": [
{
"$ref": "#/components/schemas/TxChangedPendingEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedPendingEvent"
},
{
"$ref": "#/components/schemas/TxChangedSignedEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedSignedEvent"
},
{
"$ref": "#/components/schemas/TxChangedExecutedEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedExecutedEvent"
},
{
"$ref": "#/components/schemas/TxChangedFailedEvent"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/TxChangedFailedEvent"
}
]
},
Expand All @@ -500,7 +505,7 @@
"type": "object",
"properties": {
"kernel": {
"$ref": "#/components/schemas/KernelInfo"
"$ref": "api-specs/openrpc-dapp-api.json#/components/schemas/KernelInfo"
},
"isConnected": {
"title": "isConnected",
Expand All @@ -517,9 +522,6 @@
"type": "string",
"description": "If not connected to a network, the reason why."
},
"userUrl": {
"$ref": "#/components/schemas/UserUrl"
},
"network": {
"title": "network",
"type": "object",
Expand Down
Loading
Loading