Skip to content

Feat/metadata errors #417

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
vladimirvolek merged 1 commit into from
Sep 18, 2025
Merged

Feat/metadata errors #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,19 @@ Unreleased changes are in the `master` branch.
- Support for Governance Action Identifier (CIP-129)
- New endpoints for querying with Gov Action ID : `/governance/proposals/:gov_action_id`
- Proposal response now includes an `id` field containing the governance action identifier
- Exposed dbsync off-chain metadata fetch errors in metadata responses
- Applies to endpoints:
- `/pools/:pool_id/metadata`
- `/pools/extended`
- `/governance/proposals/:gov_action_id/metadata`
- Error object structure:
```ts
{
"code": "HASH_MISMATCH" | "CONNECTION_ERROR" | "HTTP_RESPONSE_ERROR" | "DECODE_ERROR" | "SIZE_EXCEEDED" | "UNKNOWN_ERROR",
"message": "Human-readable description of the error"
}
```
- If metadata are available, the `error` field is omitted

## [0.1.79] - 2025-06-06

Expand Down
60 changes: 60 additions & 0 deletions blockfrost-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7552,6 +7552,26 @@ components:
type: string
description: Content of the metadata (raw)
nullable: true
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
required:
- id
- tx_hash
Expand Down Expand Up @@ -9841,6 +9861,26 @@ components:
nullable: true
example: 47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c
description: Hash of the metadata file
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
ticker:
type: string
nullable: true
Expand Down Expand Up @@ -10214,6 +10254,26 @@ components:
nullable: true
example: 47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c
description: Hash of the metadata file
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
ticker:
type: string
nullable: true
Expand Down
60 changes: 60 additions & 0 deletions docs/blockfrost-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7963,6 +7963,26 @@ components:
type: string
description: Content of the metadata (raw)
nullable: true
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
required:
- id
- tx_hash
Expand Down Expand Up @@ -10382,6 +10402,26 @@ components:
example: >-
47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c
description: Hash of the metadata file
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
ticker:
type: string
nullable: true
Expand Down Expand Up @@ -10760,6 +10800,26 @@ components:
nullable: true
example: 47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c
description: Hash of the metadata file
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
ticker:
type: string
nullable: true
Expand Down
2 changes: 1 addition & 1 deletion json-schema.json
View file
Open in desktop

Large diffs are not rendered by default.

78 changes: 78 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10327,6 +10327,32 @@
"type": "string",
"description": "Content of the metadata (raw)",
"nullable": true
},
"error": {
"type": "object",
"description": "Present when metadata could not be fetched or validated.",
"properties": {
"code": {
"type": "string",
"description": "Stable machine-readable error code.",
"enum": [
"HASH_MISMATCH",
"CONNECTION_ERROR",
"HTTP_RESPONSE_ERROR",
"DECODE_ERROR",
"SIZE_EXCEEDED",
"UNKNOWN_ERROR"
]
},
"message": {
"type": "string",
"description": "Human-readable description of the error."
}
},
"required": [
"code",
"message"
]
}
},
"required": [
Expand Down Expand Up @@ -13416,6 +13442,32 @@
"example": "47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c",
"description": "Hash of the metadata file"
},
"error": {
"type": "object",
"description": "Present when metadata could not be fetched or validated.",
"properties": {
"code": {
"type": "string",
"description": "Stable machine-readable error code.",
"enum": [
"HASH_MISMATCH",
"CONNECTION_ERROR",
"HTTP_RESPONSE_ERROR",
"DECODE_ERROR",
"SIZE_EXCEEDED",
"UNKNOWN_ERROR"
]
},
"message": {
"type": "string",
"description": "Human-readable description of the error."
}
},
"required": [
"code",
"message"
]
},
"ticker": {
"type": "string",
"nullable": true,
Expand Down Expand Up @@ -13895,6 +13947,32 @@
"example": "47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c",
"description": "Hash of the metadata file"
},
"error": {
"type": "object",
"description": "Present when metadata could not be fetched or validated.",
"properties": {
"code": {
"type": "string",
"description": "Stable machine-readable error code.",
"enum": [
"HASH_MISMATCH",
"CONNECTION_ERROR",
"HTTP_RESPONSE_ERROR",
"DECODE_ERROR",
"SIZE_EXCEEDED",
"UNKNOWN_ERROR"
]
},
"message": {
"type": "string",
"description": "Human-readable description of the error."
}
},
"required": [
"code",
"message"
]
},
"ticker": {
"type": "string",
"nullable": true,
Expand Down
60 changes: 60 additions & 0 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7963,6 +7963,26 @@ components:
type: string
description: Content of the metadata (raw)
nullable: true
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
required:
- id
- tx_hash
Expand Down Expand Up @@ -10382,6 +10402,26 @@ components:
example: >-
47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c
description: Hash of the metadata file
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
ticker:
type: string
nullable: true
Expand Down Expand Up @@ -10760,6 +10800,26 @@ components:
nullable: true
example: 47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c
description: Hash of the metadata file
error:
type: object
description: Present when metadata could not be fetched or validated.
properties:
code:
type: string
description: Stable machine-readable error code.
enum:
- HASH_MISMATCH
- CONNECTION_ERROR
- HTTP_RESPONSE_ERROR
- DECODE_ERROR
- SIZE_EXCEEDED
- UNKNOWN_ERROR
message:
type: string
description: Human-readable description of the error.
required:
- code
- message
ticker:
type: string
nullable: true
Expand Down
Loading