Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix proto-swagger-gen #8184

Merged
merged 5 commits into from
Dec 21, 2020
Merged

Fix proto-swagger-gen #8184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b6b1d65
Fix proto-swagger-gen
amaury1093 Dec 17, 2020
a42acd0
Fix script
amaury1093 Dec 18, 2020
cde3357
Run script
amaury1093 Dec 18, 2020
68ddcb4
Merge branch 'master' into am-8171-swagger
anilcse Dec 18, 2020
aaa62db
Merge branch 'master' into am-8171-swagger
sahith-narahari Dec 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 107 additions & 21 deletions client/docs/swagger-ui/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22752,12 +22752,23 @@ paths:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will
be append(Path.KeyPath,

append(Path.KeyPrefix, key...))
delay_period:
type: string
format: uint64
description: delay period associated with this connection.
description: >-
IdentifiedConnection defines a connection with additional
connection
Expand Down Expand Up @@ -23099,11 +23110,11 @@ paths:
the IBC verison in

the connection handshake.
title: >-
description: >-
IBC version which can be utilised to determine encodings
or protocols for

channels or packets utilising this connection
channels or packets utilising this connection.
state:
description: current state of the connection end.
type: string
Expand Down Expand Up @@ -23132,18 +23143,35 @@ paths:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will be
append(Path.KeyPath,

append(Path.KeyPrefix, key...))
delay_period:
type: string
format: uint64
description: >-
delay period that must pass before a consensus state can
be used for packet-verification

NOTE: delay period logic is only implemented by some
clients.
description: >-
ConnectionEnd defines a stateful object on a chain connected
to another

separate one. NOTE: there must only be 2 defined
ConnectionEnds to establish
separate one.

NOTE: there must only be 2 defined ConnectionEnds to establish

a connection between two chains.
proof:
Expand Down Expand Up @@ -34685,11 +34713,11 @@ definitions:
verison in

the connection handshake.
title: >-
description: >-
IBC version which can be utilised to determine encodings or protocols
for

channels or packets utilising this connection
channels or packets utilising this connection.
state:
description: current state of the connection end.
type: string
Expand Down Expand Up @@ -34718,18 +34746,31 @@ definitions:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
description: >-
ConnectionEnd defines a stateful object on a chain connected to another
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will be
append(Path.KeyPath,

separate one. NOTE: there must only be 2 defined ConnectionEnds to
establish
append(Path.KeyPrefix, key...))
delay_period:
type: string
format: uint64
description: >-
delay period that must pass before a consensus state can be used for
packet-verification

NOTE: delay period logic is only implemented by some clients.
description: |-
ConnectionEnd defines a stateful object on a chain connected to another
separate one.
NOTE: there must only be 2 defined ConnectionEnds to establish
a connection between two chains.
ibc.core.connection.v1.Counterparty:
type: object
Expand All @@ -34749,12 +34790,19 @@ definitions:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will be
append(Path.KeyPath,

append(Path.KeyPrefix, key...))
description: >-
Counterparty defines the counterparty chain associated with a connection
end.
Expand Down Expand Up @@ -34818,12 +34866,23 @@ definitions:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will be
append(Path.KeyPath,

append(Path.KeyPrefix, key...))
delay_period:
type: string
format: uint64
description: delay period associated with this connection.
description: |-
IdentifiedConnection defines a connection with additional connection
identifier field.
Expand Down Expand Up @@ -35304,11 +35363,11 @@ definitions:
verison in

the connection handshake.
title: >-
description: >-
IBC version which can be utilised to determine encodings or
protocols for

channels or packets utilising this connection
channels or packets utilising this connection.
state:
description: current state of the connection end.
type: string
Expand Down Expand Up @@ -35337,18 +35396,34 @@ definitions:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will be
append(Path.KeyPath,

append(Path.KeyPrefix, key...))
delay_period:
type: string
format: uint64
description: >-
delay period that must pass before a consensus state can be used
for packet-verification

NOTE: delay period logic is only implemented by some clients.
description: >-
ConnectionEnd defines a stateful object on a chain connected to
another

separate one. NOTE: there must only be 2 defined ConnectionEnds to
establish
separate one.

NOTE: there must only be 2 defined ConnectionEnds to establish

a connection between two chains.
proof:
Expand Down Expand Up @@ -35452,12 +35527,23 @@ definitions:

given connection.
prefix:
title: commitment merkle prefix of the counterparty chain
description: commitment merkle prefix of the counterparty chain.
type: object
properties:
key_prefix:
type: string
format: byte
title: >-
MerklePrefix is merkle path prefixed to the key.

The constructed key from the Path and the key will be
append(Path.KeyPath,

append(Path.KeyPrefix, key...))
delay_period:
type: string
format: uint64
description: delay period associated with this connection.
description: |-
IdentifiedConnection defines a connection with additional connection
identifier field.
Expand Down
6 changes: 3 additions & 3 deletions scripts/protoc-swagger-gen.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ for dir in $proto_dirs; do
# generate swagger files (filter query files)
query_file=$(find "${dir}" -maxdepth 1 -name 'query.proto')
if [[ ! -z "$query_file" ]]; then
protoc \
buf protoc \
-I "proto" \
-I "third_party/proto" \
"$query_file" \
--swagger_out ./tmp-swagger-gen \
--swagger_opt logtostderr=true --swagger_opt fqn_for_swagger_name=true --swagger_opt simple_operation_ids=true
--swagger_out=./tmp-swagger-gen \
--swagger_opt=logtostderr=true --swagger_opt=fqn_for_swagger_name=true --swagger_opt=simple_operation_ids=true
fi
done

Expand Down