Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ Unreleased changes are in the `master` branch.

## [Unreleased]

## [0.1.81] - 2025-10-08

### Added

- Included proposal reference fields in `/governance/drep/:drep_id/votes`
- Each vote now includes `proposal_id`, `proposal_tx_hash` and `proposal_cert_index`

### Fixed

- Description of `tx_hash` and `cert_index` in in `/governance/drep/:drep_id/votes`

## [0.1.80] - 2025-09-18

### Added
Expand Down
22 changes: 20 additions & 2 deletions blockfrost-openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.0
info:
version: 0.1.80
version: 0.1.81
title: Blockfrost.io ~ API Documentation
x-logo:
url: https://staging.blockfrost.io/images/logo.svg
Expand Down Expand Up @@ -6872,8 +6872,17 @@ components:
properties:
tx_hash:
type: string
description: Hash of the proposal transaction.
description: Hash of the vote transaction.
cert_index:
type: integer
description: Index of the certificate within the vote transaction.
proposal_id:
type: string
description: Governance Action Identifier (CIP-0129) of the proposal being voted on.
proposal_tx_hash:
type: string
description: Hash of the proposal transaction.
proposal_cert_index:
type: integer
description: Index of the certificate within the proposal transaction.
vote:
Expand All @@ -6886,13 +6895,22 @@ components:
required:
- tx_hash
- cert_index
- proposal_id
- proposal_tx_hash
- proposal_cert_index
- vote
example:
- tx_hash: b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5
cert_index: 2
proposal_id: gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn
proposal_tx_hash: b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5
proposal_cert_index: 0
vote: 'yes'
- tx_hash: b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5
cert_index: 3
proposal_id: gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn
proposal_tx_hash: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531
proposal_cert_index: 1
vote: abstain
proposals:
type: array
Expand Down
26 changes: 24 additions & 2 deletions docs/blockfrost-openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.3
info:
version: 0.1.80
version: 0.1.81
title: Blockfrost.io ~ API Documentation
x-logo:
url: 'https://staging.blockfrost.io/images/logo.svg'
Expand Down Expand Up @@ -7209,8 +7209,19 @@ components:
properties:
tx_hash:
type: string
description: Hash of the proposal transaction.
description: Hash of the vote transaction.
cert_index:
type: integer
description: Index of the certificate within the vote transaction.
proposal_id:
type: string
description: >-
Governance Action Identifier (CIP-0129) of the proposal being
voted on.
proposal_tx_hash:
type: string
description: Hash of the proposal transaction.
proposal_cert_index:
type: integer
description: Index of the certificate within the proposal transaction.
vote:
Expand All @@ -7223,13 +7234,24 @@ components:
required:
- tx_hash
- cert_index
- proposal_id
- proposal_tx_hash
- proposal_cert_index
- vote
example:
- tx_hash: b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5
cert_index: 2
proposal_id: >-
gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn
proposal_tx_hash: b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5
proposal_cert_index: 0
vote: 'yes'
- tx_hash: b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5
cert_index: 3
proposal_id: >-
gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn
proposal_tx_hash: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531
proposal_cert_index: 1
vote: abstain
proposals:
type: array
Expand Down
2 changes: 1 addition & 1 deletion json-schema.json

Large diffs are not rendered by default.

