Commit Graph

3 Commits

Author SHA1 Message Date
Luke Anderson
77e2f576af
Further aligning the API & implementation.
- Completed implementation of /beacon/head
 - renamed 'latest_finalized_checkpoint' to 'current_finalized_checkpoint' for consistency
 - Reorganised list of endpoints in both spec & router so that they match
 - Fixed the content-type modifications for /metrics
 - Added a new 'RFC' tag to the spec, to tag things that we have not implemented and aren't sure if it's useful.
 - Moved 'deposit_contract' under /spec
2019-08-28 21:25:38 +10:00
Luke Anderson
16ec330a79
Started aligning API spec with implementation.
- Adding some missing fields to structs
 - Rearranged the endpoints in the rest_api router, and renamed, using an 'implementation_pending' function
 - Added 'content-type' headers, to distinguish difference with /node/metrics
 - Updated OpenAPI spec to v0.2.0
    - Split /node/fork into /node/chain_id and /beacon/fork
    - Moved /metrics to /node/metrics
    - Added example to /node/metrics, since it's text/plain
    - Moved /node/network to just /network
    - Added lots of stubs for endpoints which exist in the router
    - Reordered large parts of the OpenAPI spec
    - Moved /chain/beacon/... to just /beacon/...
2019-08-28 02:05:19 +10:00
Luke Anderson
6de9e5bd6f Spec. for REST API (#455)
* A first run at fleshing full REST API spec.
 - Added a new REST OpenAPI YAML specification to the docs folder, starting from the minimal validator spec.
 - Added a bunch of additional endpoints, including network information and beacon chain information.
 - Current yaml file has not been checked for syntax or any correctness.

* Fixed REST OpenAPI Spec.
 - Updated spelling mistakes, indentation, and incorrect fields.

* Added block_discovery endpoint to REST API spec.

* Added /node/stats endpoint
 - /node/stats endpoint provides information about the running process
 - Added some extra TODOs as reminders.

* Added missing Attestations to REST spec.
 - Added ability to get attestations and pending attestations from chain data.
 - Moved the Attestaion object into its own schema, with reference.
2019-07-29 10:01:56 +10:00