Skip to content

Commit

Permalink
chore(precisebank): Add queries to swagger (#2004)
Browse files Browse the repository at this point in the history
This adds the precisebank protobuf generated swagger documentation to
the swagger combine configuration in order to be rendered in the
swagger.yaml file.
  • Loading branch information
nddeluca authored Aug 13, 2024
1 parent 7e50ce8 commit fbce24a
Show file tree
Hide file tree
Showing 2 changed files with 224 additions and 0 deletions.
17 changes: 17 additions & 0 deletions client/docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,23 @@
]
}
},
{
"url": "./out/swagger/kava/precisebank/v1/query.swagger.json",
"tags": {
"rename": {
"Query": "Precisebank"
}
},
"operationIds": {
"rename": [
{
"type": "regex",
"from": "(.*)",
"to": "Precisebank$1"
}
]
}
},
{
"url": "./out/swagger/kava/pricefeed/v1beta1/query.swagger.json",
"tags": {
Expand Down
207 changes: 207 additions & 0 deletions client/docs/swagger-ui/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12019,6 +12019,163 @@ paths:
format: byte
tags:
- Liquid
/kava/precisebank/v1/fractional_balance/{address}:
get:
summary: >-
FractionalBalance returns only the fractional balance of an address.
This

does not include any integer balance.
operationId: PrecisebankFractionalBalance
responses:
'200':
description: A successful response.
schema:
type: object
properties:
fractional_balance:
description: fractional_balance is the fractional balance of the address.
type: object
properties:
denom:
type: string
amount:
type: string
description: >-
QueryFractionalBalanceResponse defines the response type for
Query/FractionalBalance method.
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: address
description: address is the account address to query fractional balance for.
in: path
required: true
type: string
tags:
- Precisebank
/kava/precisebank/v1/remainder:
get:
summary: |-
Remainder returns the amount backed by the reserve, but not yet owned by
any account, i.e. not in circulation.
operationId: PrecisebankRemainder
responses:
'200':
description: A successful response.
schema:
type: object
properties:
remainder:
description: >-
remainder is the amount backed by the reserve, but not yet
owned by any

account, i.e. not in circulation.
type: object
properties:
denom:
type: string
amount:
type: string
description: >-
QueryRemainderResponse defines the response type for
Query/Remainder method.
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:
- Precisebank
/kava/precisebank/v1/total_fractional_balances:
get:
summary: |-
TotalFractionalBalances returns the total sum of all fractional balances
managed by the precisebank module.
operationId: PrecisebankTotalFractionalBalances
responses:
'200':
description: A successful response.
schema:
type: object
properties:
total:
description: >-
total is the total sum of all fractional balances managed by
the precisebank

module.
type: object
properties:
denom:
type: string
amount:
type: string
description: >-
QueryTotalFractionalBalancesResponse defines the response type for
Query/TotalFractionalBalances method.
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:
- Precisebank
/kava/pricefeed/v1beta1/markets:
get:
summary: Markets queries all markets
Expand Down Expand Up @@ -62082,6 +62239,56 @@ definitions:
description: >-
TotalSupplyResponse defines the response type for the Query/TotalSupply
method.
kava.precisebank.v1.QueryFractionalBalanceResponse:
type: object
properties:
fractional_balance:
description: fractional_balance is the fractional balance of the address.
type: object
properties:
denom:
type: string
amount:
type: string
description: >-
QueryFractionalBalanceResponse defines the response type for
Query/FractionalBalance method.
kava.precisebank.v1.QueryRemainderResponse:
type: object
properties:
remainder:
description: >-
remainder is the amount backed by the reserve, but not yet owned by
any

account, i.e. not in circulation.
type: object
properties:
denom:
type: string
amount:
type: string
description: >-
QueryRemainderResponse defines the response type for Query/Remainder
method.
kava.precisebank.v1.QueryTotalFractionalBalancesResponse:
type: object
properties:
total:
description: >-
total is the total sum of all fractional balances managed by the
precisebank

module.
type: object
properties:
denom:
type: string
amount:
type: string
description: >-
QueryTotalFractionalBalancesResponse defines the response type for
Query/TotalFractionalBalances method.
kava.pricefeed.v1beta1.CurrentPriceResponse:
type: object
properties:
Expand Down

0 comments on commit fbce24a

Please sign in to comment.