docs: update OpenAPI schema with the /v2/pox changes

This commit is contained in:
Matthew Little
2022-09-13 15:58:30 +02:00
parent d7e2bdcb4d
commit c23c8fa4ec
2 changed files with 52 additions and 6 deletions

View File

@@ -2,6 +2,7 @@
"contract_id": "SP000000000000000000002Q6VF78.pox",
"pox_activation_threshold_ustx": 52329761604388,
"first_burnchain_block_height": 666050,
"current_burnchain_block_height": 812345,
"prepare_phase_block_length": 100,
"reward_phase_block_length": 2000,
"reward_slots": 4000,
@@ -29,5 +30,17 @@
"reward_cycle_id": 2,
"reward_cycle_length": 2100,
"rejection_votes_left_required": 261648808021925,
"next_reward_cycle_in": 507
"next_reward_cycle_in": 507,
"contract_versions": [
{
"contract_id": "SP000000000000000000002Q6VF78.pox",
"activation_burnchain_block_height": 666050,
"first_reward_cycle_id": 0
},
{
"contract_id": "SP000000000000000000002Q6VF78.pox-2",
"activation_burnchain_block_height": 712345,
"first_reward_cycle_id": 123
}
]
}

View File

@@ -6,6 +6,7 @@
"additionalProperties": false,
"required": [
"contract_id",
"current_burnchain_block_height",
"first_burnchain_block_height",
"pox_activation_threshold_ustx",
"prepare_phase_block_length",
@@ -19,7 +20,8 @@
"min_amount_ustx",
"reward_cycle_id",
"prepare_cycle_length",
"rejection_votes_left_required"
"rejection_votes_left_required",
"contract_versions"
],
"properties": {
"contract_id": {
@@ -30,6 +32,10 @@
"type": "integer",
"description": "The first burn block evaluated in this Stacks chain"
},
"current_burnchain_block_height": {
"type": "integer",
"description": "The latest Bitcoin chain block height"
},
"pox_activation_threshold_ustx": {
"type": "integer",
"description": "The threshold of stacking participation that must be reached for PoX to activate in any cycle"
@@ -83,7 +89,7 @@
"is_pox_active": {
"type": "boolean",
"description": "Whether or not PoX is active during this reward cycle."
},
}
}
},
"next_cycle": {
@@ -146,15 +152,42 @@
},
"min_amount_ustx": {
"type": "integer",
"deprecated": true,
"deprecated": true
},
"prepare_cycle_length": {
"type": "integer",
"deprecated": true,
"deprecated": true
},
"rejection_votes_left_required": {
"type": "integer",
"deprecated": true,
"deprecated": true
},
"contract_versions": {
"type": "array",
"description": "Versions of each PoX",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"contract_id",
"activation_burnchain_block_height",
"first_reward_cycle_id"
],
"properties": {
"contract_id": {
"type": "string",
"description": "The contract identifier for the PoX contract"
},
"activation_burnchain_block_height": {
"type": "integer",
"description": "The burn block height at which this version of PoX is activated"
},
"first_reward_cycle_id": {
"type": "integer",
"description": "The first reward cycle number that uses this version of PoX"
}
}
}
}
}
}