-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
276 additions
and
2 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 |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| components: | ||
| schemas: | ||
| AccountNftsRequest: | ||
| type: object | ||
| allOf: | ||
| - $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsRequest | ||
| properties: | ||
| command: | ||
| type: string | ||
| enum: | ||
| - account_nfts | ||
| id: | ||
| description: A unique identifier for the request. | ||
| required: | ||
| - command | ||
| - id | ||
| example: | ||
| command: account_nfts | ||
| account: rsuHaTvJh1bDmDoxX9QcKP7HEBSBt4XsHx | ||
| ledger_index: validated | ||
| AccountNftsResponse: | ||
| type: object | ||
| properties: | ||
| result: | ||
| type: object | ||
| discriminator: | ||
| propertyName: status | ||
| mapping: | ||
| success: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsSuccessResponse | ||
| error: '#/components/schemas/AccountNftsErrorResponse' | ||
| oneOf: | ||
| - $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsSuccessResponse | ||
| - $ref: '#/components/schemas/AccountNftsErrorResponse' | ||
| id: | ||
| description: A unique identifier for the request. | ||
| type: | ||
| type: string | ||
| description: | ||
| The value response indicates a direct response to an API request. | ||
| Asynchronous notifications use a different value such as | ||
| `ledgerClosed` or `transaction`. | ||
| enum: | ||
| - response | ||
| required: | ||
| - id | ||
| - type | ||
| example: | ||
| result: | ||
| account: rsuHaTvJh1bDmDoxX9QcKP7HEBSBt4XsHx | ||
| account_nfts: | ||
| - Flags: 1 | ||
| Issuer: rGJUF4PvVkMNxG6Bg6AKg3avhrtQyAffcm | ||
| NFTokenID: 00010000A7CAD27B688D14BA1A9FA5366554D6ADCF9CE0875B974D9F00000004 | ||
| NFTokenTaxon: 0 | ||
| URI: 697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469 | ||
| nft_serial: 4 | ||
| - Flags: 1 | ||
| Issuer: rGJUF4PvVkMNxG6Bg6AKg3avhrtQyAffcm | ||
| NFTokenID: 00010000A7CAD27B688D14BA1A9FA5366554D6ADCF9CE087727D1EA000000005 | ||
| NFTokenTaxon: 0 | ||
| URI: 697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469 | ||
| nft_serial: 5 | ||
| ledger_hash: 7971093E67341E325251268A5B7CD665EF450B126F67DF8384D964DF834961E8 | ||
| ledger_index: 2380540 | ||
| validated: true | ||
| status: success | ||
| type: response | ||
| AccountNftsErrorResponse: | ||
| oneOf: | ||
| - $ref: ../../shared/base.yaml#/components/schemas/WebsocketErrorFields | ||
| - $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsErrorResponse |
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
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
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
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
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,61 @@ | ||
| components: | ||
| schemas: | ||
| AccountNftsRequest: | ||
| type: object | ||
| description: '' | ||
| properties: | ||
| method: | ||
| type: string | ||
| enum: | ||
| - account_nfts | ||
| params: | ||
| type: array | ||
| items: | ||
| $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsRequest | ||
| required: | ||
| - method | ||
| example: | ||
| method: account_nfts | ||
| params: | ||
| - account: rsuHaTvJh1bDmDoxX9QcKP7HEBSBt4XsHx | ||
| ledger_index: validated | ||
| AccountNftsResponse: | ||
| type: object | ||
| properties: | ||
| result: | ||
| type: object | ||
| discriminator: | ||
| propertyName: status | ||
| mapping: | ||
| success: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsSuccessResponse | ||
| error: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsErrorResponse | ||
| oneOf: | ||
| - $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsSuccessResponse | ||
| - $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsErrorResponse | ||
| required: | ||
| - result | ||
| example: | ||
| result: | ||
| account: rsuHaTvJh1bDmDoxX9QcKP7HEBSBt4XsHx | ||
| account_nfts: | ||
| - Flags: 1 | ||
| Issuer: rGJUF4PvVkMNxG6Bg6AKg3avhrtQyAffcm | ||
| NFTokenID: 00010000A7CAD27B688D14BA1A9FA5366554D6ADCF9CE0875B974D9F00000004 | ||
| NFTokenTaxon: 0 | ||
| URI: 697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469 | ||
| nft_serial: 4 | ||
| - Flags: 1 | ||
| Issuer: rGJUF4PvVkMNxG6Bg6AKg3avhrtQyAffcm | ||
| NFTokenID: 00010000A7CAD27B688D14BA1A9FA5366554D6ADCF9CE087727D1EA000000005 | ||
| NFTokenTaxon: 0 | ||
| URI: 697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469 | ||
| nft_serial: 5 | ||
| ledger_hash: 46497E9FF17A993324F1A0A693DC068B467184023C7FD162812265EAAFEB97CB | ||
| ledger_index: 2380559 | ||
| status: success | ||
| validated: true | ||
| AccountNftsSuccessResponse: | ||
| type: object | ||
| allOf: | ||
| - $ref: ../../shared/base.yaml#/components/schemas/BaseSuccessResponse | ||
| - $ref: ../../shared/requests/account_nfts.yaml#/components/schemas/AccountNftsSuccessResponse |
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
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,96 @@ | ||
| components: | ||
| schemas: | ||
| AccountNftsRequest: | ||
| description: 'The account_nfts method returns a list of NFToken objects for the specified account.' | ||
| type: object | ||
| allOf: | ||
| - $ref: '../base.yaml#/components/schemas/BaseRequest' | ||
| - $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest' | ||
| properties: | ||
| account: | ||
| type: string | ||
| description: The unique identifier of an account, typically the account's Address. The request returns a list of NFTs owned by this account. | ||
| limit: | ||
| type: integer | ||
| description: (Optional) Limit the number of token pages to retrieve. Each page can contain up to 32 NFTs. The limit value cannot be lower than 20 or more than 400. Positive values outside this range are replaced with the closest valid option. The default is 100. | ||
| marker: | ||
| type: string | ||
| description: (Optional) Value from a previous paginated response. Resume retrieving data where that response left off. | ||
| required: | ||
| - account | ||
| AccountNftsSuccessResponse: | ||
| type: object | ||
| allOf: | ||
| - $ref: '../base.yaml#/components/schemas/BaseSuccessResponse' | ||
| properties: | ||
| account: | ||
| type: string | ||
| description: The account that owns the list of NFTs. | ||
| account_nfts: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/NFToken' | ||
| description: A list of NFTs owned by the account, formatted as NFT Objects. | ||
| ledger_hash: | ||
| type: string | ||
| description: (May be omitted) The identifying hash of the ledger that was used to generate this response. | ||
| ledger_index: | ||
| type: integer | ||
| description: (May be omitted) The ledger index of the ledger that was used to generate this response. | ||
| ledger_current_index: | ||
| type: integer | ||
| description: (May be omitted) The ledger index of the current in-progress ledger version, which was used to generate this response. | ||
| validated: | ||
| type: boolean | ||
| description: If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | ||
| marker: | ||
| type: string | ||
| description: (May be omitted) Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | ||
| NFToken: | ||
| type: object | ||
| properties: | ||
| Flags: | ||
| type: integer | ||
| description: A bit-map of boolean flags enabled for this NFToken. See NFToken Flags for possible values. | ||
| Issuer: | ||
| type: string | ||
| description: The account that issued this NFToken. | ||
| NFTokenID: | ||
| type: string | ||
| description: The unique identifier of this NFToken, in hexadecimal. | ||
| NFTokenTaxon: | ||
| type: integer | ||
| description: The unscrambled version of this token's taxon. Several tokens with the same taxon might represent instances of a limited series. | ||
| URI: | ||
| type: string | ||
| description: The URI data associated with this NFToken, in hexadecimal. | ||
| nft_serial: | ||
| type: integer | ||
| description: The token sequence number of this NFToken, which is unique for its issuer. | ||
|
|
||
| AccountNftsErrorResponse: | ||
| description: '' | ||
| type: object | ||
| properties: | ||
| error: | ||
| type: string | ||
| oneOf: | ||
| - $ref: '../base.yaml#/components/schemas/UniversalErrorResponseCodes' | ||
| - enum: | ||
| - invalidParams | ||
| - actNotFound | ||
| - lgrNotFound | ||
| description: > | ||
| * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. | ||
| * `actNotFound` - The address specified in the `account` field of the request does not correspond to an account in the ledger. | ||
| * `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it. | ||
| status: | ||
| type: string | ||
| enum: | ||
| - error | ||
| request: | ||
| $ref: '#/components/schemas/AccountCurrenciesRequest' | ||
| required: | ||
| - status | ||
| - error | ||
| - request |