25 changes: 23 additions & 2 deletions openapi.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "0.1.80",
"version": "0.1.81",
"title": "Blockfrost.io ~ API Documentation",
"x-logo": {
"url": "https://staging.blockfrost.io/images/logo.svg",
Expand Down Expand Up @@ -9442,9 +9442,21 @@
"properties": {
"tx_hash": {
"type": "string",
"description": "Hash of the proposal transaction."
"description": "Hash of the vote transaction."
},
"cert_index": {
"type": "integer",
"description": "Index of the certificate within the vote transaction."
},
"proposal_id": {
"type": "string",
"description": "Governance Action Identifier (CIP-0129) of the proposal being voted on."
},
"proposal_tx_hash": {
"type": "string",
"description": "Hash of the proposal transaction."
},
"proposal_cert_index": {
"type": "integer",
"description": "Index of the certificate within the proposal transaction."
},
Expand All @@ -9461,18 +9473,27 @@
"required": [
"tx_hash",
"cert_index",
"proposal_id",
"proposal_tx_hash",
"proposal_cert_index",
"vote"
]
},
"example": [
{
"tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5",
"cert_index": 2,
"proposal_id": "gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn",
"proposal_tx_hash": "b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5",
"proposal_cert_index": 0,
"vote": "yes"
},
{
"tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5",
"cert_index": 3,
"proposal_id": "gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn",
"proposal_tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531",
"proposal_cert_index": 1,
"vote": "abstain"
}
]
Expand Down
26 changes: 24 additions & 2 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.3
info:
version: 0.1.80
version: 0.1.81
title: Blockfrost.io ~ API Documentation
x-logo:
url: 'https://staging.blockfrost.io/images/logo.svg'
Expand Down Expand Up @@ -7209,8 +7209,19 @@ components:
properties:
tx_hash:
type: string
description: Hash of the proposal transaction.
description: Hash of the vote transaction.
cert_index:
type: integer
description: Index of the certificate within the vote transaction.
proposal_id:
type: string
description: >-
Governance Action Identifier (CIP-0129) of the proposal being
voted on.
proposal_tx_hash:
type: string
description: Hash of the proposal transaction.
proposal_cert_index:
type: integer
description: Index of the certificate within the proposal transaction.
vote:
Expand All @@ -7223,13 +7234,24 @@ components:
required:
- tx_hash
- cert_index
- proposal_id
- proposal_tx_hash
- proposal_cert_index
- vote
example:
- tx_hash: b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5
cert_index: 2
proposal_id: >-
gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn
proposal_tx_hash: b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5
proposal_cert_index: 0
vote: 'yes'
- tx_hash: b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5
cert_index: 3
proposal_id: >-
gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn
proposal_tx_hash: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531
proposal_cert_index: 1
vote: abstain
proposals:
type: array
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@blockfrost/openapi",
"version": "0.1.80",
"version": "0.1.81",
"description": "OpenAPI specifications for blockfrost.io",
"repository": "git@github.com:blockfrost/openapi.git",
"author": "admin@blockfrost.io",
Expand Down
2 changes: 1 addition & 1 deletion src/definitions.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.0
info:
version: 0.1.80
version: 0.1.81
title: Blockfrost.io ~ API Documentation
x-logo:
url: https://staging.blockfrost.io/images/logo.svg
Expand Down
16 changes: 14 additions & 2 deletions src/generated-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7297,19 +7297,31 @@ export interface components {
* {
* "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5",
* "cert_index": 2,
* "proposal_id": "gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn",
* "proposal_tx_hash": "b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5",
* "proposal_cert_index": 0,
* "vote": "yes"
* },
* {
* "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5",
* "cert_index": 3,
* "proposal_id": "gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn",
* "proposal_tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531",
* "proposal_cert_index": 1,
* "vote": "abstain"
* }
* ] */
drep_votes: {
/** @description Hash of the proposal transaction. */
/** @description Hash of the vote transaction. */
tx_hash: string;
/** @description Index of the certificate within the proposal transaction. */
/** @description Index of the certificate within the vote transaction. */
cert_index: number;
/** @description Governance Action Identifier (CIP-0129) of the proposal being voted on. */
proposal_id: string;
/** @description Hash of the proposal transaction. */
proposal_tx_hash: string;
/** @description Index of the certificate within the proposal transaction. */
proposal_cert_index: number;
/**
* @description The Vote. Can be one of yes, no, abstain.
* @enum {string}
Expand Down
20 changes: 19 additions & 1 deletion src/schemas/governance/drep_votes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,17 @@ items:
properties:
tx_hash:
type: string
description: Hash of the proposal transaction.
description: Hash of the vote transaction.
cert_index:
type: integer
description: Index of the certificate within the vote transaction.
proposal_id:
type: string
description: Governance Action Identifier (CIP-0129) of the proposal being voted on.
proposal_tx_hash:
type: string
description: Hash of the proposal transaction.
proposal_cert_index:
type: integer
description: Index of the certificate within the proposal transaction.
vote:
Expand All @@ -16,11 +25,20 @@ items:
required:
- tx_hash
- cert_index
- proposal_id
- proposal_tx_hash
- proposal_cert_index
- vote
example:
- tx_hash: "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5"
cert_index: 2
proposal_id: "gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn"
proposal_tx_hash: "b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5"
proposal_cert_index: 0
vote: "yes"
- tx_hash: "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5"
cert_index: 3
proposal_id: "gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn"
proposal_tx_hash: "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531"
proposal_cert_index: 1
vote: "abstain"
23 changes: 22 additions & 1 deletion test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -12158,25 +12158,43 @@ under which it is valid
"example": [
{
"cert_index": 2,
"proposal_cert_index": 0,
"proposal_id": "gov_action1k2jertppnnndejjcglszfqq4yzw8evzrd2nt66rr6rqlz54xp0zsq05ecsn",
"proposal_tx_hash": "b2a591ac219ce6dcca5847e0248015209c7cb0436aa6bd6863d0c1f152a60bc5",
"tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5",
"vote": "yes",
},
{
"cert_index": 3,
"proposal_cert_index": 1,
"proposal_id": "gov_action1zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsq6dmejn",
"proposal_tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531",
"tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5",
"vote": "abstain",
},
],
"items": {
"properties": {
"cert_index": {
"description": "Index of the certificate within the vote transaction.",
"type": "integer",
},
"proposal_cert_index": {
"description": "Index of the certificate within the proposal transaction.",
"type": "integer",
},
"tx_hash": {
"proposal_id": {
"description": "Governance Action Identifier (CIP-0129) of the proposal being voted on.",
"type": "string",
},
"proposal_tx_hash": {
"description": "Hash of the proposal transaction.",
"type": "string",
},
"tx_hash": {
"description": "Hash of the vote transaction.",
"type": "string",
},
"vote": {
"description": "The Vote. Can be one of yes, no, abstain.",
"enum": [
Expand All @@ -12190,6 +12208,9 @@ under which it is valid
"required": [
"tx_hash",
"cert_index",
"proposal_id",
"proposal_tx_hash",
"proposal_cert_index",
"vote",
],
"type": "object",
Expand Down