Skip to content

Commit

Permalink
add swagger for interchain accounts (cosmos#1402) (cosmos#1411)
Browse files Browse the repository at this point in the history
## Description

closes: #XXXX

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

- [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [x] Re-reviewed `Files changed` in the Github PR explorer
- [ ] Review `Codecov Report` in the comment section below once CI passes

(cherry picked from commit bf444a6)

Co-authored-by: Carlos Rodriguez <[email protected]>
  • Loading branch information
2 people authored and ellie4x committed Aug 24, 2022
1 parent 0be91a3 commit ba1f3a1
Show file tree
Hide file tree
Showing 2 changed files with 173 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/client/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@
}
}
},
{
"url": "./tmp-swagger-gen/ibc/applications/interchain_accounts/controller/v1/query.swagger.json",
"operationIds": {
"rename": {
"Params": "InterchainAccountsControllerParams"
}
}
},
{
"url": "./tmp-swagger-gen/ibc/applications/interchain_accounts/host/v1/query.swagger.json",
"operationIds": {
"rename": {
"Params": "InterchainAccountsHostParams"
}
}
},
{
"url": "./tmp-swagger-gen/ibc/core/client/v1/query.swagger.json",
"operationIds": {
Expand Down
157 changes: 157 additions & 0 deletions docs/client/swagger-ui/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,105 @@ paths:
format: byte
tags:
- Query
/ibc/apps/interchain_accounts/controller/v1/params:
get:
summary: Params queries all parameters of the ICA controller submodule.
operationId: InterchainAccountsControllerParams
responses:
'200':
description: A successful response.
schema:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
controller_enabled:
type: boolean
format: boolean
description: >-
controller_enabled enables or disables the controller
submodule.
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
/ibc/apps/interchain_accounts/host/v1/params:
get:
summary: Params queries all parameters of the ICA host submodule.
operationId: InterchainAccountsHostParams
responses:
'200':
description: A successful response.
schema:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
host_enabled:
type: boolean
format: boolean
description: host_enabled enables or disables the host submodule.
allow_messages:
type: array
items:
type: string
description: >-
allow_messages defines a list of sdk message typeURLs
allowed to be executed on a host chain.
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
/ibc/client/v1/params:
get:
summary: ClientParams queries all parameters of the ibc client.
Expand Down Expand Up @@ -10000,6 +10099,64 @@ definitions:
chain.
description: QueryParamsResponse is the response type for the Query/Params RPC method.
ibc.applications.interchain_accounts.controller.v1.Params:
type: object
properties:
controller_enabled:
type: boolean
format: boolean
description: controller_enabled enables or disables the controller submodule.
description: |-
Params defines the set of on-chain interchain accounts parameters.
The following parameters may be used to disable the controller submodule.
ibc.applications.interchain_accounts.controller.v1.QueryParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
controller_enabled:
type: boolean
format: boolean
description: controller_enabled enables or disables the controller submodule.
description: QueryParamsResponse is the response type for the Query/Params RPC method.
ibc.applications.interchain_accounts.host.v1.Params:
type: object
properties:
host_enabled:
type: boolean
format: boolean
description: host_enabled enables or disables the host submodule.
allow_messages:
type: array
items:
type: string
description: >-
allow_messages defines a list of sdk message typeURLs allowed to be
executed on a host chain.
description: |-
Params defines the set of on-chain interchain accounts parameters.
The following parameters may be used to disable the host submodule.
ibc.applications.interchain_accounts.host.v1.QueryParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
host_enabled:
type: boolean
format: boolean
description: host_enabled enables or disables the host submodule.
allow_messages:
type: array
items:
type: string
description: >-
allow_messages defines a list of sdk message typeURLs allowed to
be executed on a host chain.
description: QueryParamsResponse is the response type for the Query/Params RPC method.
ibc.core.client.v1.ConsensusStateWithHeight:
type: object
properties:
Expand Down

0 comments on commit ba1f3a1

Please sign in to comment.