Skip to content

Commit 62963d5

Browse files
committed
Fix swagger and openapi
1 parent c1ad1a3 commit 62963d5

File tree

9 files changed

+89829
-203597
lines changed

9 files changed

+89829
-203597
lines changed

Makefile

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
VERSION ?= $(shell echo $(shell git describe --tags) | sed 's/^v//')
22
COMMIT := $(shell git log -1 --format='%H')
33
DOCKER := $(shell which docker)
4-
DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf
54

65
# SPID and API_KEY are used for Intel SGX attestation
76
SPID ?= 00000000000000000000000000000000
@@ -541,30 +540,42 @@ aesm-image:
541540
docker build -f deployment/dockerfiles/aesm.Dockerfile -t enigmampc/aesm .
542541

543542
###############################################################################
544-
### Protobuf ###
543+
### Swagger & Protobuf ###
545544
###############################################################################
546545

547546
protoVer=0.14.0
548547
protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
549548
protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(protoImageName)
550549

551-
proto-all: proto-format proto-gen proto-swagger-gen
550+
.PHONY: update-swagger-openapi-docs statik statik-install proto-swagger-openapi-gen
551+
552+
statik-install:
553+
@echo "Installing statik..."
554+
@go install github.com/rakyll/[email protected]
555+
556+
statik:
557+
statik -src=client/docs/static/ -dest=client/docs -f -m
558+
559+
proto-swagger-openapi-gen:
560+
@echo "Generating Protobuf Swagger: $@"
561+
@./scripts/protoc-swagger-openapi-gen.sh
562+
563+
# Example `CHAIN_VERSION=v1.4.0 make update-swagger-openapi-docs`
564+
update-swagger-openapi-docs: statik-install proto-swagger-openapi-gen statik
565+
566+
proto-all: proto-format proto-gen proto-swagger-openapi-gen
552567

553568
proto-gen:
554569
@echo "Generating Protobuf files"
555570
@$(protoImage) sh ./scripts/protocgen.sh
556571

557-
proto-swagger-gen:
558-
@echo "Generating Protobuf Swagger: $@"
559-
@$(shell ./scripts/protoc-swagger-gen.sh $@)
572+
proto-lint:
573+
@$(protoImage) buf lint --error-format=json
560574

561575
proto-format:
562576
@$(protoImage) find ./proto -name "*.proto" -exec clang-format -i {} \;
563577

564-
proto-lint:
565-
@$(protoImage) buf lint --error-format=json
566-
567-
.PHONY: proto-all proto-gen proto-swagger-gen proto-format proto-lint
578+
.PHONY: proto-all proto-gen proto-format proto-lint proto-check-breaking
568579

569580
.PHONY: check-hw
570581
check-hw: build-linux

client/docs/config.json

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -72,28 +72,6 @@
7272
}
7373
}
7474
},
75-
{
76-
"url": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.json",
77-
"operationIds": {
78-
"rename": {
79-
"Params": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonParams",
80-
"Pool": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonPool",
81-
"DelegatorValidators": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonDelegatorValidators",
82-
"UpgradedConsensusState": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonUpgradedConsensusState",
83-
"Accounts": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonAccounts",
84-
"Account": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonAccount",
85-
"Proposal": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonProposal",
86-
"Proposals": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonProposals",
87-
"Deposits": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonDeposits",
88-
"Deposit": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonDeposit",
89-
"TallyResult": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonTallyResult",
90-
"Votes": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonVotes",
91-
"Vote": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonVote",
92-
"Balance": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonBalance",
93-
"Code": "../../tmp-swagger-gen/cosmos/autocli/v1/query.swagger.jsonCode"
94-
}
95-
}
96-
},
9775
{
9876
"url": "../../tmp-swagger-gen/cosmos/bank/v1beta1/query.swagger.json",
9977
"operationIds": {
@@ -424,28 +402,6 @@
424402
}
425403
}
426404
},
427-
{
428-
"url": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.json",
429-
"operationIds": {
430-
"rename": {
431-
"Params": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonParams",
432-
"Pool": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonPool",
433-
"DelegatorValidators": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonDelegatorValidators",
434-
"UpgradedConsensusState": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonUpgradedConsensusState",
435-
"Accounts": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonAccounts",
436-
"Account": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonAccount",
437-
"Proposal": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonProposal",
438-
"Proposals": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonProposals",
439-
"Deposits": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonDeposits",
440-
"Deposit": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonDeposit",
441-
"TallyResult": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonTallyResult",
442-
"Votes": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonVotes",
443-
"Vote": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonVote",
444-
"Balance": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonBalance",
445-
"Code": "../../tmp-swagger-gen/cosmos/tx/v1beta1/fixed-service.swagger.jsonCode"
446-
}
447-
}
448-
},
449405
{
450406
"url": "../../tmp-swagger-gen/cosmos/upgrade/v1beta1/query.swagger.json",
451407
"operationIds": {
@@ -556,28 +512,6 @@
556512
}
557513
}
558514
},
559-
{
560-
"url": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.json",
561-
"operationIds": {
562-
"rename": {
563-
"Params": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonParams",
564-
"Pool": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonPool",
565-
"DelegatorValidators": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonDelegatorValidators",
566-
"UpgradedConsensusState": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonUpgradedConsensusState",
567-
"Accounts": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonAccounts",
568-
"Account": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonAccount",
569-
"Proposal": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonProposal",
570-
"Proposals": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonProposals",
571-
"Deposits": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonDeposits",
572-
"Deposit": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonDeposit",
573-
"TallyResult": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonTallyResult",
574-
"Votes": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonVotes",
575-
"Vote": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonVote",
576-
"Balance": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonBalance",
577-
"Code": "../../tmp-swagger-gen/ibc-apps/packetforward/v1/query.swagger.jsonCode"
578-
}
579-
}
580-
},
581515
{
582516
"url": "../../tmp-swagger-gen/ibc/core/channel/v1/query.swagger.json",
583517
"operationIds": {
@@ -709,12 +643,6 @@
709643
"Code": "../../tmp-swagger-gen/secret/registration/v1beta1/query.swagger.jsonCode"
710644
}
711645
}
712-
},
713-
{
714-
"url": "./swagger_legacy.yaml",
715-
"dereference": {
716-
"circular": "ignore"
717-
}
718646
}
719647
]
720648
}

0 commit comments

Comments
 (0)