From 7c7ba770decb3db6b36b4638f545694179b9f05c Mon Sep 17 00:00:00 2001 From: Pawan Dhananjay Date: Wed, 6 Oct 2021 00:46:09 +0000 Subject: [PATCH] Update broken api links (#2665) ## 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 --- beacon_node/http_api/src/lib.rs | 2 +- book/src/api-bn.md | 4 ++-- book/src/api-lighthouse.md | 6 +++--- book/src/http.md | 6 +++--- book/src/redundancy.md | 2 +- book/src/validator-monitoring.md | 2 +- book/src/voluntary-exit.md | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/beacon_node/http_api/src/lib.rs b/beacon_node/http_api/src/lib.rs index 4dd30e7b7..d2e40cde2 100644 --- a/beacon_node/http_api/src/lib.rs +++ b/beacon_node/http_api/src/lib.rs @@ -1,6 +1,6 @@ //! 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 //! used for development. diff --git a/book/src/api-bn.md b/book/src/api-bn.md index 2128d94f2..a376b8ba7 100644 --- a/book/src/api-bn.md +++ b/book/src/api-bn.md @@ -18,7 +18,7 @@ The following CLI flags control the HTTP server: header. The default is to not supply a header. 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]. ## Security @@ -153,5 +153,5 @@ lighthouse bn --http --http-allow-origin "*" > **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. -[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 diff --git a/book/src/api-lighthouse.md b/book/src/api-lighthouse.md index c25d97ac4..8ea35f734 100644 --- a/book/src/api-lighthouse.md +++ b/book/src/api-lighthouse.md @@ -1,7 +1,7 @@ # Lighthouse Non-Standard APIs 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 necessarily be defined as a broad-reaching standard. Such endpoints are placed 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. -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` -routes](https://ethereum.github.io/eth2.0-APIs/#/Beacon/getStateRoot). +routes](https://ethereum.github.io/beacon-APIs/#/Beacon/getStateRoot). ```bash curl -X GET "http://localhost:5052/lighthouse/beacon/states/0/ssz" | jq diff --git a/book/src/http.md b/book/src/http.md index 700535c2a..0f9cd124d 100644 --- a/book/src/http.md +++ b/book/src/http.md @@ -1,6 +1,6 @@ # HTTP API -[OpenAPI Specification](https://ethereum.github.io/eth2.0-APIs/#/) +[OpenAPI Specification](https://ethereum.github.io/beacon-APIs/) ## Beacon Node @@ -14,9 +14,9 @@ The following CLI flags control the HTTP 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 -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 -available [here](https://ethereum.github.io/eth2.0-APIs/#/). +available [here](https://ethereum.github.io/beacon-APIs/). ## Troubleshooting diff --git a/book/src/redundancy.md b/book/src/redundancy.md index 989d3c116..a50e32437 100644 --- a/book/src/redundancy.md +++ b/book/src/redundancy.md @@ -1,6 +1,6 @@ # 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: diff --git a/book/src/validator-monitoring.md b/book/src/validator-monitoring.md index dfe13d754..edf80e730 100644 --- a/book/src/validator-monitoring.md +++ b/book/src/validator-monitoring.md @@ -27,7 +27,7 @@ automatic and manual. ### Automatic 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 endpoint each epoch, so you can expect it to detect all local and active validators within several minutes after start up. diff --git a/book/src/voluntary-exit.md b/book/src/voluntary-exit.md index 511b4a028..63f7258fb 100644 --- a/book/src/voluntary-exit.md +++ b/book/src/voluntary-exit.md @@ -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 `--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`).