From 9b4f1a8081ada5a6d3e789ebec48d6a5cf31c6ad Mon Sep 17 00:00:00 2001 From: Marko Date: Fri, 21 Aug 2020 11:40:28 +0200 Subject: [PATCH] docs: rename swagger to openapi (#5263) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- cmd/contract_tests/main.go | 2 +- docs/pre.sh | 4 +- dredd.yml | 2 +- rpc/core/CONTRIBUTING.md | 4 +- rpc/{swagger => openapi}/index.html | 2 +- .../swagger.yaml => openapi/openapi.yaml} | 1067 ++++++----------- 7 files changed, 384 insertions(+), 699 deletions(-) rename rpc/{swagger => openapi}/index.html (95%) rename rpc/{swagger/swagger.yaml => openapi/openapi.yaml} (79%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85eb8688e..809767651 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -309,7 +309,7 @@ includes its continuous integration status using a badge in the `README.md`. ### RPC Testing -If you contribute to the RPC endpoints it's important to document your changes in the [Swagger file](./rpc/swagger/swagger.yaml) +If you contribute to the RPC endpoints it's important to document your changes in the [Openapi file](./rpc/openapi/openapi.yaml) To test your changes you should install `nodejs` and run: ```bash diff --git a/cmd/contract_tests/main.go b/cmd/contract_tests/main.go index 487537824..1d3547629 100644 --- a/cmd/contract_tests/main.go +++ b/cmd/contract_tests/main.go @@ -22,7 +22,7 @@ func main() { // We need a proper example of path and data strings.HasPrefix(t.Name, "ABCI > /abci_query") || // We need to find a way to make a transaction before starting the tests, - // that hash should replace the dummy one in hte swagger file + // that hash should replace the dummy one in the openapi file strings.HasPrefix(t.Name, "Info > /tx") { t.Skip = true fmt.Printf("%s Has been skipped\n", t.Name) diff --git a/docs/pre.sh b/docs/pre.sh index b80346d78..8ce5dac4f 100755 --- a/docs/pre.sh +++ b/docs/pre.sh @@ -1,4 +1,4 @@ #!/bin/bash -cp -a ../rpc/swagger/ .vuepress/public/rpc/ -git clone https://github.com/tendermint/spec.git specRepo && cp -r specRepo/spec . && rm -rf specRepo \ No newline at end of file +cp -a ../rpc/openapi/ .vuepress/public/rpc/ +git clone https://github.com/tendermint/spec.git specRepo && cp -r specRepo/spec . && rm -rf specRepo diff --git a/dredd.yml b/dredd.yml index ba315bb90..66487e670 100644 --- a/dredd.yml +++ b/dredd.yml @@ -29,5 +29,5 @@ hooks-worker-handler-host: 127.0.0.1 hooks-worker-handler-port: 61321 config: ./dredd.yml # This path accepts no variables -blueprint: ./rpc/swagger/swagger.yaml +blueprint: ./rpc/openapi/openapi.yaml endpoint: "http://127.0.0.1:26657/" diff --git a/rpc/core/CONTRIBUTING.md b/rpc/core/CONTRIBUTING.md index 050c70286..3427a8e96 100644 --- a/rpc/core/CONTRIBUTING.md +++ b/rpc/core/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Swagger docs +# Openapi docs -Do not forget to update ../swagger/swagger.yaml if making changes to any +Do not forget to update ../openapi/openapi.yaml if making changes to any endpoint. diff --git a/rpc/swagger/index.html b/rpc/openapi/index.html similarity index 95% rename from rpc/swagger/index.html rename to rpc/openapi/index.html index c14df7629..f4e5d0a12 100644 --- a/rpc/swagger/index.html +++ b/rpc/openapi/index.html @@ -15,7 +15,7 @@