-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(
GET /api/state/get
): add missing params
- Loading branch information
Showing
5 changed files
with
90 additions
and
43 deletions.
There are no files selected for viewing
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,43 +1,47 @@ | ||
- name: key | ||
in: query | ||
required: false | ||
schema: | ||
type: string | ||
example: eth:address | ||
- name: keyIds | ||
in: query | ||
required: false | ||
schema: | ||
type: array | ||
items: | ||
type: string | ||
example: | ||
- eth:address | ||
- doge:address | ||
- dash:address | ||
- btc:address | ||
description: Array of keys, comma-separated in string format | ||
- name: senderId | ||
in: query | ||
required: false | ||
schema: | ||
type: string | ||
example: U14236667426471084862 | ||
- name: senderIds | ||
in: query | ||
required: false | ||
schema: | ||
type: array | ||
items: | ||
type: string | ||
example: | ||
- U3461022864428928223 | ||
- U17790659840463725618 | ||
- U43512412354440829 | ||
description: Array of ADAMANT addresses, comma-separated in string format | ||
- name: orderBy | ||
in: query | ||
required: false | ||
schema: | ||
type: string | ||
example: timestamp:desc | ||
############################### | ||
####### Common filters ######## | ||
############################### | ||
|
||
# fromHeight | ||
- $ref: '../../common/params/filters/fromHeight/fromHeight.yaml' | ||
- $ref: '../../common/params/filters/fromHeight/andFromHeight.yaml' | ||
- $ref: '../../common/params/filters/fromHeight/orFromHeight.yaml' | ||
|
||
# toHeight | ||
- $ref: '../../common/params/filters/toHeight/toHeight.yaml' | ||
- $ref: '../../common/params/filters/toHeight/andToHeight.yaml' | ||
- $ref: '../../common/params/filters/toHeight/orToHeight.yaml' | ||
|
||
# senderId | ||
- $ref: '../../common/params/filters/senderId/senderId.yaml' | ||
- $ref: '../../common/params/filters/senderId/andSenderId.yaml' | ||
- $ref: '../../common/params/filters/senderId/orSenderId.yaml' | ||
|
||
# senderIds | ||
- $ref: '../../common/params/filters/senderIds/senderIds.yaml' | ||
- $ref: '../../common/params/filters/senderIds/andSenderIds.yaml' | ||
- $ref: '../../common/params/filters/senderIds/orSenderIds.yaml' | ||
|
||
############################### | ||
######## Common params ######## | ||
############################### | ||
|
||
# offset | ||
- $ref: '../../common/params/offset.yaml' | ||
|
||
# orderBy | ||
- $ref: '../../common/params/orderBy.yaml' | ||
|
||
############################### | ||
## Endpoint specific filters ## | ||
############################### | ||
|
||
- $ref: './params/filters/key.yaml' | ||
- $ref: './params/filters/keyIds.yaml' | ||
- $ref: './params/filters/type.yaml' | ||
|
||
############################### | ||
### Endpoint specific params ## | ||
############################### | ||
|
||
- $ref: './params/limit.yaml' |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
name: key | ||
in: query | ||
required: false | ||
schema: | ||
type: string | ||
example: eth:address | ||
description: Get transactions of specified KVS key |
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: keyIds | ||
in: query | ||
required: false | ||
schema: | ||
type: array | ||
items: | ||
type: string | ||
example: | ||
- eth:address | ||
- doge:address | ||
- dash:address | ||
- btc:address | ||
description: Get transactions of specified KVS keys. Array of keys, comma-separated. |
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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: type | ||
in: query | ||
description: | | ||
When sending KVS transaction, type field of state object must be as follows: | ||
- `0` for full re-writing of contents by specified key value | ||
- `1` for incremental appending contents | ||
For more details see [AIP 11: Behavior for KVS data](https://aips.adamant.im/AIPS/aip-11) | ||
schema: | ||
type: integer | ||
example: 1 | ||
default: 0 | ||
enum: [1, 2] | ||
required: false |
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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
name: limit | ||
in: query | ||
description: Limit number of transactions in the result | ||
schema: | ||
type: integer | ||
example: 10 | ||
default: 100 | ||
required: false |