Skip to content

Commit

Permalink
update swagger (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
@beer-1
beer-1 authored Aug 26, 2024
1 parent 971506e commit 814c496
Show file tree
Hide file tree
Showing 3 changed files with 310 additions and 1 deletion.
8 changes: 8 additions & 0 deletions client/docs/config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,14 @@
}
}
},
{
"url": "./tmp-swagger-gen/initia/ibchooks/v1/query.swagger.json",
"operationIds": {
"rename": {
"Params": "IBCHooksParams"
}
}
},
{
"url": "./tmp-swagger-gen/opinit/opchild/v1/query.swagger.json",
"operationIds": {
Expand Down
2 changes: 1 addition & 1 deletion client/docs/statik/statik.go
View file

Large diffs are not rendered by default.

301 changes: 301 additions & 0 deletions client/docs/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37001,6 +37001,228 @@ paths:
format: uint64
tags:
- Query
/initia/ibchooks/v1/acls:
get:
summary: ACLs gets ACL entries.
operationId: ACLs
responses:
'200':
description: A successful response.
schema:
type: object
properties:
acls:
type: array
items:
type: object
properties:
address:
type: string
allowed:
type: boolean
description: ACL defines the ACL entry of an address.
pagination:
description: pagination defines the pagination in the response.
type: object
properties:
next_key:
type: string
format: byte
description: |-
next_key is the key to be passed to PageRequest.key to
query the next page most efficiently. It will be empty if
there are no more results.
total:
type: string
format: uint64
title: >-
total is total number of results available if
PageRequest.count_total

was set, its value is undefined otherwise
title: |-
QueryACLsResponse is the response type for the
Query/ACLAddrs RPC 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: 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
- 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
tags:
- Query
/initia/ibchooks/v1/acls/{address}:
get:
summary: ACL gets ACL entry of an address.
operationId: ACL
responses:
'200':
description: A successful response.
schema:
type: object
properties:
acl:
type: object
properties:
address:
type: string
allowed:
type: boolean
description: ACL defines the ACL entry of an address.
title: |-
QueryACLResponse is the response type for the Query/ACL RPC
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 a contract address (wasm, evm) or a contract deployer
address (move).
in: path
required: true
type: string
tags:
- Query
/initia/ibchooks/v1/params:
get:
summary: Params queries all parameters.
operationId: IBCHooksParams
responses:
'200':
description: A successful response.
schema:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
default_allowed:
type: boolean
description: |-
if the ACL of a address is not set,
then we use this value to decide the ACL.
description: >-
QueryParamsResponse is the response type for the Query/Params RPC
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:
- Query
/opinit/opchild/v1/base_denom/{denom}:
get:
operationId: BaseDenom
Expand Down Expand Up @@ -68560,6 +68782,85 @@ definitions:
PacketId is an identifer for a unique Packet
Source chains refer to packets by source port/channel
Destination chains refer to packets by destination port/channel
initia.ibchooks.v1.ACL:
type: object
properties:
address:
type: string
allowed:
type: boolean
description: ACL defines the ACL entry of an address.
initia.ibchooks.v1.Params:
type: object
properties:
default_allowed:
type: boolean
description: |-
if the ACL of a address is not set,
then we use this value to decide the ACL.
description: Params defines the set of hook parameters.
initia.ibchooks.v1.QueryACLResponse:
type: object
properties:
acl:
type: object
properties:
address:
type: string
allowed:
type: boolean
description: ACL defines the ACL entry of an address.
title: |-
QueryACLResponse is the response type for the Query/ACL RPC
method
initia.ibchooks.v1.QueryACLsResponse:
type: object
properties:
acls:
type: array
items:
type: object
properties:
address:
type: string
allowed:
type: boolean
description: ACL defines the ACL entry of an address.
pagination:
description: pagination defines the pagination in the response.
type: object
properties:
next_key:
type: string
format: byte
description: |-
next_key is the key to be passed to PageRequest.key to
query the next page most efficiently. It will be empty if
there are no more results.
total:
type: string
format: uint64
title: >-
total is total number of results available if
PageRequest.count_total

was set, its value is undefined otherwise
title: |-
QueryACLsResponse is the response type for the
Query/ACLAddrs RPC method
initia.ibchooks.v1.QueryParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
default_allowed:
type: boolean
description: |-
if the ACL of a address is not set,
then we use this value to decide the ACL.
description: QueryParamsResponse is the response type for the Query/Params RPC method.
cosmos.base.v1beta1.DecCoin:
type: object
properties:
Expand Down

0 comments on commit 814c496

Please sign in to comment.