cardano-foundation / cardano-foundation/cardano-rosetta-java

Update docs to document peer support in network status response

Open
#597 1 comment 0 reactions 1 assignee Claimed by @linconvidal View on GitHub
documentation
Dominant language
Java
Stars
26
Forks
15
Avg merge
5d 3h
Merged PRs (30d)
2

Description

# Task context
- Peers list was added to `/network/status` response in v.1.3.2 release. We need to document the behavior, flag usage and API specs.

# Task checklist

- [ ] Document `PEER_DISCOVERY` flag in env vars page, with explanation of behaviors
- [ ] Document api docs for `/network/status` response
- [ ] Replace btc placeholders with Cardano examples (hosts, ports, network identifiers, etc)
- [ ] Add examples for peer list responses and typical values seen in preprod/mainnet
- [ ] Add specification for "minItems: 1" (this will be checked by schema verification)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.