Browse Source

docs: rename swagger to openapi (#5263)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
pull/5275/head
Marko 4 years ago
committed by GitHub
parent
commit
9b4f1a8081
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 384 additions and 699 deletions
  1. +1
    -1
      CONTRIBUTING.md
  2. +1
    -1
      cmd/contract_tests/main.go
  3. +2
    -2
      docs/pre.sh
  4. +1
    -1
      dredd.yml
  5. +2
    -2
      rpc/core/CONTRIBUTING.md
  6. +1
    -1
      rpc/openapi/index.html
  7. +376
    -691
      rpc/openapi/openapi.yaml

+ 1
- 1
CONTRIBUTING.md View File

@ -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


+ 1
- 1
cmd/contract_tests/main.go View File

@ -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)


+ 2
- 2
docs/pre.sh View File

@ -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

+ 1
- 1
dredd.yml View File

@ -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/"

+ 2
- 2
rpc/core/CONTRIBUTING.md View File

@ -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.

rpc/swagger/index.html → rpc/openapi/index.html View File


rpc/openapi/openapi.yaml
File diff suppressed because it is too large
View File


Loading…
Cancel
Save