Skip to content

API examples for Rosetta (partial) #1243

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

Closed
LakshmiLavanyaKasturi wants to merge 17 commits into from
Closed

API examples for Rosetta (partial) #1243

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
85a1992
API examples for Non-fungible tokens, Rosetta and search
LakshmiLavanyaKasturi Jul 19, 2022
bb6a251
Rosetta-examples
LakshmiLavanyaKasturi Jul 19, 2022
e230473
Fixed build error
LakshmiLavanyaKasturi Jul 19, 2022
deb7564
Added examples for rosetta api
LakshmiLavanyaKasturi Jul 20, 2022
b248b7a
rosetta api - block, mempool and derive_an_account_identifier
LakshmiLavanyaKasturi Jul 20, 2022
c95a759
Resolved build issue
LakshmiLavanyaKasturi Jul 21, 2022
3763aa7
Moved example under schema
LakshmiLavanyaKasturi Jul 21, 2022
c10c986
Fix the example error for build
LakshmiLavanyaKasturi Jul 21, 2022
038fa7e
Fixed the duplicate example for offsite name
LakshmiLavanyaKasturi Jul 21, 2022
95c34eb
Remove duplicate example
LakshmiLavanyaKasturi Jul 21, 2022
2c9639a
Revert rosseta changes to identify build failure
LakshmiLavanyaKasturi Jul 22, 2022
43de0da
Fix example for account schema.json
LakshmiLavanyaKasturi Jul 22, 2022
865aef0
Change the example structure for account-balance.schema
LakshmiLavanyaKasturi Jul 22, 2022
6ad462f
Added examples at schema level in the yaml file
LakshmiLavanyaKasturi Jul 25, 2022
7b070ad
Added examples at schema level
LakshmiLavanyaKasturi Jul 25, 2022
22ac9ab
Removed rosetta examples
LakshmiLavanyaKasturi Jul 25, 2022
63c1c51
Removed examples from the json file
LakshmiLavanyaKasturi Jul 26, 2022
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
25 changes: 15 additions & 10 deletions docs/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,6 @@ paths:
in: query
description: Index of the first microblock to fetch
required: false
example: 42000
schema:
type: integer
example: 1000
Expand Down Expand Up @@ -1207,7 +1206,7 @@ paths:

/extended/v1/address/{principal}/balances:
get:
summary: Get account balances
summary: Get account balance
description: Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
tags:
- Accounts
Expand Down Expand Up @@ -1263,7 +1262,6 @@ paths:
- name: unanchored
in: query
description: Include transaction data from unanchored (i.e. unconfirmed) microblocks.
example: true
required: false
schema:
type: boolean
Expand Down Expand Up @@ -1315,9 +1313,9 @@ paths:
in: query
description: index of first account transaction to fetch
required: false
example: 42000
schema:
type: integer
example: 42000
- name: height
in: query
description: Filter for transactions only at this given block height
Expand Down Expand Up @@ -2008,10 +2006,10 @@ paths:
post:
tags:
- Rosetta
summary: Get an Account Balance
summary: Get Account Balance
operationId: rosetta_account_balance
description: |
An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint.
Account_Balance_Request is utilized to make a balance request on the /account/balance endpoint.
If the block_identifier is populated, a historical balance query should be performed.
responses:
200:
Expand Down Expand Up @@ -2876,9 +2874,9 @@ paths:
in: query
description: index of first transaction to fetch
required: false
example: 42000
schema:
type: integer
example: 42000
- name: unanchored
in: query
description: Include transaction data from unanchored (i.e. unconfirmed) microblocks
Expand Down Expand Up @@ -2947,16 +2945,16 @@ paths:
in: query
description: token owner's STX address or Smart Contract ID
required: true
example: SPNWZ5V2TPWGQGVDR6T7B6RQ4XMGZ4PXTEE0VQ0S.marketplace-v3
schema:
type: string
example: SPNWZ5V2TPWGQGVDR6T7B6RQ4XMGZ4PXTEE0VQ0S.marketplace-v3
- name: asset_identifiers
in: query
description: identifiers of the token asset classes to filter for
required: false
example: SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy::candy
schema:
type: array
example: SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy::candy
items:
type: string
- name: limit
Expand All @@ -2966,6 +2964,7 @@ paths:
schema:
type: integer
default: 50
example: 100
- name: offset
in: query
description: index of first tokens to fetch
Expand All @@ -2974,6 +2973,7 @@ paths:
schema:
type: integer
default: 0
example: 42000
- name: unanchored
in: query
description: whether or not to include tokens from unconfirmed transactions
Expand All @@ -2989,6 +2989,7 @@ paths:
schema:
type: boolean
default: false
example: true
responses:
200:
description: List of Non-Fungible Token holdings
Expand Down Expand Up @@ -3036,6 +3037,7 @@ paths:
schema:
type: integer
default: 50
example: 100
- name: offset
in: query
description: index of first event to fetch
Expand All @@ -3059,6 +3061,7 @@ paths:
schema:
type: boolean
default: false
example: 100
responses:
200:
description: Non-Fungible Token event history
Expand Down Expand Up @@ -3099,14 +3102,15 @@ paths:
schema:
type: integer
default: 50
example: 100
- name: offset
in: query
description: index of first event to fetch
required: false
example: 42000
schema:
type: integer
default: 0
example: 42000
- name: unanchored
in: query
description: whether or not to include events from unconfirmed transactions
Expand All @@ -3122,6 +3126,7 @@ paths:
schema:
type: boolean
default: false
example: true
responses:
200:
description: Non-Fungible Token mints
Expand Down