Merge pull request #35 from coinbase/patrick/block-missing

Support Omitted Blocks
coinbase · Aug 9, 2020 · 9036614 · 9036614
2 parents b8f7359 + 57b336d
commit 9036614
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/api.json b/api.json
@@ -1343,11 +1343,8 @@
         }
       },
      "BlockResponse": {
-       "description":"A BlockResponse includes a fully-populated block or a partially-populated block with a list of other transactions to fetch (other_transactions).",
+       "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.",
        "type":"object",
-       "required": [
-         "block"
-        ],
        "properties": {
          "block": {
            "$ref":"#/components/schemas/Block"

diff --git a/api.yaml b/api.yaml
@@ -700,9 +700,17 @@ components:
       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.
       type: object
-      required:
-        - block
       properties:
         block:
           $ref: '#/components/schemas/Block'