docs: document canonical field (#5166)

Closes #2769 Spec PR: https://github.com/tendermint/spec/pull/125
2026-01-06 21:36:26 +00:00 · 2020-07-30 13:07:03 +04:00
parent dc71f265aa
commit 2b97e03cf6
1 changed files with 4 additions and 1 deletions
--- a/rpc/swagger/swagger.yaml
+++ b/rpc/swagger/swagger.yaml
@@ -709,7 +709,10 @@ paths:
        Get Commit.
      responses:
        200:
-          description: Commit results.
+          description: |
+            Commit results.
+
+            canonical switches from false to true for block H once block H+1 has been committed. Until then it's subjective and only reflects what this node has seen so far.
          content:
            application/json:
              schema: