certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update swagger file with tested GET routes (#4470) 

A route had to be commented as it's returning 500 instead of 200 with
empty body -> will make the tests fail:

 - /slashing/validators/{validatorPubKey}/signing_info
  Related to cosmos/gaia#19
This commit is contained in:
Karoly Albert Szabo 2019-06-04 19:20:26 +02:00 committed by Alessio Treglia
parent 6e2f5f3102
commit 3962b3ca23
2 changed files with 118 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
client/lcd/statik/statik.go
View File

File diff suppressed because one or more lines are too long

210
client/lcd/swagger-ui/swagger.yaml vendored
View File

@ -164,7 +164,7 @@ paths:
type: object type: object
properties: properties:
block_height: block_height:
type: number type: string
validators: validators:
type: array type: array
items: items:
@ -192,7 +192,7 @@ paths:
type: object type: object
properties: properties:
block_height: block_height:
type: number type: string
validators: validators:
type: array type: array
items: items:
@ -216,7 +216,7 @@ paths:
description: Tx hash description: Tx hash
required: true required: true
type: string type: string
x-example: 88D6B85EAB87D43CDF50F39C22FC2237A37FEDC4CE723200AD0AF48CBEDBC317 x-example: BCBE20E8D46758B96AE5883B792858296AC06E51435490FBDCAE25A72B3CC76B
responses: responses:
200: 200:
description: Tx with the provided hash description: Tx with the provided hash
@ -234,11 +234,17 @@ paths:
- application/json - application/json
parameters: parameters:
- in: query - in: query
name: tag name: action
type: string type: string
description: "transaction tags such as 'action=submit-proposal' and 'sender=cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc' which results in the following endpoint: 'GET /txs?action=submit-proposal&sender=cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc'" description: "transaction tags such as 'action=send' which results in the following endpoint: 'GET /txs?action=send'"
required: true required: true
x-example: 'TODO' x-example: 'send'
- in: query
name: sender
type: string
description: "transaction tags with sender: 'GET /txs?action=send&sender=cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv'"
required: true
x-example: 'cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv'
- in: query - in: query
name: page name: page
description: Page number description: Page number
@ -333,7 +339,7 @@ paths:
description: Account address in bech32 format description: Account address in bech32 format
required: true required: true
type: string type: string
x-example: cosmos16gdxm24ht2mxtpz9cma6tr6a6d47x63hlq4pxt x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
responses: responses:
200: 200:
description: Account balances description: Account balances
@ -341,8 +347,6 @@ paths:
type: array type: array
items: items:
$ref: "#/definitions/Coin" $ref: "#/definitions/Coin"
204:
description: There is no data for the requested account
500: 500:
description: Server internal error description: Server internal error
/bank/accounts/{address}/transfers: /bank/accounts/{address}/transfers:
@ -360,7 +364,7 @@ paths:
description: Account address in bech32 format description: Account address in bech32 format
required: true required: true
type: string type: string
x-example: cosmos16gdxm24ht2mxtpz9cma6tr6a6d47x63hlq4pxt x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
- in: body - in: body
name: account name: account
description: The sender and tx information description: The sender and tx information
@ -396,7 +400,7 @@ paths:
description: Account address description: Account address
required: true required: true
type: string type: string
x-example: cosmos16gdxm24ht2mxtpz9cma6tr6a6d47x63hlq4pxt x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
responses: responses:
200: 200:
description: Account information on the blockchain description: Account information on the blockchain
@ -417,11 +421,9 @@ paths:
items: items:
$ref: "#/definitions/Coin" $ref: "#/definitions/Coin"
public_key: public_key:
type: string $ref: "#/definitions/PublicKey"
sequence: sequence:
type: string type: string
204:
description: No content about this account address
500: 500:
description: Server internel error description: Server internel error
/staking/delegators/{delegatorAddr}/delegations: /staking/delegators/{delegatorAddr}/delegations:
@ -431,7 +433,7 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
get: get:
summary: Get all delegations from a delegator summary: Get all delegations from a delegator
tags: tags:
@ -464,7 +466,7 @@ paths:
$ref: "#/definitions/Address" $ref: "#/definitions/Address"
validator_address: validator_address:
$ref: "#/definitions/ValidatorAddress" $ref: "#/definitions/ValidatorAddress"
amount: delegation:
$ref: "#/definitions/Coin" $ref: "#/definitions/Coin"
tags: tags:
- ICS21 - ICS21
@ -490,13 +492,13 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
- in: path - in: path
name: validatorAddr name: validatorAddr
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Query the current delegation between a delegator and a validator summary: Query the current delegation between a delegator and a validator
tags: tags:
@ -519,7 +521,7 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
get: get:
summary: Get all unbonding delegations from a delegator summary: Get all unbonding delegations from a delegator
tags: tags:
@ -579,13 +581,13 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
- in: path - in: path
name: validatorAddr name: validatorAddr
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Query all unbonding delegations between a delegator and a validator summary: Query all unbonding delegations between a delegator and a validator
tags: tags:
@ -596,9 +598,7 @@ paths:
200: 200:
description: OK description: OK
schema: schema:
type: array $ref: "#/definitions/UnbondingDelegationPair"
items:
$ref: "#/definitions/UnbondingDelegation"
400: 400:
description: Invalid delegator address or validator address description: Invalid delegator address or validator address
500: 500:
@ -642,7 +642,7 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
post: post:
summary: Submit a redelegation summary: Submit a redelegation
parameters: parameters:
@ -685,7 +685,7 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
get: get:
summary: Query all validators that a delegator is bonded to summary: Query all validators that a delegator is bonded to
tags: tags:
@ -710,13 +710,13 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
- in: path - in: path
name: validatorAddr name: validatorAddr
description: Bech32 ValAddress of Delegator description: Bech32 ValAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Query a validator that a delegator is bonded to summary: Query a validator that a delegator is bonded to
tags: tags:
@ -739,7 +739,7 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
get: get:
summary: Get all staking txs (i.e msgs) from a delegator summary: Get all staking txs (i.e msgs) from a delegator
tags: tags:
@ -753,8 +753,6 @@ paths:
type: array type: array
items: items:
$ref: "#/definitions/TxQuery" $ref: "#/definitions/TxQuery"
204:
description: No staking transaction about this delegator address
400: 400:
description: Invalid delegator address description: Invalid delegator address
500: 500:
@ -798,7 +796,7 @@ paths:
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Query the information from a single validator summary: Query the information from a single validator
tags: tags:
@ -821,7 +819,7 @@ paths:
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Get all delegations from a validator summary: Get all delegations from a validator
tags: tags:
@ -846,7 +844,7 @@ paths:
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Get all unbonding delegations from a validator summary: Get all unbonding delegations from a validator
tags: tags:
@ -920,32 +918,31 @@ paths:
type: string type: string
500: 500:
description: Internal Server Error description: Internal Server Error
/slashing/validators/{validatorPubKey}/signing_info: # TODO: We need to either fix this route when the validator is not found or add a slashed validator in the contract tests
get: # /slashing/validators/{validatorPubKey}/signing_info:
summary: Get sign info of given validator # get:
description: Get sign info of given validator # summary: Get sign info of given validator
produces: # description: Get sign info of given validator
- application/json # produces:
tags: # - application/json
- ICS23 # tags:
parameters: # - ICS23
- type: string # parameters:
description: Bech32 validator public key # - type: string
name: validatorPubKey # description: Bech32 validator public key
required: true # name: validatorPubKey
in: path # required: true
x-example: cosmosvalconspub1zcjduepq7mft6gfls57a0a42d7uhx656cckhfvtrlmw744jv4q0mvlv0dypskehfk8 # in: path
responses: # x-example: cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
200: # responses:
description: OK # 200:
schema: # description: OK
$ref: "#/definitions/SigningInfo" # schema:
204: # $ref: "#/definitions/SigningInfo"
description: No sign info of this validator # 400:
400: # description: Invalid validator public key
description: Invalid validator public key # 500:
500: # description: Internal Server Error
description: Internal Server Error
/slashing/signing_infos: /slashing/signing_infos:
get: get:
summary: Get sign info of given all validators summary: Get sign info of given all validators
@ -974,8 +971,6 @@ paths:
type: array type: array
items: items:
$ref: "#/definitions/SigningInfo" $ref: "#/definitions/SigningInfo"
204:
description: No validators with sign info
400: 400:
description: Invalid validator public key for one of the validators description: Invalid validator public key for one of the validators
500: 500:
@ -996,7 +991,7 @@ paths:
name: validatorAddr name: validatorAddr
required: true required: true
in: path in: path
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
- description: "" - description: ""
name: UnjailBody name: UnjailBody
in: body in: body
@ -1029,19 +1024,19 @@ paths:
type: object type: object
properties: properties:
max_evidence_age: max_evidence_age:
type: integer type: string
signed_blocks_window: signed_blocks_window:
type: integer type: string
min_signed_per_window: min_signed_per_window:
type: integer type: string
double_sign_unbond_duration: double_sign_unbond_duration:
type: integer type: string
downtime_unbond_duration: downtime_unbond_duration:
type: integer type: string
slash_fraction_double_sign: slash_fraction_double_sign:
type: integer type: string
slash_fraction_downtime: slash_fraction_downtime:
type: integer type: string
500: 500:
description: Internal Server Error description: Internal Server Error
/gov/proposals: /gov/proposals:
@ -1178,7 +1173,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
responses: responses:
200: 200:
description: OK description: OK
@ -1201,7 +1196,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
responses: responses:
200: 200:
description: OK description: OK
@ -1224,7 +1219,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
responses: responses:
200: 200:
description: OK description: OK
@ -1251,7 +1246,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
- description: "" - description: ""
name: post_deposit_body name: post_deposit_body
in: body in: body
@ -1292,13 +1287,13 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
- type: string - type: string
description: Bech32 depositor address description: Bech32 depositor address
name: depositor name: depositor
required: true required: true
in: path in: path
x-example: cosmos1xl6453f6q6dv5770c9ue6hspdc0vxfuqtudkhz x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
responses: responses:
200: 200:
description: OK description: OK
@ -1324,7 +1319,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
responses: responses:
200: 200:
description: OK description: OK
@ -1351,7 +1346,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
- description: valid value of `"option"` field can be `"yes"`, `"no"`, `"no_with_veto"` and `"abstain"` - description: valid value of `"option"` field can be `"yes"`, `"no"`, `"no_with_veto"` and `"abstain"`
name: post_vote_body name: post_vote_body
in: body in: body
@ -1391,13 +1386,13 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
- type: string - type: string
description: Bech32 voter address description: Bech32 voter address
name: voter name: voter
required: true required: true
in: path in: path
x-example: cosmos1qwl879nx9t6kef4supyazayf7vjhennyjqwjgr x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
responses: responses:
200: 200:
description: OK description: OK
@ -1423,7 +1418,7 @@ paths:
name: proposalId name: proposalId
required: true required: true
in: path in: path
x-example: '1' x-example: '2'
responses: responses:
200: 200:
description: OK description: OK
@ -1568,13 +1563,13 @@ paths:
description: Bech32 AccAddress of Delegator description: Bech32 AccAddress of Delegator
required: true required: true
type: string type: string
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
- in: path - in: path
name: validatorAddr name: validatorAddr
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Query a delegation reward summary: Query a delegation reward
description: Query a single delegation reward by a delegator description: Query a single delegation reward by a delegator
@ -1680,7 +1675,7 @@ paths:
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Validator distribution information summary: Validator distribution information
description: Query the distribution information of a single validator description: Query the distribution information of a single validator
@ -1704,7 +1699,7 @@ paths:
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Fee distribution outstanding rewards of a single validator summary: Fee distribution outstanding rewards of a single validator
tags: tags:
@ -1727,7 +1722,7 @@ paths:
description: Bech32 OperatorAddress of validator description: Bech32 OperatorAddress of validator
required: true required: true
type: string type: string
x-example: cosmosvaloper1qwl879nx9t6kef4supyazayf7vjhennyh568ys x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
get: get:
summary: Commission and self-delegation rewards of a single validator summary: Commission and self-delegation rewards of a single validator
description: Query the commission and self-delegation rewards of validator. description: Query the commission and self-delegation rewards of validator.
@ -1830,7 +1825,7 @@ paths:
goal_bonded: goal_bonded:
type: string type: string
blocks_per_year: blocks_per_year:
type: integer type: string
500: 500:
description: Internal Server Error description: Internal Server Error
/minting/inflation: /minting/inflation:
@ -1943,7 +1938,7 @@ definitions:
ValidatorAddress: ValidatorAddress:
type: string type: string
description: bech32 encoded address description: bech32 encoded address
example: cosmosvaloper1depk54cuajgkzea6zpgkq36tnjwdzv4avv9cxd example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
Coin: Coin:
type: object type: object
properties: properties:
@ -2220,7 +2215,7 @@ definitions:
$ref: "#/definitions/ValidatorAddress" $ref: "#/definitions/ValidatorAddress"
pub_key: pub_key:
type: string type: string
example: cosmosvalconspub1zcjduepq7sjfglw7ra4mjxpw4ph7dtdhdheh7nz8dfgl6t8u2n5szuuql9mqsrwquu example: cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
voting_power: voting_power:
type: string type: string
example: "1000" example: "1000"
@ -2254,7 +2249,7 @@ definitions:
type: object type: object
properties: properties:
proposal_id: proposal_id:
type: integer type: string
proposer: proposer:
type: string type: string
Deposit: Deposit:
@ -2265,7 +2260,7 @@ definitions:
items: items:
$ref: "#/definitions/Coin" $ref: "#/definitions/Coin"
proposal_id: proposal_id:
type: integer type: string
depositor: depositor:
$ref: "#/definitions/Address" $ref: "#/definitions/Address"
TallyResult: TallyResult:
@ -2289,7 +2284,7 @@ definitions:
voter: voter:
type: string type: string
proposal_id: proposal_id:
type: integer type: string
option: option:
type: string type: string
Validator: Validator:
@ -2299,7 +2294,7 @@ definitions:
$ref: "#/definitions/ValidatorAddress" $ref: "#/definitions/ValidatorAddress"
consensus_pubkey: consensus_pubkey:
type: string type: string
example: cosmosvalconspub1zcjduepq7sjfglw7ra4mjxpw4ph7dtdhdheh7nz8dfgl6t8u2n5szuuql9mqsrwquu example: cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
jailed: jailed:
type: boolean type: boolean
status: status:
@ -2357,6 +2352,28 @@ definitions:
type: string type: string
height: height:
type: integer type: integer
UnbondingDelegationPair:
type: object
properties:
delegator_address:
type: string
validator_address:
type: string
entries:
type: array
items:
$ref: "#/definitions/UnbondingEntries"
UnbondingEntries:
type: object
properties:
initial_balance:
type: string
balance:
type: string
creation_height:
type: string
min_time:
type: string
UnbondingDelegation: UnbondingDelegation:
type: object type: object
properties: properties:
@ -2411,6 +2428,13 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/Coin" $ref: "#/definitions/Coin"
PublicKey:
type: object
properties:
type:
type: string
value:
type: string
SigningInfo: SigningInfo:
type: object type: object
properties: properties: