From 743557f6115200ed9c610a538f17dab21f30f6c9 Mon Sep 17 00:00:00 2001 From: rdlrt <3169068+rdlrt@users.noreply.github.com> Date: Wed, 31 Jul 2024 09:30:01 +1000 Subject: [PATCH] Add pool_votes to specs and other Minor corrections --- files/grest/rpc/epoch/epoch_params.sql | 2 +- specs/results/koiosapi-guild.yaml | 29 +++++++++++++++----------- specs/results/koiosapi-mainnet.yaml | 29 +++++++++++++++----------- specs/results/koiosapi-preprod.yaml | 29 +++++++++++++++----------- specs/results/koiosapi-preview.yaml | 29 +++++++++++++++----------- specs/templates/2-api-params.yaml | 6 +++--- specs/templates/4-api-schemas.yaml | 23 ++++++++++++-------- 7 files changed, 86 insertions(+), 61 deletions(-) diff --git a/files/grest/rpc/epoch/epoch_params.sql b/files/grest/rpc/epoch/epoch_params.sql index 24a99e16..29884c10 100644 --- a/files/grest/rpc/epoch/epoch_params.sql +++ b/files/grest/rpc/epoch/epoch_params.sql @@ -105,7 +105,7 @@ BEGIN ep.dvt_p_p_economic_group, ep.dvt_p_p_technical_group, ep.dvt_p_p_gov_group, - ep.dvt_treasury_withdrawal::text, + ep.dvt_treasury_withdrawal, ep.committee_min_size, ep.committee_max_term_length, ep.gov_action_lifetime, diff --git a/specs/results/koiosapi-guild.yaml b/specs/results/koiosapi-guild.yaml index 332b6b7f..c05ef578 100644 --- a/specs/results/koiosapi-guild.yaml +++ b/specs/results/koiosapi-guild.yaml @@ -2007,7 +2007,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r" in: query required: true allowEmptyValue: false @@ -2017,7 +2017,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r" in: query required: false allowEmptyValue: true @@ -2027,7 +2027,7 @@ components: description: Committee hash in hexadecimal format (hex) schema: type: string - example: "##_committee_hash_param" + example: "65d497b875c56ab213586a4006d4f6658970573ea8e2398893857472" in: query required: false allowEmptyValue: true @@ -3692,13 +3692,13 @@ components: example: 14 gov_action_deposit: type: - - number + - string - 'null' description: Governance action deposit. example: 100000000000 drep_deposit: type: - - number + - string - 'null' description: DRep deposit amount. example: 500000000 @@ -4976,7 +4976,7 @@ components: deposit: type: - string - - null + - 'null' description: DRep's registration deposit in lovelace example: 500000000 active: @@ -4986,7 +4986,7 @@ components: expires_epoch_no: type: - number - - null + - 'null' description: After which epoch DRep is considered inactive. example: 410 amount: @@ -5092,6 +5092,11 @@ components: enum: ["Yes","No","Abstain"] description: Actual Vote casted example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" committee_votes: description: List of all votes casted by requested delegated representative (DRep) type: array @@ -5126,31 +5131,31 @@ components: ratified_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been ratified at the specfied epoch. example: 670 enacted_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been enacted at the specfied epoch. example: 675 dropped_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. example: 680 expired_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been expired at the specfied epoch. example: 680 expiration: type: - number - - null + - 'null' description: Shows the epoch at which this governance action is expected to expire. meta_url: $ref: "#/components/schemas/drep_metadata/items/properties/url" diff --git a/specs/results/koiosapi-mainnet.yaml b/specs/results/koiosapi-mainnet.yaml index 4fa07fac..14f362fa 100644 --- a/specs/results/koiosapi-mainnet.yaml +++ b/specs/results/koiosapi-mainnet.yaml @@ -2007,7 +2007,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3" in: query required: true allowEmptyValue: false @@ -2017,7 +2017,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3" in: query required: false allowEmptyValue: true @@ -2027,7 +2027,7 @@ components: description: Committee hash in hexadecimal format (hex) schema: type: string - example: "##_committee_hash_param" + example: "49fa008218cd619afe6aa8a1a93303f242440722b314f36bda2c2e23" in: query required: false allowEmptyValue: true @@ -3692,13 +3692,13 @@ components: example: 14 gov_action_deposit: type: - - number + - string - 'null' description: Governance action deposit. example: 100000000000 drep_deposit: type: - - number + - string - 'null' description: DRep deposit amount. example: 500000000 @@ -4976,7 +4976,7 @@ components: deposit: type: - string - - null + - 'null' description: DRep's registration deposit in lovelace example: 500000000 active: @@ -4986,7 +4986,7 @@ components: expires_epoch_no: type: - number - - null + - 'null' description: After which epoch DRep is considered inactive. example: 410 amount: @@ -5092,6 +5092,11 @@ components: enum: ["Yes","No","Abstain"] description: Actual Vote casted example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" committee_votes: description: List of all votes casted by requested delegated representative (DRep) type: array @@ -5126,31 +5131,31 @@ components: ratified_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been ratified at the specfied epoch. example: 670 enacted_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been enacted at the specfied epoch. example: 675 dropped_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. example: 680 expired_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been expired at the specfied epoch. example: 680 expiration: type: - number - - null + - 'null' description: Shows the epoch at which this governance action is expected to expire. meta_url: $ref: "#/components/schemas/drep_metadata/items/properties/url" diff --git a/specs/results/koiosapi-preprod.yaml b/specs/results/koiosapi-preprod.yaml index 9050a27d..56fe4cf7 100644 --- a/specs/results/koiosapi-preprod.yaml +++ b/specs/results/koiosapi-preprod.yaml @@ -2007,7 +2007,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd" in: query required: true allowEmptyValue: false @@ -2017,7 +2017,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd" in: query required: false allowEmptyValue: true @@ -2027,7 +2027,7 @@ components: description: Committee hash in hexadecimal format (hex) schema: type: string - example: "##_committee_hash_param" + example: "f8f56120e1ec00feb088ece39ef14f07339afeb37b4e949ff12b89ff" in: query required: false allowEmptyValue: true @@ -3692,13 +3692,13 @@ components: example: 14 gov_action_deposit: type: - - number + - string - 'null' description: Governance action deposit. example: 100000000000 drep_deposit: type: - - number + - string - 'null' description: DRep deposit amount. example: 500000000 @@ -4976,7 +4976,7 @@ components: deposit: type: - string - - null + - 'null' description: DRep's registration deposit in lovelace example: 500000000 active: @@ -4986,7 +4986,7 @@ components: expires_epoch_no: type: - number - - null + - 'null' description: After which epoch DRep is considered inactive. example: 410 amount: @@ -5092,6 +5092,11 @@ components: enum: ["Yes","No","Abstain"] description: Actual Vote casted example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" committee_votes: description: List of all votes casted by requested delegated representative (DRep) type: array @@ -5126,31 +5131,31 @@ components: ratified_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been ratified at the specfied epoch. example: 670 enacted_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been enacted at the specfied epoch. example: 675 dropped_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. example: 680 expired_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been expired at the specfied epoch. example: 680 expiration: type: - number - - null + - 'null' description: Shows the epoch at which this governance action is expected to expire. meta_url: $ref: "#/components/schemas/drep_metadata/items/properties/url" diff --git a/specs/results/koiosapi-preview.yaml b/specs/results/koiosapi-preview.yaml index d10c0b0a..1fff81a0 100644 --- a/specs/results/koiosapi-preview.yaml +++ b/specs/results/koiosapi-preview.yaml @@ -2007,7 +2007,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck" in: query required: true allowEmptyValue: false @@ -2017,7 +2017,7 @@ components: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck" in: query required: false allowEmptyValue: true @@ -2027,7 +2027,7 @@ components: description: Committee hash in hexadecimal format (hex) schema: type: string - example: "##_committee_hash_param" + example: "7ceede7d6a89e006408e6b7c6acb3dd094b3f6817e43b4a36d01535b" in: query required: false allowEmptyValue: true @@ -3692,13 +3692,13 @@ components: example: 14 gov_action_deposit: type: - - number + - string - 'null' description: Governance action deposit. example: 100000000000 drep_deposit: type: - - number + - string - 'null' description: DRep deposit amount. example: 500000000 @@ -4976,7 +4976,7 @@ components: deposit: type: - string - - null + - 'null' description: DRep's registration deposit in lovelace example: 500000000 active: @@ -4986,7 +4986,7 @@ components: expires_epoch_no: type: - number - - null + - 'null' description: After which epoch DRep is considered inactive. example: 410 amount: @@ -5092,6 +5092,11 @@ components: enum: ["Yes","No","Abstain"] description: Actual Vote casted example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" committee_votes: description: List of all votes casted by requested delegated representative (DRep) type: array @@ -5126,31 +5131,31 @@ components: ratified_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been ratified at the specfied epoch. example: 670 enacted_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been enacted at the specfied epoch. example: 675 dropped_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. example: 680 expired_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been expired at the specfied epoch. example: 680 expiration: type: - number - - null + - 'null' description: Shows the epoch at which this governance action is expected to expire. meta_url: $ref: "#/components/schemas/drep_metadata/items/properties/url" diff --git a/specs/templates/2-api-params.yaml b/specs/templates/2-api-params.yaml index d0794b0c..0a4ae6bb 100644 --- a/specs/templates/2-api-params.yaml +++ b/specs/templates/2-api-params.yaml @@ -85,7 +85,7 @@ parameters: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "##_drep_id_param##" in: query required: true allowEmptyValue: false @@ -95,7 +95,7 @@ parameters: description: DRep ID in bech32 format schema: type: string - example: "##_drep_id_param" + example: "##_drep_id_param##" in: query required: false allowEmptyValue: true @@ -105,7 +105,7 @@ parameters: description: Committee hash in hexadecimal format (hex) schema: type: string - example: "##_committee_hash_param" + example: "##_committee_hash_param##" in: query required: false allowEmptyValue: true diff --git a/specs/templates/4-api-schemas.yaml b/specs/templates/4-api-schemas.yaml index 97da16fa..590ff5bd 100644 --- a/specs/templates/4-api-schemas.yaml +++ b/specs/templates/4-api-schemas.yaml @@ -991,13 +991,13 @@ schemas: example: 14 gov_action_deposit: type: - - number + - string - 'null' description: Governance action deposit. example: 100000000000 drep_deposit: type: - - number + - string - 'null' description: DRep deposit amount. example: 500000000 @@ -2275,7 +2275,7 @@ schemas: deposit: type: - string - - null + - 'null' description: DRep's registration deposit in lovelace example: 500000000 active: @@ -2285,7 +2285,7 @@ schemas: expires_epoch_no: type: - number - - null + - 'null' description: After which epoch DRep is considered inactive. example: 410 amount: @@ -2391,6 +2391,11 @@ schemas: enum: ["Yes","No","Abstain"] description: Actual Vote casted example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" committee_votes: description: List of all votes casted by requested delegated representative (DRep) type: array @@ -2425,31 +2430,31 @@ schemas: ratified_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been ratified at the specfied epoch. example: 670 enacted_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been enacted at the specfied epoch. example: 675 dropped_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. example: 680 expired_epoch: type: - number - - null + - 'null' description: If not null, then this proposal has been expired at the specfied epoch. example: 680 expiration: type: - number - - null + - 'null' description: Shows the epoch at which this governance action is expected to expire. meta_url: $ref: "#/components/schemas/drep_metadata/items/properties/url"