Skip to content

Commit

Permalink
Merge pull request #1087 from AntelopeIO/fix-devrel#205-4.0
Browse files Browse the repository at this point in the history
[4.0] Update swagger files to include missing doc
  • Loading branch information
iamveritas authored May 2, 2023
2 parents b0290bb + 079935e commit 5a0f78f
Showing 1 changed file with 103 additions and 4 deletions.
107 changes: 103 additions & 4 deletions plugins/chain_api_plugin/chain.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ paths:
description: Compression used, usually false
packed_context_free_data:
type: string
description: json to hex
description: JSON to hex
packed_trx:
type: string
description: Transaction object json to hex
description: Transaction object JSON to hex
responses:
"200":
description: OK
Expand Down Expand Up @@ -154,10 +154,10 @@ paths:
description: Compression used, usually false
packed_context_free_data:
type: string
description: json to hex
description: JSON to hex
packed_trx:
type: string
description: Transaction object json to hex
description: Transaction object JSON to hex

responses:
"200":
Expand Down Expand Up @@ -724,3 +724,102 @@ paths:
threshold:
type: "integer"
description: the sum of weights that must be met or exceeded to satisfy the permission
/get_transaction_status:
post:
description: Attempts to get current blockchain state and, if available, transaction information given the transaction id. For query to work, the transaction finality status feature must be enabled by configuring the chain plugin with the config option '--transaction-finality-status-max-storage-size-gb' in nodeos.
operationId: get_transaction_status
requestBody:
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: string
description: The transaction ID of the transaction to retrieve the status for.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "https://docs.eosnetwork.com/openapi/v2.0/TransactionStatus.yaml"

/send_transaction2:
post:
description: Attempts to apply a transaction to the blockchain specified in JSON format. It supports returning the full trace of a failed transaction and automatic nodeos-mediated retry if it is enabled on the node. When transaction retry is enabled on an API node, it will monitor incoming API transactions and ensure they are resubmitted additional times into the P2P network until they expire or are included in a block. Warning, full failure traces are now returned by default instead of exceptions. Be careful to not confuse a returned trace as an indication of speculative execution success. Verify 'receipt' and 'except' fields of the returned trace.
operationId: send_transaction2
requestBody:
content:
application/json:
schema:
type: object
properties:
return_failure_trace:
type: boolean
description: If true, then embed transaction exceptions into the returned transaction trace.
retry_trx:
type: boolean
description: If true, requests to retry transaction until gets in a block of given height, see retry_trx_num_blocks as well, or it is irreversible or expires.
retry_trx_num_blocks:
type: integer
description: If retry_trx is true, requests to retry transaction until in a block of given height, or lib if not specified.
transaction:
type: object
properties:
signatures:
type: array
description: array of signatures required to authorize transaction.
items:
$ref: "https://docs.eosnetwork.com/openapi/v2.0/Signature.yaml"
compression:
type: boolean
description: Compression used, usually false
packed_context_free_data:
type: string
description: JSON to hex
packed_trx:
type: string
description: Transaction object JSON to hex
responses:
"200":
description: OK
content:
application/json:
schema:
description: Returns Nothing

/compute_transaction:
post:
description: Executes specified transaction and creates a transaction trace, including resource usage, and then reverts all state changes but not contribute to the subjective billing for the account. If the transaction has signatures, they are processed, but any failures are ignored. Transactions which fail always include the transaction failure trace. Warning, users with exposed nodes who have enabled the compute_transaction endpoint should implement some sort of throttling to protect from Denial of Service attacks.
operationId: compute_transaction
requestBody:
content:
application/json:
schema:
type: object
properties:
signatures:
type: array
description: array of signatures required to authorize transaction
items:
$ref: "https://docs.eosnetwork.com/openapi/v2.0/Signature.yaml"
compression:
type: boolean
description: Compression used, usually false
packed_context_free_data:
type: string
description: JSON to hex
packed_trx:
type: string
description: Transaction object, JSON to hex

responses:
"200":
description: OK
content:
application/json:
schema:
description: Returns Nothing

0 comments on commit 5a0f78f

Please sign in to comment.