From 5a689690eab0a8d13781e82a07db2d401f2cebc0 Mon Sep 17 00:00:00 2001 From: Sameer Kumar Subudhi Date: Fri, 18 Aug 2023 11:34:23 +0200 Subject: [PATCH] :pencil: Update swagger documentation for transactions dryrun --- .../swagger/parameters/transactions.json | 132 +++++++++--------- 1 file changed, 66 insertions(+), 66 deletions(-) diff --git a/services/gateway/apis/http-version3/swagger/parameters/transactions.json b/services/gateway/apis/http-version3/swagger/parameters/transactions.json index 7760056a94..3d02bf80ac 100644 --- a/services/gateway/apis/http-version3/swagger/parameters/transactions.json +++ b/services/gateway/apis/http-version3/swagger/parameters/transactions.json @@ -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" + } + } }