diff --git a/app/app.go b/app/app.go index ae9a9d77e2c..93f478a9228 100644 --- a/app/app.go +++ b/app/app.go @@ -11,6 +11,8 @@ import ( "github.com/gorilla/mux" "github.com/rakyll/statik/fs" + _ "github.com/c-osmosis/osmosis/client/docs/statik" + abci "github.com/tendermint/tendermint/abci/types" "github.com/tendermint/tendermint/libs/log" tmos "github.com/tendermint/tendermint/libs/os" diff --git a/client/docs/config.json b/client/docs/config.json index 4380e668f48..8dc6649e7bc 100644 --- a/client/docs/config.json +++ b/client/docs/config.json @@ -13,6 +13,88 @@ "Params": "GAMMParams" } } + }, + { + "url": "../../tmp-swagger-gen/cosmos/auth/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "AuthParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/bank/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "BankParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/distribution/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "DistributionParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/evidence/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "EvidenceParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/gov/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "GovParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/mint/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "MintParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/params/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "Params" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/slashing/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "SlashingParams" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/staking/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "StakingParams", + "Pool": "StakingPool", + "DelegatorValidators": "StakingDelegatorValidators" + } + } + }, + { + "url": "../../tmp-swagger-gen/cosmos/upgrade/v1beta1/query.swagger.json", + "operationIds": { + "rename": { + "Params": "UpgradeParams" + } + } } ] } diff --git a/client/docs/static/openapi/index.html b/client/docs/static/openapi/index.html index acafcfc43f0..2f5c3ed9293 100644 --- a/client/docs/static/openapi/index.html +++ b/client/docs/static/openapi/index.html @@ -302,6 +302,9 @@ data-styled.g73[id="sc-TtZHJ"]{content:"cRaJfP,"}/*!sc*/ .bfDxeF{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/ data-styled.g74[id="sc-jHNhIU"]{content:"bfDxeF,"}/*!sc*/ +.dYpOEw{border-radius:2px;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/ +.sc-eKYRpg + .sc-eKYRpg{margin-left:0;}/*!sc*/ +data-styled.g78[id="sc-eKYRpg"]{content:"dYpOEw,"}/*!sc*/ .bCtQK{margin-top:0;margin-bottom:0.5em;}/*!sc*/ data-styled.g86[id="sc-fuIRbl"]{content:"bCtQK,"}/*!sc*/ .htVLwM{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;-webkit-text-decoration:none;text-decoration:none;cursor:pointer;}/*!sc*/ @@ -399,7 +402,13 @@ -
Documentation Powered by ReDoc
Documentation Powered by ReDoc
default

An unexpected error response.

TokenBalance

path Parameters
poolId
required
string <uint64>

Responses

+

Account returns account details based on address.

path Parameters
address
required
string

address defines the address to query for.

+

Responses

Params queries all parameters.

Responses

AllBalances queries the balance of all coins for a single account.

path Parameters
address
required
string

address is the address to query balances for.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Balance queries the balance of a single coin for a single account.

path Parameters
address
required
string

address is the address to query balances for.

+
denom
required
string

denom is the coin denom to query balances for.

+

Responses

Params queries the parameters of x/bank module.

Responses

TotalSupply queries the total supply of all coins.

Responses

SupplyOf queries the supply of a single coin.

path Parameters
denom
required
string

denom is the coin denom to query balances for.

+

Responses

CommunityPool queries the community pool coins.

Responses

DelegationTotalRewards queries the total rewards accrued by a each +validator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

+

Responses

DelegationRewards queries the total rewards accrued by a delegation.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

+
validator_address
required
string

validator_address defines the validator address to query for.

+

Responses

DelegatorValidators queries the validators of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

+

Responses

DelegatorWithdrawAddress queries withdraw address of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

+

Responses

Params queries params of the distribution module.

Responses

ValidatorCommission queries accumulated commission for a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

+

Responses

ValidatorOutstandingRewards queries rewards of a validator address.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

+

Responses

ValidatorSlashes queries slash events of a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

+
query Parameters
starting_height
string <uint64>

starting_height defines the optional starting height to query the slashes.

+
ending_height
string <uint64>

starting_height defines the optional ending height to query the slashes.

+
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

AllEvidence queries all evidence.

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Evidence queries evidence based on evidence hash.

path Parameters
evidence_hash
required
string <byte>

evidence_hash defines the hash of the requested evidence.

+

Responses

Params queries all parameters of the gov module.

path Parameters
params_type
required
string

params_type defines which parameters to query for, can be one of "voting", +"tallying" or "deposit".

+

Responses

Proposals queries all proposals based on given status.

query Parameters
proposal_status
string
Default: "PROPOSAL_STATUS_UNSPECIFIED"
Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED"

proposal_status defines the status of the proposals.

+
    +
  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
    • +
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit +period.
    • +
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting +period.
    • +
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has +passed.
    • +
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has +been rejected.
    • +
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has +failed.
    • +
+
voter
string

voter defines the voter address for the proposals.

+
depositor
string

depositor defines the deposit addresses from the proposals.

+
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Proposal queries proposal details based on ProposalID.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

+

Responses

Deposits queries all deposits of a single proposal.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Deposit queries single deposit information based proposalID, depositAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

+
depositor
required
string

depositor defines the deposit addresses from the proposals.

+

Responses

TallyResult queries the tally of a proposal vote.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

+

Responses

Votes queries votes of a given proposal.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Vote queries voted information based on proposalID, voterAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

+
voter
required
string

voter defines the oter address for the proposals.

+

Responses

AnnualProvisions current minting annual provisions value.

Responses

Inflation returns the current minting inflation value.

Responses

Params returns the total set of minting parameters.

Responses

Params queries a specific parameter of a module, given its subspace and +key.

query Parameters
subspace
string

subspace defines the module to query the parameter for.

+
key
string

key defines the key of the parameter in the subspace.

+

Responses

Params queries the parameters of slashing module

Responses

SigningInfos queries signing info of all validators

query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

SigningInfo queries the signing info of given cons address

path Parameters
cons_address
required
string

cons_address is the address to query signing info of

+

Responses

DelegatorDelegations queries all delegations of a given delegator address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Redelegations queries redelegations of given address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+
query Parameters
src_validator_addr
string

src_validator_addr defines the validator address to redelegate from.

+
dst_validator_addr
string

dst_validator_addr defines the validator address to redelegate to.

+
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

DelegatorUnbondingDelegations queries all unbonding delegations of a given +delegator address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

DelegatorValidators queries all validators info for given delegator +address.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

DelegatorValidator queries validator info for given delegator validator +pair.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+
validator_addr
required
string

validator_addr defines the validator address to query for.

+

Responses

HistoricalInfo queries the historical info for given height.

path Parameters
height
required
string <int64>

height defines at which height to query the historical info.

+

Responses

Parameters queries the staking parameters.

Responses

Pool queries the pool info.

Responses

Validators queries all validators that match the given status.

query Parameters
status
string

status enables to query for validators matching a given status.

+
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Validator queries validator info for given validator address.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

+

Responses

ValidatorDelegations queries delegate info for given validator.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

Delegation queries delegate info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

+
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+

Responses

UnbondingDelegation queries unbonding info for given validator delegator +pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

+
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

+

Responses

ValidatorUnbondingDelegations queries unbonding delegations of a validator.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

+
query Parameters
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+
pagination.offset
string <uint64>

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+
pagination.limit
string <uint64>

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+
pagination.count_total
boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

Responses

AppliedPlan queries a previously applied upgrade plan by its name.

path Parameters
name
required
string

name is the name of the applied plan to query for.

+

Responses

CurrentPlan queries the current upgrade plan.

Responses