cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update broken api links (#2665)

Browse Source 
## Issue Addressed

Resolves #2563 
Replacement for #2653 as I'm not able to reopen that PR after force pushing.

## Proposed Changes

Fixes all broken api links. Cherry picked changes in #2590 and updated a few more links.

Co-authored-by: Mason Stallmo <masonstallmo@gmail.com>
This commit is contained in:
Pawan Dhananjay 2021-10-06 00:46:09 +00:00
parent 73ec29c267
commit 7c7ba770de
7 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
beacon_node/http_api/src/lib.rs
View File

@ -1,6 +1,6 @@
//! This crate contains a HTTP server which serves the endpoints listed here: //! This crate contains a HTTP server which serves the endpoints listed here:
//! //!
//! https://github.com/ethereum/eth2.0-APIs //! https://github.com/ethereum/beacon-APIs
//! //!
//! There are also some additional, non-standard endpoints behind the `/lighthouse/` path which are //! There are also some additional, non-standard endpoints behind the `/lighthouse/` path which are
//! used for development. //! used for development.

4
book/src/api-bn.md
View File

@ -18,7 +18,7 @@ The following CLI flags control the HTTP server:
header. The default is to not supply a header. header. The default is to not supply a header.
The schema of the API aligns with the standard Eth2 Beacon Node API as defined The schema of the API aligns with the standard Eth2 Beacon Node API as defined
at [github.com/ethereum/eth2.0-APIs](https://github.com/ethereum/eth2.0-APIs). at [github.com/ethereum/beacon-APIs](https://github.com/ethereum/beacon-APIs).
An interactive specification is available [here][OpenAPI]. An interactive specification is available [here][OpenAPI].
## Security ## Security
@ -153,5 +153,5 @@ lighthouse bn --http --http-allow-origin "*"
> **Warning:** Adding the wild-card allow-origin flag can pose a security risk. > **Warning:** Adding the wild-card allow-origin flag can pose a security risk.
> Only use it in production if you understand the risks of a loose CORS policy. > Only use it in production if you understand the risks of a loose CORS policy.
[OpenAPI]: https://ethereum.github.io/eth2.0-APIs/#/ [OpenAPI]: https://ethereum.github.io/beacon-APIs/
[ssh_tunnel]: https://www.ssh.com/academy/ssh/tunneling/example [ssh_tunnel]: https://www.ssh.com/academy/ssh/tunneling/example

6
book/src/api-lighthouse.md
View File

@ -1,7 +1,7 @@
# Lighthouse Non-Standard APIs # Lighthouse Non-Standard APIs
Lighthouse fully supports the standardization efforts at Lighthouse fully supports the standardization efforts at
[github.com/ethereum/eth2.0-APIs](https://github.com/ethereum/eth2.0-APIs), [github.com/ethereum/beacon-APIs](https://github.com/ethereum/beacon-APIs),
however sometimes development requires additional endpoints that shouldn't however sometimes development requires additional endpoints that shouldn't
necessarily be defined as a broad-reaching standard. Such endpoints are placed necessarily be defined as a broad-reaching standard. Such endpoints are placed
behind the `/lighthouse` path. behind the `/lighthouse` path.
@ -320,9 +320,9 @@ curl -X GET "http://localhost:5052/lighthouse/eth1/deposit_cache" -H "accept: a
Obtains a `BeaconState` in SSZ bytes. Useful for obtaining a genesis state. Obtains a `BeaconState` in SSZ bytes. Useful for obtaining a genesis state.
The `state_id` parameter is identical to that used in the [Standard Eth2.0 API The `state_id` parameter is identical to that used in the [Standard Eth2.0 Beacon Node API
`beacon/state` `beacon/state`
routes](https://ethereum.github.io/eth2.0-APIs/#/Beacon/getStateRoot). routes](https://ethereum.github.io/beacon-APIs/#/Beacon/getStateRoot).
```bash ```bash
curl -X GET "http://localhost:5052/lighthouse/beacon/states/0/ssz" | jq curl -X GET "http://localhost:5052/lighthouse/beacon/states/0/ssz" | jq

6
book/src/http.md
View File

@ -1,6 +1,6 @@
# HTTP API # HTTP API
[OpenAPI Specification](https://ethereum.github.io/eth2.0-APIs/#/) [OpenAPI Specification](https://ethereum.github.io/beacon-APIs/)
## Beacon Node ## Beacon Node
@ -14,9 +14,9 @@ The following CLI flags control the HTTP server:
- `--http-address`: specify the listen address of the server. - `--http-address`: specify the listen address of the server.
The schema of the API aligns with the standard Eth2 Beacon Node API as defined The schema of the API aligns with the standard Eth2 Beacon Node API as defined
at [github.com/ethereum/eth2.0-APIs](https://github.com/ethereum/eth2.0-APIs). at [github.com/ethereum/beacon-APIs](https://github.com/ethereum/beacon-APIs).
It is an easy-to-use RESTful HTTP/JSON API. An interactive specification is It is an easy-to-use RESTful HTTP/JSON API. An interactive specification is
available [here](https://ethereum.github.io/eth2.0-APIs/#/). available [here](https://ethereum.github.io/beacon-APIs/).
## Troubleshooting ## Troubleshooting

2
book/src/redundancy.md
View File

@ -1,6 +1,6 @@
# Redundancy # Redundancy
[subscribe-api]: https://ethereum.github.io/eth2.0-APIs/#/Validator/prepareBeaconCommitteeSubnet [subscribe-api]: https://ethereum.github.io/beacon-APIs/#/Validator/prepareBeaconCommitteeSubnet
There are three places in Lighthouse where redundancy is notable: There are three places in Lighthouse where redundancy is notable:

2
book/src/validator-monitoring.md
View File

@ -27,7 +27,7 @@ automatic and manual.
### Automatic ### Automatic
When the `--validator-monitor-auto` flag is supplied, any validator which uses the When the `--validator-monitor-auto` flag is supplied, any validator which uses the
[`beacon_committee_subscriptions`](https://ethereum.github.io/eth2.0-APIs/#/Validator/prepareBeaconCommitteeSubnet) [`beacon_committee_subscriptions`](https://ethereum.github.io/beacon-APIs/#/Validator/prepareBeaconCommitteeSubnet)
API endpoint will be enrolled for additional monitoring. All active validators will use this API endpoint will be enrolled for additional monitoring. All active validators will use this
endpoint each epoch, so you can expect it to detect all local and active validators within several endpoint each epoch, so you can expect it to detect all local and active validators within several
minutes after start up. minutes after start up.

2
book/src/voluntary-exit.md
View File

@ -25,7 +25,7 @@ In order to initiate an exit, users can use the `lighthouse account validator ex
- The `--keystore` flag is used to specify the path to the EIP-2335 voting keystore for the validator. - The `--keystore` flag is used to specify the path to the EIP-2335 voting keystore for the validator.
- The `--beacon-node` flag is used to specify a beacon chain HTTP endpoint that confirms to the [Eth2.0 Standard API](https://ethereum.github.io/eth2.0-APIs/) specifications. That beacon node will be used to validate and propagate the voluntary exit. The default value for this flag is `http://localhost:5052`. - The `--beacon-node` flag is used to specify a beacon chain HTTP endpoint that confirms to the [Eth2.0 Standard Beacon Node API](https://ethereum.github.io/beacon-APIs/) specifications. That beacon node will be used to validate and propagate the voluntary exit. The default value for this flag is `http://localhost:5052`.
- The `--network` flag is used to specify a particular Eth2 network (default is `mainnet`). - The `--network` flag is used to specify a particular Eth2 network (default is `mainnet`).