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

docs: add transaction types to enum #2091

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add transaction types to enum #2091

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/swagger_v3/aexn.spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ schemas:
type: integer
tx_type:
description: Transaction type, indicating a state of a balance for that block height
type: string
$ref: '#/components/schemas/TransactionType'
required:
- amount
- block_hash
Expand Down
30 changes: 30 additions & 0 deletions docs/swagger_v3/base.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,33 @@ components:
required:
- next
- prev
TransactionType:
type: string
enum:
- SpendTx
- OracleRegisterTx
- OracleExtendTx
- OracleQueryTx
- OracleResponseTx
- NamePreclaimTx
- NameClaimTx
- NameTransferTx
- NameUpdateTx
- NameRevokeTx
- ContractCreateTx
- ContractCallTx
- GAAttachTx
- GAMetaTx
- ChannelCreateTx
- ChannelDepositTx
- ChannelWithdrawTx
- ChannelForceProgressTx
- ChannelCloseMutualTx
- ChannelCloseSoloTx
- ChannelSlashTx
- ChannelSettleTx
- ChannelSnapshotSoloTx
- ChannelSetDelegatesTx
- ChannelOffchainTx
- ChannelClientReconnectTx
- PayingForTx
2 changes: 1 addition & 1 deletion docs/swagger_v3/channels.spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ schemas:
description: The last height in which the channel was updated on chain
example: 141956
last_updated_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
description: The transaction type of the last transaction that updated the channel
example: ChannelDepositTx
last_updated_time:
Expand Down
2 changes: 1 addition & 1 deletion docs/swagger_v3/contracts.spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ schemas:
source_tx_hash:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
example: ContractCreateTx
create_tx:
type: object
Expand Down
11 changes: 5 additions & 6 deletions docs/swagger_v3/names.spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,7 @@ schemas:
items:
$ref: '#/components/schemas/Signature'
tx:
type: object
# TODO: define properties
$ref: '#/components/schemas/Tx'
example:
account_id: ak_2JJNMYcnqPaABiSY5omockmv4cCoZefv4XzStAxKe9gM2xYz2r
fee: 16540000000000
Expand Down Expand Up @@ -218,7 +217,7 @@ schemas:
source_tx_hash:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
example: NameClaimTx
block_hash:
$ref: '#/components/schemas/MicroBlockHash'
Expand Down Expand Up @@ -260,7 +259,7 @@ schemas:
source_tx_hash:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
example: NameTransferTx
tx:
type: object
Expand Down Expand Up @@ -296,7 +295,7 @@ schemas:
source_tx_hash:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
example: NameUpdateTx
tx:
type: object
Expand Down Expand Up @@ -352,7 +351,7 @@ schemas:
key: "account_pubkey"
ttl: 60000
source_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
example: NameUpdateTx
source_tx_hash:
$ref: '#/components/schemas/TransactionHash'
Expand Down
6 changes: 3 additions & 3 deletions docs/swagger_v3/oracles.spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ schemas:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
description: The type of the transaction in which the query was created, it can be either via a contract call or a query transaction
type: string
$ref: '#/components/schemas/TransactionType'
fee:
description: The transaction fee
type: integer
Expand Down Expand Up @@ -338,7 +338,7 @@ schemas:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
description: The type of the transaction in which the response was created, it can be either via a contract call or a respond transaction
type: string
$ref: '#/components/schemas/TransactionType'
fee:
description: The transaction fee
type: integer
Expand Down Expand Up @@ -398,7 +398,7 @@ schemas:
$ref: '#/components/schemas/TransactionHash'
source_tx_type:
description: The type of the transaction in which the extend was done, it can be either via a contract call or an extend transaction
type: string
$ref: '#/components/schemas/TransactionType'
tx:
type: object
required:
Expand Down
2 changes: 1 addition & 1 deletion docs/swagger_v3/transfers.spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ schemas:
nullable: true
$ref: '#/components/schemas/TransactionHash'
ref_tx_type:
type: string
$ref: '#/components/schemas/TransactionType'
nullable: true
example: ChannelDepositTx
paths:
Expand Down
Loading