Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Commit

Permalink
add trace_api swagger file
Browse files Browse the repository at this point in the history
  • Loading branch information
Luis Paris committed Mar 12, 2020
1 parent 45ab484 commit 5ff323e
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions plugins/trace_api_plugin/trace_api.swagger.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
openapi: 3.0.0
info:
title: Trace API
version: 1.0.0
license:
name: MIT
url: https://opensource.org/licenses/MIT
contact:
url: https://eos.io
servers:
- url: '{protocol}://{host}:{port}/v1/'
variables:
protocol:
enum:
- http
- https
default: http
host:
default: localhost
port:
default: "8080"
components:
schemas: {}
paths:
/trace_api/get_block:
post:
description: Returns a block object containing retired actions and related metadata.
operationId: get_block
requestBody:
content:
application/json:
schema:
type: object
required:
- block_num
properties:
block_num:
type: string
description: Provide a `block number`
responses:
"200":
description: OK - valid response payload
content:
application/json:
schema:
$ref: "https://eosio.github.io/schemata/v2.0/oas/Block.yaml"
"400":
description: Error - requested block number is invalid (not a number, larger than max int)
"404":
description: Error - requested data not present on node
"500":
description: Error - exceptional condition while processing get_block; e.g. corrupt files

0 comments on commit 5ff323e

Please sign in to comment.