Skip to content

API: Block Header API Revamp #6248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gmalouf merged 4 commits into from
Feb 11, 2025
Merged

API: Block Header API Revamp #6248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c100c1a
Revert "API: New algod endpoint `/v2/block/{round}/header` omits tran…
gmalouf Feb 7, 2025
c2f3cce
Add optional 'header-only' parameter to endpoint to allow for retrie…
gmalouf Feb 10, 2025
be04838
Merge branch 'master' into block-header-api-revamp
gmalouf Feb 10, 2025
4f879d5
Add comment highlighting opportunity areas on the '/v2/blocks' endpoint.
gmalouf Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 6 additions & 78 deletions daemon/algod/api/algod.oas2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,12 @@
"in": "path",
"required": true
},
{
"type": "boolean",
"description": "If true, only the block header (exclusive of payset or certificate) may be included in response.",
"name": "header-only",
Comment thread
gmalouf marked this conversation as resolved.
"in": "query"
},
{
"$ref": "#/parameters/format"
}
Expand Down Expand Up @@ -826,68 +832,6 @@
}
}
},
"/v2/blocks/{round}/header": {
"get": {
"tags": [
"public",
"nonparticipating"
],
"produces": [
"application/json",
"application/msgpack"
],
"schemes": [
"http"
],
"summary": "Get the block header for the block on the given round.",
"operationId": "GetBlockHeader",
"parameters": [
{
"minimum": 0,
"type": "integer",
"description": "The round from which to fetch block header information.",
"name": "round",
"in": "path",
"required": true
},
{
"$ref": "#/parameters/format"
}
],
"responses": {
"200": {
"$ref": "#/responses/BlockHeaderResponse"
},
"400": {
"description": "Bad Request - Non integer number",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"401": {
"description": "Invalid API Token",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "None existing block ",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Internal Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Unknown Error"
}
}
}
},
"/v2/blocks/{round}/transactions/{txid}/proof": {
"get": {
"tags": [
Expand Down Expand Up @@ -5168,22 +5112,6 @@
}
}
},
"BlockHeaderResponse": {
"description": "Block header.",
"schema": {
"type": "object",
"required": [
"blockHeader"
],
"properties": {
"blockHeader": {
"description": "Block header data.",
"type": "object",
"x-algorand-format": "BlockHeaderResponse"
}
}
}
},
"TransactionProofResponse": {
"description": "Proof of transaction in a block.",
"schema": {
Expand Down
166 changes: 8 additions & 158 deletions daemon/algod/api/algod.oas3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,27 +352,6 @@
},
"description": "Hash of a block header."
},
"BlockHeaderResponse": {
"content": {
"application/json": {
"schema": {
"properties": {
"blockHeader": {
"description": "Block header data.",
"properties": {},
"type": "object",
"x-algorand-format": "BlockHeaderResponse"
}
},
"required": [
"blockHeader"
],
"type": "object"
}
}
},
"description": "Block header."
},
"BlockLogsResponse": {
"content": {
"application/json": {
Expand Down Expand Up @@ -4013,6 +3992,14 @@
"minimum": 0,
"type": "integer"
}
},
{
"description": "If true, only the block header (exclusive of payset or certificate) may be included in response.",
"in": "query",
"name": "header-only",
"schema": {
"type": "boolean"
}
}
],
"responses": {
Expand Down Expand Up @@ -4224,143 +4211,6 @@
]
}
},
"/v2/blocks/{round}/header": {
"get": {
"operationId": "GetBlockHeader",
"parameters": [
{
"description": "The round from which to fetch block header information.",
"in": "path",
"name": "round",
"required": true,
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.",
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"msgpack"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"blockHeader": {
"description": "Block header data.",
"properties": {},
"type": "object",
"x-algorand-format": "BlockHeaderResponse"
}
},
"required": [
"blockHeader"
],
"type": "object"
}
},
"application/msgpack": {
"schema": {
"properties": {
"blockHeader": {
"description": "Block header data.",
"properties": {},
"type": "object",
"x-algorand-format": "BlockHeaderResponse"
}
},
"required": [
"blockHeader"
],
"type": "object"
}
}
},
"description": "Block header."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/msgpack": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request - Non integer number"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/msgpack": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Invalid API Token"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/msgpack": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "None existing block "
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/msgpack": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Error"
},
"default": {
"content": {},
"description": "Unknown Error"
}
},
"summary": "Get the block header for the block on the given round.",
"tags": [
"public",
"nonparticipating"
]
}
},
"/v2/blocks/{round}/lightheader/proof": {
"get": {
"operationId": "GetLightBlockHeaderProof",
Expand Down
Loading