mirror of
https://github.com/0glabs/0g-chain.git
synced 2025-11-04 00:07:51 +00:00
savings swagger (#1231)
This commit is contained in:
Denali Marsh
GitHub
parent
fefcb48a80
commit
30a071f83b
@ -167,6 +167,23 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"url": "./tmp-swagger-gen/kava/savings/v1beta1/query.swagger.json",
|
||||
"tags": {
|
||||
"rename": {
|
||||
"Query": "Savings"
|
||||
}
|
||||
},
|
||||
"operationIds": {
|
||||
"rename": [
|
||||
{
|
||||
"type": "regex",
|
||||
"from": "(.*)",
|
||||
"to": "Savings$1"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"url": "./client/docs/cosmos-swagger.yml",
|
||||
"dereference": {
|
||||
|
||||
@ -11041,6 +11041,214 @@ paths:
|
||||
format: boolean
|
||||
tags:
|
||||
- Swap
|
||||
/kava/savings/v1beta1/deposits:
|
||||
get:
|
||||
summary: Deposits queries savings deposits.
|
||||
operationId: SavingsDeposits
|
||||
responses:
|
||||
'200':
|
||||
description: A successful response.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
deposits:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
depositor:
|
||||
type: string
|
||||
amount:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
denom:
|
||||
type: string
|
||||
amount:
|
||||
type: string
|
||||
description: >-
|
||||
Coin defines a token with a denomination and an
|
||||
amount.
|
||||
|
||||
|
||||
NOTE: The amount field is an Int which implements the
|
||||
custom method
|
||||
|
||||
signatures required by gogoproto.
|
||||
description: >-
|
||||
Deposit defines an amount of coins deposited into a savings
|
||||
module account.
|
||||
pagination:
|
||||
type: object
|
||||
properties:
|
||||
next_key:
|
||||
type: string
|
||||
format: byte
|
||||
title: |-
|
||||
next_key is the key to be passed to PageRequest.key to
|
||||
query the next page most efficiently
|
||||
total:
|
||||
type: string
|
||||
format: uint64
|
||||
title: >-
|
||||
total is total number of results available if
|
||||
PageRequest.count_total
|
||||
|
||||
was set, its value is undefined otherwise
|
||||
description: >-
|
||||
PageResponse is to be embedded in gRPC response messages where
|
||||
the
|
||||
|
||||
corresponding request message has used PageRequest.
|
||||
|
||||
message SomeResponse {
|
||||
repeated Bar results = 1;
|
||||
PageResponse page = 2;
|
||||
}
|
||||
description: >-
|
||||
QueryDepositsResponse defines the response type for querying
|
||||
x/savings
|
||||
|
||||
deposits.
|
||||
default:
|
||||
description: An unexpected error response
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
code:
|
||||
type: integer
|
||||
format: int32
|
||||
message:
|
||||
type: string
|
||||
details:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
type_url:
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
format: byte
|
||||
parameters:
|
||||
- name: denom
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
- name: owner
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
- name: pagination.key
|
||||
description: |-
|
||||
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.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
format: byte
|
||||
- name: pagination.offset
|
||||
description: >-
|
||||
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.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
format: uint64
|
||||
- name: pagination.limit
|
||||
description: >-
|
||||
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.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
format: uint64
|
||||
- name: pagination.count_total
|
||||
description: >-
|
||||
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.
|
||||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
format: boolean
|
||||
- name: pagination.reverse
|
||||
description: >-
|
||||
reverse is set to true if results are to be returned in the
|
||||
descending order.
|
||||
|
||||
|
||||
Since: cosmos-sdk 0.43
|
||||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
format: boolean
|
||||
tags:
|
||||
- Savings
|
||||
/kava/savings/v1beta1/params:
|
||||
get:
|
||||
summary: Params queries all parameters of the savings module.
|
||||
operationId: SavingsParams
|
||||
responses:
|
||||
'200':
|
||||
description: A successful response.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
params:
|
||||
type: object
|
||||
properties:
|
||||
supported_denoms:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: Params defines the parameters for the savings module.
|
||||
description: >-
|
||||
QueryParamsResponse defines the response type for querying
|
||||
x/savings
|
||||
|
||||
parameters.
|
||||
default:
|
||||
description: An unexpected error response
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
code:
|
||||
type: integer
|
||||
format: int32
|
||||
message:
|
||||
type: string
|
||||
details:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
type_url:
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
format: byte
|
||||
tags:
|
||||
- Savings
|
||||
/node_info:
|
||||
get:
|
||||
description: Information about the connected node
|
||||
@ -55176,6 +55384,108 @@ definitions:
|
||||
|
||||
was set, its value is undefined otherwise
|
||||
description: QueryPoolsResponse is the response type for the Query/Pools RPC method.
|
||||
kava.savings.v1beta1.Deposit:
|
||||
type: object
|
||||
properties:
|
||||
depositor:
|
||||
type: string
|
||||
amount:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
denom:
|
||||
type: string
|
||||
amount:
|
||||
type: string
|
||||
description: |-
|
||||
Coin defines a token with a denomination and an amount.
|
||||
|
||||
NOTE: The amount field is an Int which implements the custom method
|
||||
signatures required by gogoproto.
|
||||
description: >-
|
||||
Deposit defines an amount of coins deposited into a savings module
|
||||
account.
|
||||
kava.savings.v1beta1.Params:
|
||||
type: object
|
||||
properties:
|
||||
supported_denoms:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: Params defines the parameters for the savings module.
|
||||
kava.savings.v1beta1.QueryDepositsResponse:
|
||||
type: object
|
||||
properties:
|
||||
deposits:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
depositor:
|
||||
type: string
|
||||
amount:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
denom:
|
||||
type: string
|
||||
amount:
|
||||
type: string
|
||||
description: >-
|
||||
Coin defines a token with a denomination and an amount.
|
||||
|
||||
|
||||
NOTE: The amount field is an Int which implements the custom
|
||||
method
|
||||
|
||||
signatures required by gogoproto.
|
||||
description: >-
|
||||
Deposit defines an amount of coins deposited into a savings module
|
||||
account.
|
||||
pagination:
|
||||
type: object
|
||||
properties:
|
||||
next_key:
|
||||
type: string
|
||||
format: byte
|
||||
title: |-
|
||||
next_key is the key to be passed to PageRequest.key to
|
||||
query the next page most efficiently
|
||||
total:
|
||||
type: string
|
||||
format: uint64
|
||||
title: >-
|
||||
total is total number of results available if
|
||||
PageRequest.count_total
|
||||
|
||||
was set, its value is undefined otherwise
|
||||
description: |-
|
||||
PageResponse is to be embedded in gRPC response messages where the
|
||||
corresponding request message has used PageRequest.
|
||||
|
||||
message SomeResponse {
|
||||
repeated Bar results = 1;
|
||||
PageResponse page = 2;
|
||||
}
|
||||
description: |-
|
||||
QueryDepositsResponse defines the response type for querying x/savings
|
||||
deposits.
|
||||
kava.savings.v1beta1.QueryParamsResponse:
|
||||
type: object
|
||||
properties:
|
||||
params:
|
||||
type: object
|
||||
properties:
|
||||
supported_denoms:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: Params defines the parameters for the savings module.
|
||||
description: |-
|
||||
QueryParamsResponse defines the response type for querying x/savings
|
||||
parameters.
|
||||
CheckTxResult:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user