This repository has been archived by the owner on Jun 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Update swagger documentation for transactions dryrun
- Loading branch information
1 parent
2d55c42
commit 5a68969
Showing
1 changed file
with
66 additions
and
66 deletions.
There are no files selected for viewing
132 changes: 66 additions & 66 deletions
132
services/gateway/apis/http-version3/swagger/parameters/transactions.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,68 @@ | ||
| { | ||
| "executionStatus": { | ||
| "name": "executionStatus", | ||
| "in": "query", | ||
| "description": "Query transactions by their executionStatus.\nAccepted values: pending, successful, failed.", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "transaction": { | ||
| "name": "body", | ||
| "in": "body", | ||
| "required": true, | ||
| "description": "The request body can contain only one property:\n- transaction (required): Binary payload", | ||
| "schema": { | ||
| "$ref": "#/definitions/transactionParamEnvelope" | ||
| } | ||
| }, | ||
| "dryrunTransaction": { | ||
| "name": "dryrunTransaction", | ||
| "in": "body", | ||
| "required": true, | ||
| "description": "The request body can contain three properties:\n- transaction (required): Binary payload or a transaction object\n- skipVerify (optional, default: false): A boolean indicator to skip the transaction verification\n- skipDecode (optional, default: false): A boolean indicator to skip the auto-decoding of the event data", | ||
| "schema": { | ||
| "$ref": "#/definitions/dryrunTransactionParamEnvelope" | ||
| } | ||
| }, | ||
| "recipientAddress": { | ||
| "name": "recipientAddress", | ||
| "in": "query", | ||
| "description": "Lisk account address", | ||
| "type": "string", | ||
| "minLength": 3, | ||
| "maxLength": 41 | ||
| }, | ||
| "senderAddress": { | ||
| "name": "senderAddress", | ||
| "in": "query", | ||
| "description": "Lisk account address", | ||
| "type": "string", | ||
| "minLength": 3, | ||
| "maxLength": 41 | ||
| }, | ||
| "transactionID": { | ||
| "name": "transactionID", | ||
| "in": "query", | ||
| "description": "Transaction ID to query", | ||
| "type": "string", | ||
| "format": "id", | ||
| "minLength": 1, | ||
| "maxLength": 64 | ||
| }, | ||
| "nonce": { | ||
| "name": "nonce", | ||
| "in": "query", | ||
| "description": "Query by nonce", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "transactionEstimateFees": { | ||
| "name": "transaction", | ||
| "in": "body", | ||
| "required": true, | ||
| "description": "The request body can only contain one property:\n- transaction (required): Transaction object\n\n Note:\n - The transaction object must contain the following properties: module, command, nonce, senderPublicKey and params.\n - All types of transactions require valid params as defined in the schema except the 'transferCrossChain' (messageFee and messageFeeTokenID can be mocked if not passed).", | ||
| "schema": { | ||
| "$ref": "#/definitions/transactionEstimateFeesRequestBody" | ||
| } | ||
| } | ||
| "executionStatus": { | ||
| "name": "executionStatus", | ||
| "in": "query", | ||
| "description": "Query transactions by their executionStatus.\nAccepted values: pending, successful, failed.", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "transaction": { | ||
| "name": "body", | ||
| "in": "body", | ||
| "required": true, | ||
| "description": "The request body can contain only one property:\n- transaction (required): Binary payload", | ||
| "schema": { | ||
| "$ref": "#/definitions/transactionParamEnvelope" | ||
| } | ||
| }, | ||
| "dryrunTransaction": { | ||
| "name": "dryrunTransaction", | ||
| "in": "body", | ||
| "required": true, | ||
| "description": "The request body can contain three properties:\n- transaction (required): Binary payload or a transaction object\n- skipVerify (optional, default: false): A boolean indicator to skip the transaction verification\n- strict (optional, default: false): A boolean indicator to enable strict mode. When set false, it skips the nonce and signature checks\n- skipDecode (optional, default: false): A boolean indicator to skip the auto-decoding of the event data", | ||
| "schema": { | ||
| "$ref": "#/definitions/dryrunTransactionParamEnvelope" | ||
| } | ||
| }, | ||
| "recipientAddress": { | ||
| "name": "recipientAddress", | ||
| "in": "query", | ||
| "description": "Lisk account address", | ||
| "type": "string", | ||
| "minLength": 3, | ||
| "maxLength": 41 | ||
| }, | ||
| "senderAddress": { | ||
| "name": "senderAddress", | ||
| "in": "query", | ||
| "description": "Lisk account address", | ||
| "type": "string", | ||
| "minLength": 3, | ||
| "maxLength": 41 | ||
| }, | ||
| "transactionID": { | ||
| "name": "transactionID", | ||
| "in": "query", | ||
| "description": "Transaction ID to query", | ||
| "type": "string", | ||
| "format": "id", | ||
| "minLength": 1, | ||
| "maxLength": 64 | ||
| }, | ||
| "nonce": { | ||
| "name": "nonce", | ||
| "in": "query", | ||
| "description": "Query by nonce", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "transactionEstimateFees": { | ||
| "name": "transaction", | ||
| "in": "body", | ||
| "required": true, | ||
| "description": "The request body can only contain one property:\n- transaction (required): Transaction object\n\n Note:\n - The transaction object must contain the following properties: module, command, nonce, senderPublicKey and params.\n - All types of transactions require valid params as defined in the schema except the 'transferCrossChain' (messageFee and messageFeeTokenID can be mocked if not passed).", | ||
| "schema": { | ||
| "$ref": "#/definitions/transactionEstimateFeesRequestBody" | ||
| } | ||
| } | ||
| } |