Skip to content

Commit bf444a6

Browse files
add swagger for interchain accounts (cosmos#1402)
## 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
1 parent 2ae4f10 commit bf444a6

File tree

2 files changed

+173
-0
lines changed

2 files changed

+173
-0
lines changed

docs/client/config.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@
1414
}
1515
}
1616
},
17+
{
18+
"url": "./tmp-swagger-gen/ibc/applications/interchain_accounts/controller/v1/query.swagger.json",
19+
"operationIds": {
20+
"rename": {
21+
"Params": "InterchainAccountsControllerParams"
22+
}
23+
}
24+
},
25+
{
26+
"url": "./tmp-swagger-gen/ibc/applications/interchain_accounts/host/v1/query.swagger.json",
27+
"operationIds": {
28+
"rename": {
29+
"Params": "InterchainAccountsHostParams"
30+
}
31+
}
32+
},
1733
{
1834
"url": "./tmp-swagger-gen/ibc/core/client/v1/query.swagger.json",
1935
"operationIds": {

docs/client/swagger-ui/swagger.yaml

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,105 @@ paths:
300300
format: byte
301301
tags:
302302
- Query
303+
/ibc/apps/interchain_accounts/controller/v1/params:
304+
get:
305+
summary: Params queries all parameters of the ICA controller submodule.
306+
operationId: InterchainAccountsControllerParams
307+
responses:
308+
'200':
309+
description: A successful response.
310+
schema:
311+
type: object
312+
properties:
313+
params:
314+
description: params defines the parameters of the module.
315+
type: object
316+
properties:
317+
controller_enabled:
318+
type: boolean
319+
format: boolean
320+
description: >-
321+
controller_enabled enables or disables the controller
322+
submodule.
323+
description: >-
324+
QueryParamsResponse is the response type for the Query/Params RPC
325+
method.
326+
default:
327+
description: An unexpected error response
328+
schema:
329+
type: object
330+
properties:
331+
error:
332+
type: string
333+
code:
334+
type: integer
335+
format: int32
336+
message:
337+
type: string
338+
details:
339+
type: array
340+
items:
341+
type: object
342+
properties:
343+
type_url:
344+
type: string
345+
value:
346+
type: string
347+
format: byte
348+
tags:
349+
- Query
350+
/ibc/apps/interchain_accounts/host/v1/params:
351+
get:
352+
summary: Params queries all parameters of the ICA host submodule.
353+
operationId: InterchainAccountsHostParams
354+
responses:
355+
'200':
356+
description: A successful response.
357+
schema:
358+
type: object
359+
properties:
360+
params:
361+
description: params defines the parameters of the module.
362+
type: object
363+
properties:
364+
host_enabled:
365+
type: boolean
366+
format: boolean
367+
description: host_enabled enables or disables the host submodule.
368+
allow_messages:
369+
type: array
370+
items:
371+
type: string
372+
description: >-
373+
allow_messages defines a list of sdk message typeURLs
374+
allowed to be executed on a host chain.
375+
description: >-
376+
QueryParamsResponse is the response type for the Query/Params RPC
377+
method.
378+
default:
379+
description: An unexpected error response
380+
schema:
381+
type: object
382+
properties:
383+
error:
384+
type: string
385+
code:
386+
type: integer
387+
format: int32
388+
message:
389+
type: string
390+
details:
391+
type: array
392+
items:
393+
type: object
394+
properties:
395+
type_url:
396+
type: string
397+
value:
398+
type: string
399+
format: byte
400+
tags:
401+
- Query
303402
/ibc/client/v1/params:
304403
get:
305404
summary: ClientParams queries all parameters of the ibc client.
@@ -10002,6 +10101,64 @@ definitions:
1000210101
1000310102
chain.
1000410103
description: QueryParamsResponse is the response type for the Query/Params RPC method.
10104+
ibc.applications.interchain_accounts.controller.v1.Params:
10105+
type: object
10106+
properties:
10107+
controller_enabled:
10108+
type: boolean
10109+
format: boolean
10110+
description: controller_enabled enables or disables the controller submodule.
10111+
description: |-
10112+
Params defines the set of on-chain interchain accounts parameters.
10113+
The following parameters may be used to disable the controller submodule.
10114+
ibc.applications.interchain_accounts.controller.v1.QueryParamsResponse:
10115+
type: object
10116+
properties:
10117+
params:
10118+
description: params defines the parameters of the module.
10119+
type: object
10120+
properties:
10121+
controller_enabled:
10122+
type: boolean
10123+
format: boolean
10124+
description: controller_enabled enables or disables the controller submodule.
10125+
description: QueryParamsResponse is the response type for the Query/Params RPC method.
10126+
ibc.applications.interchain_accounts.host.v1.Params:
10127+
type: object
10128+
properties:
10129+
host_enabled:
10130+
type: boolean
10131+
format: boolean
10132+
description: host_enabled enables or disables the host submodule.
10133+
allow_messages:
10134+
type: array
10135+
items:
10136+
type: string
10137+
description: >-
10138+
allow_messages defines a list of sdk message typeURLs allowed to be
10139+
executed on a host chain.
10140+
description: |-
10141+
Params defines the set of on-chain interchain accounts parameters.
10142+
The following parameters may be used to disable the host submodule.
10143+
ibc.applications.interchain_accounts.host.v1.QueryParamsResponse:
10144+
type: object
10145+
properties:
10146+
params:
10147+
description: params defines the parameters of the module.
10148+
type: object
10149+
properties:
10150+
host_enabled:
10151+
type: boolean
10152+
format: boolean
10153+
description: host_enabled enables or disables the host submodule.
10154+
allow_messages:
10155+
type: array
10156+
items:
10157+
type: string
10158+
description: >-
10159+
allow_messages defines a list of sdk message typeURLs allowed to
10160+
be executed on a host chain.
10161+
description: QueryParamsResponse is the response type for the Query/Params RPC method.
1000510162
ibc.core.client.v1.ConsensusStateWithHeight:
1000610163
type: object
1000710164
properties:

0 commit comments

Comments
 (0)