Skip to content

Commit

Permalink
- updates swagger
Browse files Browse the repository at this point in the history
  • Loading branch information
@StrathCole
StrathCole committed Nov 28, 2023
1 parent 0702c24 commit 0356e27
Show file tree
Hide file tree
Showing 3 changed files with 352 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 @@ -137,6 +137,14 @@
}
}
},
{
"url": "./tmp-swagger-gen/terra/taxexemption/v1beta1/query.swagger.json",
"operationIds": {
"rename": {
"Params": "TaxExemptionParams"
}
}
},
{
"url": "./tmp-swagger-gen/terra/dyncomm/v1beta1/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.

343 changes: 343 additions & 0 deletions client/docs/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26570,6 +26570,263 @@ paths:
format: byte
tags:
- Query
/terra/taxexemption/v1beta1/zones:
get:
operationId: TaxExemptionZonesList
responses:
'200':
description: A successful response.
schema:
type: object
properties:
zones:
type: array
items:
type: object
properties:
name:
type: string
outgoing:
type: boolean
incoming:
type: boolean
cross_zone:
type: boolean
pagination:
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
description: >-
PageResponse is to be embedded in gRPC response messages where
the

corresponding request message has used PageRequest.

message SomeResponse {
repeated Bar results = 1;
PageResponse page = 2;
}
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
/terra/taxexemption/v1beta1/{zone_name}/addresses:
get:
operationId: TaxExemptionAddressList
responses:
'200':
description: A successful response.
schema:
type: object
properties:
addresses:
type: array
items:
type: string
pagination:
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
description: >-
PageResponse is to be embedded in gRPC response messages where
the

corresponding request message has used PageRequest.

message SomeResponse {
repeated Bar results = 1;
PageResponse page = 2;
}
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: zone_name
in: path
required: true
type: string
- 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
/terra/dyncomm/v1beta1/params:
get:
summary: Params queries all parameters.
Expand Down Expand Up @@ -61033,6 +61290,92 @@ definitions:
description: |-
QueryTaxRateResponse is response type for the
Query/TaxRate RPC method.
terra.taxexemption.v1beta1.QueryTaxExemptionAddressResponse:
type: object
properties:
addresses:
type: array
items:
type: string
pagination:
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
description: |-
PageResponse is to be embedded in gRPC response messages where the
corresponding request message has used PageRequest.

message SomeResponse {
repeated Bar results = 1;
PageResponse page = 2;
}
terra.taxexemption.v1beta1.QueryTaxExemptionZonesResponse:
type: object
properties:
zones:
type: array
items:
type: object
properties:
name:
type: string
outgoing:
type: boolean
incoming:
type: boolean
cross_zone:
type: boolean
pagination:
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
description: |-
PageResponse is to be embedded in gRPC response messages where the
corresponding request message has used PageRequest.

message SomeResponse {
repeated Bar results = 1;
PageResponse page = 2;
}
terra.taxexemption.v1beta1.Zone:
type: object
properties:
name:
type: string
outgoing:
type: boolean
incoming:
type: boolean
cross_zone:
type: boolean
terra.dyncomm.v1beta1.Params:
type: object
properties:
Expand Down

0 comments on commit 0356e27

Please sign in to comment.