chore: update protoc-swagger-gen to protoc-openapi-gen

cosmos · May 17, 2024 · 9cea181 · 9cea181
1 parent 2c3fd19
commit 9cea181
Show file tree

Hide file tree

Showing 8 changed files with 9,899 additions and 13,255 deletions.
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
diff --git a/contrib/devtools/Dockerfile b/contrib/devtools/Dockerfile
@@ -26,8 +26,8 @@ ENV GOLANG_PROTOBUF_VERSION=1.28.1 \
 
 RUN go install github.com/cosmos/cosmos-proto/cmd/protoc-gen-go-pulsar@latest && \
   go install google.golang.org/protobuf/cmd/protoc-gen-go@v${GOLANG_PROTOBUF_VERSION} && \
-  go install github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway@v${GRPC_GATEWAY_VERSION} \
-  github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger@v${GRPC_GATEWAY_VERSION} && \
+  go install github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway@v${GRPC_GATEWAY_VERSION} && \
+  go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest && \
   go install cosmossdk.io/orm/cmd/[email protected] && \
   go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
 

diff --git a/proto/buf.gen.swagger.yaml b/proto/buf.gen.swagger.yaml
@@ -1,5 +1,5 @@
 version: v1
 plugins:
-  - name: swagger
+  - name: openapiv2
     out: ../tmp-swagger-gen
-    opt: logtostderr=true,fqn_for_swagger_name=true,simple_operation_ids=true
+    opt: logtostderr=true,fqn_for_openapi_name=true,simple_operation_ids=true,json_names_for_fields=false
diff --git a/proto/cosmos/app/v1alpha1/config.proto b/proto/cosmos/app/v1alpha1/config.proto
@@ -4,6 +4,8 @@ package cosmos.app.v1alpha1;
 
 import "google/protobuf/any.proto";
 
+option go_package = "cosmossdk.io/api/app/v1alpha1";
+
 // Config represents the configuration for a Cosmos SDK ABCI app.
 // It is intended that all state machine logic including the version of
 // baseapp and tx handlers (and possibly even Tendermint) that an app needs

diff --git a/proto/cosmos/app/v1alpha1/module.proto b/proto/cosmos/app/v1alpha1/module.proto
@@ -4,6 +4,8 @@ package cosmos.app.v1alpha1;
 
 import "google/protobuf/descriptor.proto";
 
+option go_package = "cosmossdk.io/api/app/v1alpha1";
+
 extend google.protobuf.MessageOptions {
   // module indicates that this proto type is a config object for an app module
   // and optionally provides other descriptive information about the module.

diff --git a/proto/cosmos/app/v1alpha1/query.proto b/proto/cosmos/app/v1alpha1/query.proto
@@ -4,6 +4,8 @@ package cosmos.app.v1alpha1;
 
 import "cosmos/app/v1alpha1/config.proto";
 
+option go_package = "cosmossdk.io/api/app/v1alpha1";
+
 // Query is the app module query service.
 service Query {
 

diff --git a/proto/cosmos/orm/query/v1alpha1/query.proto b/proto/cosmos/orm/query/v1alpha1/query.proto
@@ -7,6 +7,8 @@ import "google/protobuf/duration.proto";
 import "google/protobuf/any.proto";
 import "cosmos/base/query/v1beta1/pagination.proto";
 
+option go_package = "cosmossdk.io/api/app/cosmos/orm/query/v1alpha1";
+
 // Query is a generic gRPC service for querying ORM data.
 service Query {
 

diff --git a/scripts/protoc-swagger-gen.sh b/scripts/protoc-swagger-gen.sh
@@ -4,7 +4,7 @@ set -eo pipefail
 
 mkdir -p ./tmp-swagger-gen
 cd proto
-proto_dirs=$(find ./cosmos -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
+proto_dirs=$(find ./cosmos ../x -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
 for dir in $proto_dirs; do
   # generate swagger files (filter query files)
   query_file=$(find "${dir}" -maxdepth 1 \( -name 'query.proto' -o -name 'service.proto' \))