feat: openAPI docs for total-supply endpoint

This commit is contained in:
Matthew Little
2021-02-26 12:42:34 +01:00
parent 811f06b6ed
commit cec343a1ea
5 changed files with 79 additions and 1 deletions

View File

@@ -0,0 +1,6 @@
{
"unlocked_percent": "71.99",
"total_stx": "1352464600.000000",
"unlocked_stx": "973705260.219817",
"block_height": 3210
}

View File

@@ -0,0 +1,26 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "GET request that returns network target block times",
"title": "GetTotalStxSupplyResponse",
"type": "object",
"additionalProperties": false,
"required": ["unlocked_percent", "total_stx", "unlocked_stx", "block_height"],
"properties": {
"unlocked_percent": {
"type": "string",
"description": "String quoted decimal number of the percentage of STX that have unlocked"
},
"total_stx": {
"type": "string",
"description": "String quoted decimal number of the total possible number of STX"
},
"unlocked_stx": {
"type": "string",
"description": "String quoted decimal number of the STX that have been mined or unlocked"
},
"block_height": {
"type": "integer",
"description": "The block height at which this information was queried"
}
}
}