Merge pull request #988 from cosmos/fabo/update-rest-spec
updated rest spec
This commit is contained in:
commit
5df0b87be5
|
@ -2,8 +2,8 @@ openapi: 3.0.0
|
||||||
servers:
|
servers:
|
||||||
- url: 'http://localhost:8998'
|
- url: 'http://localhost:8998'
|
||||||
info:
|
info:
|
||||||
version: "1.0.0-oas3"
|
version: "1.1.0"
|
||||||
title: Light client daemon to interface with Cosmos baseserver via REST
|
title: Light client daemon to interface with full Gaia node via REST
|
||||||
description: Specification for the LCD provided by `gaia rest-server`
|
description: Specification for the LCD provided by `gaia rest-server`
|
||||||
|
|
||||||
paths:
|
paths:
|
||||||
|
@ -13,7 +13,7 @@ paths:
|
||||||
description: Get the version of the LCD running locally to compare against expected
|
description: Get the version of the LCD running locally to compare against expected
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Plaintext version i.e. "v0.5.0"
|
description: Plaintext version i.e. "0.16.0-dev-26440095"
|
||||||
/node_info:
|
/node_info:
|
||||||
description: Only the node info. Block information can be queried via /block/latest
|
description: Only the node info. Block information can be queried via /block/latest
|
||||||
get:
|
get:
|
||||||
|
@ -26,25 +26,31 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
id:
|
||||||
|
description: ???
|
||||||
|
type: string
|
||||||
|
listen_addr:
|
||||||
|
type: string
|
||||||
|
example: 192.168.56.1:46656
|
||||||
|
network:
|
||||||
|
type: string
|
||||||
|
example: gaia-5000
|
||||||
|
version:
|
||||||
|
description: Tendermint version
|
||||||
|
type: string
|
||||||
|
example: 0.19.1
|
||||||
|
channels:
|
||||||
|
description: ???
|
||||||
|
type: string
|
||||||
pub_key:
|
pub_key:
|
||||||
$ref: '#/components/schemas/PubKey'
|
$ref: '#/components/schemas/PubKey'
|
||||||
moniker:
|
moniker:
|
||||||
type: string
|
type: string
|
||||||
example: 159.89.198.221
|
example: 159.89.198.221
|
||||||
network:
|
|
||||||
type: string
|
|
||||||
example: gaia-2
|
|
||||||
remote_addr:
|
remote_addr:
|
||||||
type: string
|
type: string
|
||||||
listen_addr:
|
|
||||||
type: string
|
|
||||||
example: 192.168.56.1:46656
|
|
||||||
version:
|
|
||||||
description: Tendermint version
|
|
||||||
type: string
|
|
||||||
example: 0.15.0
|
|
||||||
other:
|
other:
|
||||||
description: more information on versions
|
description: more information on versions and options for the node
|
||||||
type: array
|
type: array
|
||||||
/syncing:
|
/syncing:
|
||||||
get:
|
get:
|
||||||
|
@ -204,6 +210,10 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
type:
|
||||||
|
description: "???"
|
||||||
|
type: string
|
||||||
|
value:
|
||||||
$ref: "#/components/schemas/Balance"
|
$ref: "#/components/schemas/Balance"
|
||||||
204:
|
204:
|
||||||
description: There is no data for the requested account. This is not a 404 as the account might exist, just does not hold data.
|
description: There is no data for the requested account. This is not a 404 as the account might exist, just does not hold data.
|
||||||
|
@ -226,6 +236,7 @@ paths:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
name:
|
name:
|
||||||
|
description: Name of locally stored key
|
||||||
type: string
|
type: string
|
||||||
password:
|
password:
|
||||||
type: string
|
type: string
|
||||||
|
@ -234,6 +245,9 @@ paths:
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/Coins"
|
$ref: "#/components/schemas/Coins"
|
||||||
chain_id:
|
chain_id:
|
||||||
|
description: Target chain
|
||||||
|
type: string
|
||||||
|
src_chain_id:
|
||||||
type: string
|
type: string
|
||||||
squence:
|
squence:
|
||||||
type: number
|
type: number
|
||||||
|
@ -242,19 +256,6 @@ paths:
|
||||||
description: Tx was send and will probably be added to the next block
|
description: Tx was send and will probably be added to the next block
|
||||||
400:
|
400:
|
||||||
description: The Tx was malformated
|
description: The Tx was malformated
|
||||||
/accounts/{address}/nonce:
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: address
|
|
||||||
description: Account address
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/Address"
|
|
||||||
get:
|
|
||||||
summary: Get the nonce for a certain account
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Plaintext nonce i.e. "4" defaults to "0"
|
|
||||||
/blocks/latest:
|
/blocks/latest:
|
||||||
get:
|
get:
|
||||||
summary: Get the latest block
|
summary: Get the latest block
|
||||||
|
@ -667,15 +668,16 @@ components:
|
||||||
Balance:
|
Balance:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
height:
|
address:
|
||||||
type: number
|
type: string
|
||||||
example: 123456
|
|
||||||
coins:
|
coins:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/Coins"
|
$ref: "#/components/schemas/Coins"
|
||||||
credit:
|
public_key:
|
||||||
type: array
|
$ref: "#/components/schemas/PubKey"
|
||||||
|
sequence:
|
||||||
|
type: number
|
||||||
BlockID:
|
BlockID:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
Loading…
Reference in New Issue