diff --git a/.openapidoc/README.md b/.openapidoc/README.md index 94c89918883..78e34755fcf 100644 --- a/.openapidoc/README.md +++ b/.openapidoc/README.md @@ -4,7 +4,7 @@ This directory contains NodeJS project which publishes Teku OpenAPI specificatio [`gh-pages`](https://github.com/Consensys/teku/tree/gh-pages) branch via CI job after tests are green. See `publishOpenApiSpec` job in `.circleci/config.yml`. -The actual up-to-date generated doc is available at https://consensys.github.io/teku/ +The actual up-to-date generated doc is available at https://docs.teku.consensys.io/reference/rest ## Procedure diff --git a/README.md b/README.md index bd61e6478f8..11f81be58f1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ See the [Changelog](https://github.com/Consensys/teku/releases) for details of t * [Ethereum Beacon Chain specification](https://github.com/ethereum/consensus-specs/blob/master/specs/phase0/beacon-chain.md) * [Teku user documentation](https://docs.teku.consensys.io/) -* [Teku REST API reference documentation](https://consensys.github.io/teku/) +* [Teku REST API reference documentation](https://docs.teku.consensys.io/reference/rest) * [Teku issues](https://github.com/Consensys/teku/issues) * [Contribution guidelines](CONTRIBUTING.md) * [Teku Changelog](https://github.com/Consensys/teku/releases) diff --git a/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/NetworkIdentity.json b/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/NetworkIdentity.json index 5c50ecfbc93..091c9586aef 100644 --- a/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/NetworkIdentity.json +++ b/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/NetworkIdentity.json @@ -17,7 +17,7 @@ "type" : "array", "items" : { "type" : "string", - "description" : "Node's addresses on which eth2 rpc requests are served. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)", + "description" : "Node's addresses on which eth2 rpc requests are served. [Read more](https://libp2p.io/docs/addressing/)", "example" : "/ip4/7.7.7.7/tcp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N" } }, @@ -25,7 +25,7 @@ "type" : "array", "items" : { "type" : "string", - "description" : "Node's addresses on which is listening for discv5 requests. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)", + "description" : "Node's addresses on which is listening for discv5 requests. [Read more](https://libp2p.io/docs/addressing/)", "example" : "/ip4/7.7.7.7/udp/30303/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N" } }, diff --git a/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/Peer.json b/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/Peer.json index 9a4a0cbd7b7..da01e8624b9 100644 --- a/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/Peer.json +++ b/data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/Peer.json @@ -15,7 +15,7 @@ }, "last_seen_p2p_address" : { "type" : "string", - "description" : "Multiaddr used in last peer connection. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)", + "description" : "Multiaddr used in last peer connection. [Read more](https://libp2p.io/docs/addressing/)", "example" : "/ip4/7.7.7.7/tcp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N" }, "state" : { diff --git a/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetIdentity.java b/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetIdentity.java index d49e37f8c0c..c49af2c9010 100644 --- a/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetIdentity.java +++ b/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetIdentity.java @@ -100,7 +100,7 @@ private static SerializableTypeDefinition createIdentityDataType( listOf( string( "Node's addresses on which eth2 rpc requests are served. " - + "[Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)", + + "[Read more](https://libp2p.io/docs/addressing/)", "/ip4/7.7.7.7/tcp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N")), IdentityData::getListeningAddresses) .withField( @@ -108,7 +108,7 @@ private static SerializableTypeDefinition createIdentityDataType( listOf( string( "Node's addresses on which is listening for discv5 requests. " - + "[Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)", + + "[Read more](https://libp2p.io/docs/addressing/)", "/ip4/7.7.7.7/udp/30303/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N")), IdentityData::getDiscoveryAddresses) .withField("metadata", createMetadataType(networkingConfig), IdentityData::getMetadata) diff --git a/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetPeers.java b/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetPeers.java index 0ebd6019939..b3737f34627 100644 --- a/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetPeers.java +++ b/data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetPeers.java @@ -68,7 +68,7 @@ public class GetPeers extends RestApiEndpoint { "last_seen_p2p_address", string( "Multiaddr used in last peer connection. " - + "[Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)", + + "[Read more](https://libp2p.io/docs/addressing/)", "/ip4/7.7.7.7/tcp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N"), eth2Peer -> eth2Peer.peer().getAddress().toExternalForm()) .withField( diff --git a/data/serializer/src/main/java/tech/pegasys/teku/api/provider/Peer.java b/data/serializer/src/main/java/tech/pegasys/teku/api/provider/Peer.java index 94de30f17ae..015c1afd875 100644 --- a/data/serializer/src/main/java/tech/pegasys/teku/api/provider/Peer.java +++ b/data/serializer/src/main/java/tech/pegasys/teku/api/provider/Peer.java @@ -50,7 +50,7 @@ public class Peer { example = "/ip4/7.7.7.7/tcp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N", description = "Multiaddr used in last peer connection. " - + "[Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)") + + "[Read more](https://libp2p.io/docs/addressing/)") public final String address; @JsonProperty("state")