Files
stacks-blockchain-api/docs/api/rosetta/rosetta-block-response.schema.json
Asim Mehmood bd4dc86493 fix: separate out rosetta request/response schema files from entity files
Several schema files referenced entity files in the docs/api/rosetta
directory.  They entity files have all been moved to docs/entities/rosetta
and references updated.
2020-09-01 08:26:03 -06:00

21 lines
1.4 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "rosetta-block-response.schema.json",
"type": "object",
"title": "RosettaBlockResponse",
"description": "A BlockResponse includes a fully-populated block or a partially-populated block with a list of other transactions to fetch (other_transactions). As a result of the consensus algorithm of some blockchains, blocks can be omitted (i.e. certain block indexes can be skipped). If a query for one of these omitted indexes is made, the response should not include a Block object. It is VERY important to note that blocks MUST still form a canonical, connected chain of blocks where each block has a unique index. In other words, the PartialBlockIdentifier of a block after an omitted block should reference the last non-omitted block.",
"required": [],
"properties": {
"block": {
"$ref": "./../../entities/rosetta/rosetta-block.schema.json"
},
"other_transactions": {
"type": "array",
"description": "Some blockchains may require additional transactions to be fetched that weren't returned in the block response (ex: block only returns transaction hashes). For blockchains with a lot of transactions in each block, this can be very useful as consumers can concurrently fetch all transactions returned.",
"items": {
"$ref": "./../../entities/rosetta/rosetta-other-transaction-identifier.schema.json"
}
}
}
}