Added optional path, , renamed tags, and fixed up whitespace issues.

This commit is contained in:
Luke Anderson 2019-05-13 15:18:56 +10:00
parent 48ed25b2bd
commit d10baf1dce
No known key found for this signature in database
GPG Key ID: 44408169EC61E228
1 changed files with 31 additions and 20 deletions

View File

@ -7,7 +7,7 @@ paths:
/node/version:
get:
tags:
- Minimum for validator
- Necessary for validator
summary: "Get version string of the running beacon node."
description: "Requests that the beacon node identify information about its implementation in a format similar to a [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3) field."
responses:
@ -23,7 +23,7 @@ paths:
/node/genesis_time:
get:
tags:
- Minimum for validator
- Necessary for validator
summary: "Get the genesis_time parameter from beacon node configuration."
description: "Requests the genesis_time parameter from the beacon node, which should be consistent across all beacon nodes that follow the same beacon chain."
responses:
@ -36,11 +36,10 @@ paths:
500:
$ref: '#/components/responses/InternalError'
/node/syncing:
get:
tags:
- Minimum for validator
- Necessary for validator
summary: "Poll to see if the the beacon node is syncing."
description: "Requests the beacon node to describe if it's currently syncing or not, and if it is, what block it is up to. This is modelled after the Eth1.0 JSON-RPC eth_syncing call.."
responses:
@ -59,11 +58,10 @@ paths:
500:
$ref: '#/components/responses/InternalError'
/validator/duties:
get:
tags:
- Minimum for validator
- Necessary for validator
summary: "Get validator duties for the requested validators."
description: "Requests the beacon node to provide a set of _duties_, which are actions that should be performed by validators. This API call should be polled at every slot, to ensure that any chain reorganisations are catered for, and to ensure that the currently connected beacon node is properly synchronised."
parameters:
@ -92,12 +90,10 @@ paths:
503:
$ref: '#/components/responses/CurrentlySyncing'
/validator/block:
get:
tags:
- Minimum for validator
- Necessary for validator
summary: "Produce a new block, without signature."
description: "Requests a beacon node to produce a valid block, which can then be signed by a validator."
parameters:
@ -130,7 +126,7 @@ paths:
$ref: '#/components/responses/CurrentlySyncing'
post:
tags:
- Minimum for validator
- Necessary for validator
summary: "Publish a signed block"
description: "Instructs the beacon node to publish a newly signed beacon block to the beacon network, to be included in the beacon chain."
parameters:
@ -150,11 +146,10 @@ paths:
503:
$ref: '#/components/responses/CurrentlySyncing'
/validator/attestation:
get:
tags:
- Minimum for validator
- Necessary for validator
summary: "Produce an attestation, without signature."
description: "Requests that the beacon node produce an IndexedAttestation, with a blank signature field, which the validator will then sign."
parameters:
@ -183,10 +178,9 @@ paths:
$ref: '#/components/responses/InternalError'
503:
$ref: '#/components/responses/CurrentlySyncing'
post:
tags:
- Minimum for validator
- Necessary for validator
summary: "Published a signed attestation."
description: "Instructs the beacon node to publish a newly signed IndexedAttestation object, to be incorporated into the beacon chain."
parameters:
@ -206,6 +200,29 @@ paths:
503:
$ref: '#/components/responses/CurrentlySyncing'
/node/fork:
get:
tags:
- Optional
summary: "Get fork information from running beacon node."
description: "Requests the beacon node to provide which fork version it is currently on."
responses:
200:
description: Request successful
content:
application/json:
schema:
type: object
properties:
fork:
$ref: '#/components/schemas/Fork'
chain_id:
type: integer
format: uint64
description: "Sometimes called the network id, this number discerns the active chain for the BeaconNode. Analagous to Eth1.0 JSON-RPC net_version."
500:
$ref: '#/components/responses/InternalError'
components:
schemas:
pubkey:
@ -272,7 +289,6 @@ components:
format: uint64
description: "The estimated highest block, or current target block number."
BeaconBlock:
allOf:
- $ref: '#/components/schemas/BeaconBlockCommon'
@ -282,7 +298,6 @@ components:
body:
$ref: '#/components/schemas/BeaconBlockBody'
BeaconBlockHeader:
allOf:
- $ref: '#/components/schemas/BeaconBlockCommon'
@ -294,9 +309,6 @@ components:
pattern: "^0x[a-fA-F0-9]{64}$"
description: "The tree hash merkle root of the `BeaconBlockBody` for the `BeaconBlock`"
BeaconBlockBody:
type: object
description: "The [`BeaconBlockBody`](https://github.com/ethereum/eth2.0-specs/blob/dev/specs/core/0_beacon-chain.md#beaconblockbody) object from the Eth2.0 spec."
@ -426,7 +438,6 @@ components:
format: byte
pattern: "^0x[a-fA-F0-9]{192}$"
description: "Container self-signature."
voluntary_exits:
type: array
items: