Auto Swagger Doc Generation

.circleci/config.yml

@@ -162,18 +162,18 @@ jobs:
           name: upload
           command: bash <(curl -s https://codecov.io/bash) -f coverage.txt
 
-  update-swagger-docs:
+  verify-swagger-docs:
     executor: golang
     steps:
       - make:
-          target: update-swagger-docs
-          description: "Check if statik.go is up-to-date"
+          target: verify-swagger-docs
+          description: "Verify Swagger docs are up-to-date"
 
 workflows:
   version: 2
   test-suite:
     jobs:
-      - update-swagger-docs:
+      - verify-swagger-docs:
           requires:
             - setup-dependencies
       - setup-dependencies:

.gitattributes

@@ -1 +1 @@
-client/lcd/swagger-ui/* linguist-vendored
+client/rest/docs/* linguist-vendored

CHANGELOG.md

@@ -55,6 +55,8 @@ have this method perform a no-op.
   * Update gov keys to use big endian encoding instead of little endian
 * (modules) [\#5017](https://github.com/cosmos/cosmos-sdk/pull/5017) The `x/genaccounts` module has been
 deprecated and all components removed except the `legacy/` package.
+* (rest) [\#5038](https://github.com/cosmos/cosmos-sdk/pull/5038) RESTful Swagger documentation is
+now mounted under `/swagger/` instead of `/swagger-ui/`.
 * [\#4486](https://github.com/cosmos/cosmos-sdk/issues/4486) Vesting account types decoupled from the `x/auth` module and
 now live under `x/auth/vesting`. Applications wishing to use vesting account types must be sure to register types via
 `RegisterCodec` under the new vesting package.
@@ -130,7 +132,12 @@ that allows for arbitrary vesting periods.
 
 ### Improvements
 
+
+* (rest) [\#5038](https://github.com/cosmos/cosmos-sdk/pull/5038) RESTful Swagger documentation is
+now handled automatically via handler annotations using the [Swag](https://github.com/swaggo/swag) library instead of a static
+configuration.
 * (tendermint) Bump Tendermint version to [v0.32.7](https://github.com/tendermint/tendermint/releases/tag/v0.32.7)
+
 * (server) [\#4215](https://github.com/cosmos/cosmos-sdk/issues/4215) The `--pruning` flag
 has been moved to the configuration file, to allow easier node configuration.
 * (cli) [\#5116](https://github.com/cosmos/cosmos-sdk/issues/5116) The `CLIContext` now supports multiple verifiers
@@ -329,6 +336,7 @@ that error is that the account doesn't exist.
 * [\#4843](https://github.com/cosmos/cosmos-sdk/issues/4843) Add RegisterEvidences function in the codec package to register
   Tendermint evidence types with a given codec.
 * (rest) [\#3867](https://github.com/cosmos/cosmos-sdk/issues/3867) Allow querying for genesis transaction when height query param is set to zero.
+* (rest) [\#5113](https://github.com/cosmos/cosmos-sdk/issues/5113) Implement create and edit validator REST endpoints through POST and PUT `/staking/validators/{validatorAddr}` respectively.
 * [\#2020](https://github.com/cosmos/cosmos-sdk/issues/2020) New keys export/import command line utilities to export/import private keys in ASCII format
   that rely on Keybase's new underlying ExportPrivKey()/ImportPrivKey() API calls.
 * [\#3565](https://github.com/cosmos/cosmos-sdk/issues/3565) Implement parameter change proposal support.

Makefile

@@ -23,16 +23,14 @@ build: go.sum
 	@go build -mod=readonly ./...
 .PHONY: build
 
-update-swagger-docs: statik
-	$(BINDIR)/statik -src=client/lcd/swagger-ui -dest=client/lcd -f -m
-	@if [ -n "$(git status --porcelain)" ]; then \
-        echo "\033[91mSwagger docs are out of sync!!!\033[0m";\
-        exit 1;\
-    else \
-    	echo "\033[92mSwagger docs are in sync\033[0m";\
-    fi
+update-swagger-docs: swag
+	$(BINDIR)/swag init -g client/rest/root.go --output client/rest/docs
 .PHONY: update-swagger-docs
 
+verify-swagger-docs: swag
+	@scripts/swag.sh $(BINDIR)/swag
+.PHONY: verify-swagger-docs
+
 mocks: $(MOCKS_DIR)
 	mockgen -source=x/auth/types/account_retriever.go -package mocks -destination tests/mocks/account_retriever.go
 .PHONY: mocks
@@ -180,9 +178,9 @@ lint: golangci-lint
 .PHONY: lint
 
 format: tools
-	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs gofmt -w -s
-	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs misspell -w
-	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs goimports -w -local github.com/cosmos/cosmos-sdk
+	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/rest/docs/docs.go" | xargs gofmt -w -s
+	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/rest/docs/docs.go" | xargs misspell -w
+	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/rest/docs/docs.go" | xargs goimports -w -local github.com/cosmos/cosmos-sdk
 .PHONY: format
 
 benchmark:

client/alias.go

@@ -4,7 +4,6 @@
 // ALIASGEN: github.com/cosmos/cosmos-sdk/client/context
 // ALIASGEN: github.com/cosmos/cosmos-sdk/client/flags
 // ALIASGEN: github.com/cosmos/cosmos-sdk/client/keys
-// ALIASGEN: github.com/cosmos/cosmos-sdk/client/lcd
 // ALIASGEN: github.com/cosmos/cosmos-sdk/client/rest
 // ALIASGEN: github.com/cosmos/cosmos-sdk/client/rpc
 // ALIASGEN: github.com/cosmos/cosmos-sdk/client/tx
@@ -17,7 +16,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/client/input"
 	"github.com/cosmos/cosmos-sdk/client/keys"
-	"github.com/cosmos/cosmos-sdk/client/lcd"
+	"github.com/cosmos/cosmos-sdk/client/rest"
 	"github.com/cosmos/cosmos-sdk/client/rpc"
 )
 
@@ -87,8 +86,8 @@ var (
 	NewKeyBaseFromHomeFlag             = keys.NewKeyBaseFromHomeFlag
 	NewKeyBaseFromDir                  = keys.NewKeyBaseFromDir
 	NewInMemoryKeyBase                 = keys.NewInMemoryKeyBase
-	NewRestServer                      = lcd.NewRestServer
-	ServeCommand                       = lcd.ServeCommand
+	NewRestServer                      = rest.NewRestServer
+	ServeCommand                       = rest.ServeCommand
 	BlockCommand                       = rpc.BlockCommand
 	GetChainHeight                     = rpc.GetChainHeight
 	BlockRequestHandlerFn              = rpc.BlockRequestHandlerFn
@@ -119,7 +118,7 @@ type (
 	RecoverKey             = keys.RecoverKey
 	UpdateKeyReq           = keys.UpdateKeyReq
 	DeleteKeyReq           = keys.DeleteKeyReq
-	RestServer             = lcd.RestServer
+	RestServer             = rest.RestServer
 	ValidatorOutput        = rpc.ValidatorOutput
 	ResultValidatorsOutput = rpc.ResultValidatorsOutput
 )