Skip to content

Commit

Permalink
docs: rename swagger to openapi (#5263)
Browse files Browse the repository at this point in the history
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
tac0turtle and mergify[bot] authored Aug 21, 2020
1 parent b7f6e47 commit 9b4f1a8
Show file tree
Hide file tree
Showing 7 changed files with 384 additions and 699 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/contract_tests/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions docs/pre.sh
Original file line number Diff line number Diff line change
@@ -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
cp -a ../rpc/openapi/ .vuepress/public/rpc/
git clone https://github.com/tendermint/spec.git specRepo && cp -r specRepo/spec . && rm -rf specRepo
2 changes: 1 addition & 1 deletion dredd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
4 changes: 2 additions & 2 deletions rpc/core/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion rpc/swagger/index.html → rpc/openapi/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script>
window.onload = function () {
window.ui = SwaggerUIBundle({
url: "./swagger.yaml",
url: "./openapi.yaml",
dom_id: '#swagger-ui',
deepLinking: true,
layout: "BaseLayout"
Expand Down
Loading

0 comments on commit 9b4f1a8

Please sign in to comment.