OpenAPI Specification
swagger: '2.0'
info:
title: HTTP API Console ABCI API
name: ''
description: ABCI APIs
tags:
- name: ABCI
description: ABCI APIs
paths:
/abci_info:
get:
summary: Get some info about the application.
operationId: abci_info
tags:
- ABCI
description: 'Get some info about the application.
'
responses:
'200':
description: Get some info about the application.
content:
application/json:
schema:
$ref: '#/components/schemas/ABCIInfoResponse'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/abci_query:
get:
summary: Query the application for some information.
operationId: abci_query
parameters:
- in: query
name: path
description: Path to the data ("/a/b/c")
required: true
schema:
type: string
example: /a/b/c
- in: query
name: data
description: Data
required: true
schema:
type: string
example: IHAVENOIDEA
- in: query
name: height
description: Height (0 means latest)
required: false
schema:
type: integer
example: 1
default: 0
- in: query
name: prove
description: Include proofs of the transactions inclusion in the block
required: false
schema:
type: boolean
example: true
default: false
tags:
- ABCI
description: 'Query the application for some information.
'
responses:
'200':
description: Response of the submitted query
content:
application/json:
schema:
$ref: '#/components/schemas/ABCIQueryResponse'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
JSONRPC:
type: object
properties:
id:
type: integer
example: 0
jsonrpc:
type: string
example: '2.0'
ABCIInfoResponse:
type: object
required:
- jsonrpc
- id
properties:
jsonrpc:
type: string
example: '2.0'
id:
type: integer
example: 0
result:
required:
- response
properties:
response:
required:
- data
- app_version
- version
properties:
data:
type: string
example: '{"size":0}'
version:
type: string
example: 0.16.1
app_version:
type: string
example: '1314126'
type: object
type: object
ABCIQueryResponse:
type: object
required:
- error
- result
- id
- jsonrpc
properties:
error:
type: string
example: ''
result:
required:
- response
properties:
response:
required:
- log
- height
- proof
- value
- key
- index
- code
properties:
log:
type: string
example: exists
height:
type: string
example: '0'
proof:
type: string
example: 010114FED0DAD959F36091AD761C922ABA3CBF1D8349990101020103011406AA2262E2F448242DF2C2607C3CDC705313EE3B0001149D16177BC71E445476174622EA559715C293740C
value:
type: string
example: '61626364'
key:
type: string
example: '61626364'
index:
type: string
example: '-1'
code:
type: string
example: '0'
type: object
type: object
id:
type: integer
example: 0
jsonrpc:
type: string
example: '2.0'
ErrorResponse:
description: Error Response
allOf:
- $ref: '#/components/schemas/JSONRPC'
- type: object
properties:
error:
type: string
example: Description of failure