diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 468d449337..bdc9f7cd95 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -515,7 +515,6 @@ paths: in: query description: Index of the first microblock to fetch required: false - example: 42000 schema: type: integer example: 1000 @@ -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 @@ -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 @@ -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 @@ -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: @@ -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 @@ -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 @@ -2966,6 +2964,7 @@ paths: schema: type: integer default: 50 + example: 100 - name: offset in: query description: index of first tokens to fetch @@ -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 @@ -2989,6 +2989,7 @@ paths: schema: type: boolean default: false + example: true responses: 200: description: List of Non-Fungible Token holdings @@ -3036,6 +3037,7 @@ paths: schema: type: integer default: 50 + example: 100 - name: offset in: query description: index of first event to fetch @@ -3059,6 +3061,7 @@ paths: schema: type: boolean default: false + example: 100 responses: 200: description: Non-Fungible Token event history @@ -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 @@ -3122,6 +3126,7 @@ paths: schema: type: boolean default: false + example: true responses: 200: description: Non-Fungible Token mints