mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-01-08 14:21:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove "0 means latest" from swagger docs (#4236)

Browse Source 
Fixes #4014

The reason being when you call any endpoint supporting optional height
and use `height=0`, it will return an error. For example:

```
$ curl localhost:2667/consensus_params?height=0
{
  "jsonrpc": "2.0",
  "id": -1,
  "error": {
    "code": -32603,
    "message": "Internal error",
    "data": "height must be greater than 0"
  }
}
```
This commit is contained in:
Anton Kaliaev
2019-12-11 14:16:38 +04:00
committed by GitHub
parent 2b30f02879
commit 0f69336148
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
rpc/swagger/swagger.yaml
View File

@@ -94,7 +94,7 @@ paths:
- in: query
name: tx
required: true
schema:
schema:
type: string
example: "123"
description: The transaction
@@ -532,7 +532,7 @@ paths:
type: number
default: 0
example: 1
description: height to return. If no height is provided, it will fetch the latest block. 0 means latest
description: height to return. If no height is provided, it will fetch the latest block.
tags:
- Info
description: |
@@ -557,7 +557,7 @@ paths:
parameters:
- in: query
name: height
description: height to return. If no height is provided, it will fetch informations regarding the latest block. 0 means latest
description: height to return. If no height is provided, it will fetch informations regarding the latest block.
schema:
type: number
default: 0
@@ -586,8 +586,8 @@ paths:
parameters:
- in: query
name: height
description: height to return. If no height is provided, it will fetch commit informations regarding the latest block. 0 means latest
schema:
description: height to return. If no height is provided, it will fetch commit informations regarding the latest block.
schema:
type: number
default: 0
example: 1
@@ -615,7 +615,7 @@ paths:
parameters:
- in: query
name: height
description: height to return. If no height is provided, it will fetch validato set at the latest block. 0 means latest
description: height to return. If no height is provided, it will fetch validator set which corresponds to the latest block.
schema:
type: number
default: 0
@@ -723,7 +723,7 @@ paths:
parameters:
- in: query
name: height
description: height to return. If no height is provided, it will fetch commit informations regarding the latest block. 0 means latest
description: height to return. If no height is provided, it will fetch commit informations regarding the latest block.
schema:
type: number
default: 0