From db52bebe20363b2041539fa5def2e50a1745533a Mon Sep 17 00:00:00 2001 From: Roman Date: Tue, 16 May 2023 22:58:33 -0400 Subject: [PATCH] fix: make proto-docs; unsupported address proto tag (#5195) --- client/docs/static/openapi/index.html | 82 +- client/docs/static/openapi/openapi.yaml | 2400 ++++++++++++++++--- client/docs/static/swagger/swagger.yaml | 2165 ++++++++++++++++- client/docs/statik/statik.go | 2 +- proto/osmosis/protorev/v1beta1/params.proto | 5 +- x/protorev/types/params.pb.go | 21 +- 6 files changed, 4215 insertions(+), 460 deletions(-) diff --git a/client/docs/static/openapi/index.html b/client/docs/static/openapi/index.html index 25016648594..96ae9b1db12 100644 --- a/client/docs/static/openapi/index.html +++ b/client/docs/static/openapi/index.html @@ -466,28 +466,30 @@ -

EpochInfos provide running epochInfos

Responses

PoolsWithFilter allows you to query specific pools with requested -parameters

query Parameters
pool_type
string
pagination.key
string <byte>

key is a value returned in PageResponse.next_key to begin +

ConcentratedPoolIdLinkFromBalancer returns the pool id of the concentrated +pool that is linked with the given CFMM pool.

path Parameters
cfmm_pool_id
required
string <uint64>

Responses

PoolsWithFilter allows you to query specific pools with requested +parameters

query Parameters
min_liquidity
string

String of the coins in single string seperated by comma. Ex) +10uatom,100uosmo.

+
pool_type
string
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. @@ -539,7 +546,7 @@

Since: cosmos-sdk 0.43

Responses

NumPools

Responses

Deprecated: please use the alternative in x/poolmanager

Responses

PoolType returns the type of the pool. Returns "Balancer" as a string literal when the pool is a balancer pool. @@ -561,7 +568,7 @@

Since: cosmos-sdk 0.43

Responses

Per Pool gRPC Endpoints

path Parameters
pool_id
required
string <uint64>

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters
pool_id
required
string <uint64>

Responses

CalcExitPoolCoinsFromShares

path Parameters
pool_id
required
string <uint64>
query Parameters
share_in_amount
string

Responses

SpotPrice defines a gRPC query handler that returns the spot price given a base denomination and a quote denomination.

path Parameters
pool_id
required
string <uint64>
query Parameters
base_asset_denom
string
quote_asset_denom
string

Responses

TotalPoolLiquidity

path Parameters
pool_id
required
string <uint64>

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters
pool_id
required
string <uint64>

Responses

TotalShares

path Parameters
pool_id
required
string <uint64>

Responses

TotalLiquidity

Responses

Estimate the swap.

path Parameters
pool_id
required
string <uint64>
query Parameters
sender
string

TODO: CHANGE THIS TO RESERVED IN A PATCH RELEASE.

-
token_in
string

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters
pool_id
required
string <uint64>
query Parameters
sender
string
token_in
string

Responses

EstimateSwapExactAmountOut

path Parameters
pool_id
required
string <uint64>
query Parameters
sender
string

TODO: CHANGE THIS TO RESERVED IN A PATCH RELEASE.

-
token_out
string

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters
pool_id
required
string <uint64>
query Parameters
sender
string
token_out
string

Responses

ActiveGauges returns active gauges

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 @@ -715,7 +720,9 @@

Return locked balance of the module

Responses

Params returns lockup params.

Responses

Returns next lock ID

Responses

Params returns lockup params.

Responses

Returns synthetic lockups by native lockup id

path Parameters
lock_id
required
string <uint64>

Responses

DenomAuthorityMetadata defines a gRPC query method for fetching DenomAuthorityMetadata for a particular denom.

path Parameters
denom
required
string

Responses

DenomsFromCreator defines a gRPC query method for fetching all +

BeforeSendHookAddress defines a gRPC query method for +getting the address registered for the before send hook.

path Parameters
denom
required
string

Responses

DenomsFromCreator defines a gRPC query method for fetching all denominations created by a specific admin/creator.

path Parameters
creator
required
string

Responses

Params defines a gRPC query method that returns the tokenfactory module's @@ -843,7 +853,39 @@

Since: cosmos-sdk 0.43

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.

+

GranteeGrants returns a list of `GrantAuthorization` by grantee.

path Parameters
grantee
required
string
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.

+
pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

+

Since: cosmos-sdk 0.43

+

Responses

GranterGrants returns list of `Authorization`, granted by granter.

path Parameters
granter
required
string
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.

+
pagination.reverse
boolean

reverse is set to true if results are to be returned in the descending order.

+

Since: cosmos-sdk 0.43

+

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.

@@ -1376,7 +1418,7 @@