Skip to content

Commit

Permalink
update swagger.yaml; update 02-client grpc_query_test
Browse files Browse the repository at this point in the history
  • Loading branch information
@catShaark
catShaark committed Jun 4, 2022
1 parent da46f52 commit 43db851
Show file tree
Hide file tree
Showing 3 changed files with 378 additions and 50 deletions.
341 changes: 339 additions & 2 deletions docs/client/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4285,6 +4285,331 @@ paths:
type: string
tags:
- Query
'/ibc/core/client/v1/consensus_states/heights/{client_id}':
get:
summary: >-
ConsensusStateHeights queries the height of every consensus states
associated with a given client.
operationId: ConsensusStateHeights
responses:
'200':
description: A successful response.
schema:
type: object
properties:
consensus_state_heights:
type: array
items:
type: object
properties:
revision_number:
type: string
format: uint64
title: the revision that the client is currently on
revision_height:
type: string
format: uint64
title: the height within the given revision
description: >-
Normally the RevisionHeight is incremented at each height
while keeping

RevisionNumber the same. However some consensus algorithms
may choose to

reset the height in certain conditions e.g. hard forks,
state-machine

breaking changes In these cases, the RevisionNumber is
incremented so that

height continues to be monitonically increasing even as the
RevisionHeight

gets reset
title: >-
Height is a monotonically increasing data type

that can be compared against another Height for the purposes
of updating and

freezing clients
title: consensus state heights
pagination:
title: pagination response
type: object
properties:
next_key:
type: string
format: byte
title: |-
next_key is the key to be passed to PageRequest.key to
query the next page most efficiently
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;
}
title: |-
QueryConsensusStateHeightsResponse is the response type for the
Query/ConsensusStateHeights 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
description: >-
A URL/resource name that uniquely identifies the type of
the serialized

protocol buffer message. This string must contain at
least

one "/" character. The last segment of the URL's path
must represent

the fully qualified name of the type (as in

`path/google.protobuf.Duration`). The name should be in
a canonical form

(e.g., leading "." is not accepted).


In practice, teams usually precompile into the binary
all types that they

expect it to use in the context of Any. However, for
URLs which use the

scheme `http`, `https`, or no scheme, one can optionally
set up a type

server that maps type URLs to message definitions as
follows:


* If no scheme is provided, `https` is assumed.

* An HTTP GET on the URL must yield a
[google.protobuf.Type][]
value in binary format, or produce an error.
* Applications are allowed to cache lookup results based
on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)

Note: this functionality is not currently available in
the official

protobuf release, and it is not used for type URLs
beginning with

type.googleapis.com.


Schemes other than `http`, `https` (or the empty scheme)
might be

used with implementation specific semantics.
value:
type: string
format: byte
description: >-
Must be a valid serialized protocol buffer of the above
specified type.
description: >-
`Any` contains an arbitrary serialized protocol buffer
message along with a

URL that describes the type of the serialized message.


Protobuf library provides support to pack/unpack Any values
in the form

of utility functions or additional generated methods of the
Any type.


Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := ptypes.MarshalAny(foo)
...
foo := &pb.Foo{}
if err := ptypes.UnmarshalAny(any, foo); err != nil {
...
}

The pack methods provided by protobuf library will by
default use

'type.googleapis.com/full.type.name' as the type URL and the
unpack

methods only use the fully qualified type name after the
last '/'

in the type URL, for example "foo.bar.com/x/y.z" will yield
type

name "y.z".



JSON

====

The JSON representation of an `Any` value uses the regular

representation of the deserialized, embedded message, with
an

additional field `@type` which contains the type URL.
Example:

package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}

{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}

If the embedded message type is well-known and has a custom
JSON

representation, that representation will be embedded adding
a field

`value` which holds the custom JSON in addition to the
`@type`

field. Example (for message [google.protobuf.Duration][]):

{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
parameters:
- name: client_id
description: client identifier
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
format: boolean
tags:
- Query
'/ibc/core/client/v1/consensus_states/{client_id}':
get:
summary: |-
Expand All @@ -4303,7 +4628,6 @@ paths:
type: object
properties:
height:
title: consensus state height
type: object
properties:
revision_number:
Expand Down Expand Up @@ -4331,6 +4655,13 @@ paths:
the RevisionHeight

gets reset
title: >-
Height is a monotonically increasing data type

that can be compared against another Height for the
purposes of updating and

freezing clients
consensus_state:
type: object
properties:
Expand Down Expand Up @@ -4983,7 +5314,6 @@ paths:
format: byte
title: merkle proof of existence
proof_height:
title: height at which the proof was retrieved
type: object
properties:
revision_number:
Expand Down Expand Up @@ -5011,6 +5341,13 @@ paths:
RevisionHeight

gets reset
title: >-
Height is a monotonically increasing data type

that can be compared against another Height for the purposes
of updating and

freezing clients
title: >-
QueryConsensusStateResponse is the response type for the
Query/ConsensusState
Expand Down
Loading

0 comments on commit 43db851

Please sign in to comment.