Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .openapidoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
"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"
}
},
"discovery_addresses" : {
"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"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" : {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ private static SerializableTypeDefinition<IdentityData> 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(
"discovery_addresses",
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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
Loading