Commit Graph

9 Commits

Author SHA1 Message Date
Carl Beekhuizen e0a0f6e156
Makes markdown comply with linter 2019-06-30 21:25:58 +02:00
JSON 20602bc92b phase 0 doc standardization b4 spec freeze (#1212) 2019-06-25 14:32:56 +01:00
Luke Anderson c32328fdf2
Fixed swagger URL so that the version number isn't specified (defaults to latest). 2019-05-28 10:49:40 +10:00
Luke Anderson edf0b9d05f
Addressed some of @djrtwo's suggestions.
- Rewording of specification goal paragraph
 - Clarify get duties description regarding chain reorgs.
 - Add epoch parameter to get duties, and new error 406
 - Block publishing action is clarified around validation, with a new status code 202
 - The validator pubkey and PoC bit are passed to produce attestation
 - Attestation publishing action is clarified around validation, new status code 202
 - Rewording of genesis_time, 'block' -> 'slot'
 - Update Crosslink to latest spec
 - Added missing signature field to IndexedAttestation
2019-05-25 07:59:35 +10:00
Danny Ryan 7b30c55cd4
minor copy edits to vc api 2019-05-23 13:10:34 -04:00
Luke Anderson 73c9d126de
Updated API spec with suggestions by @hwwhww.
- Corrected to use American English instead of Australian
 - Fixed spelling mistake with indices
 - Changed tag to 'MinimalSet' and 'OptionalSet'
 - Added a  response to the list of components
 - Renamed 'block_production' to 'block_proposal'
2019-05-20 13:49:06 +10:00
Luke Anderson 67921ab96f
Fixed up some small wording in the API readme. 2019-05-13 16:30:53 +10:00
Luke Anderson 0b2c7acdb3
Fixed up markdown.
- Removed TOC
 - Removed all the old spec stuff
 - Uploaded spec to SwaggerHub and provided a link to it.
 - Added a 'license' section to the API description.
2019-05-13 16:25:22 +10:00
Luke Anderson 4d2e752bb9
Started updating the markdown description of the BNVC REST API, removing stuff specific to the issue and conforming to standard text layout. 2019-05-08 23:51:53 +10:00