Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9b4f1a8

Browse files
tac0turtlemergify[bot]
andauthoredAug 21, 2020
docs: rename swagger to openapi (#5263)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
1 parent b7f6e47 commit 9b4f1a8

File tree

7 files changed

+384
-699
lines changed

7 files changed

+384
-699
lines changed
 

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ includes its continuous integration status using a badge in the `README.md`.
309309

310310
### RPC Testing
311311

312-
If you contribute to the RPC endpoints it's important to document your changes in the [Swagger file](./rpc/swagger/swagger.yaml)
312+
If you contribute to the RPC endpoints it's important to document your changes in the [Openapi file](./rpc/openapi/openapi.yaml)
313313
To test your changes you should install `nodejs` and run:
314314

315315
```bash

‎cmd/contract_tests/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ func main() {
2222
// We need a proper example of path and data
2323
strings.HasPrefix(t.Name, "ABCI > /abci_query") ||
2424
// We need to find a way to make a transaction before starting the tests,
25-
// that hash should replace the dummy one in hte swagger file
25+
// that hash should replace the dummy one in the openapi file
2626
strings.HasPrefix(t.Name, "Info > /tx") {
2727
t.Skip = true
2828
fmt.Printf("%s Has been skipped\n", t.Name)

‎docs/pre.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/bin/bash
22

3-
cp -a ../rpc/swagger/ .vuepress/public/rpc/
4-
git clone https://github.com/tendermint/spec.git specRepo && cp -r specRepo/spec . && rm -rf specRepo
3+
cp -a ../rpc/openapi/ .vuepress/public/rpc/
4+
git clone https://github.com/tendermint/spec.git specRepo && cp -r specRepo/spec . && rm -rf specRepo

‎dredd.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@ hooks-worker-handler-host: 127.0.0.1
2929
hooks-worker-handler-port: 61321
3030
config: ./dredd.yml
3131
# This path accepts no variables
32-
blueprint: ./rpc/swagger/swagger.yaml
32+
blueprint: ./rpc/openapi/openapi.yaml
3333
endpoint: "http://127.0.0.1:26657/"

‎rpc/core/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Swagger docs
1+
# Openapi docs
22

3-
Do not forget to update ../swagger/swagger.yaml if making changes to any
3+
Do not forget to update ../openapi/openapi.yaml if making changes to any
44
endpoint.

‎rpc/swagger/index.html ‎rpc/openapi/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<script>
1616
window.onload = function () {
1717
window.ui = SwaggerUIBundle({
18-
url: "./swagger.yaml",
18+
url: "./openapi.yaml",
1919
dom_id: '#swagger-ui',
2020
deepLinking: true,
2121
layout: "BaseLayout"

‎rpc/swagger/swagger.yaml ‎rpc/openapi/openapi.yaml

+376-691
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
Please sign in to comment.