Docs: Document status schedules and delegate API enhancements#37
Merged
Merged
Conversation
This was referenced Jul 16, 2026
al-onyxprotocol
marked this pull request as ready for review
July 16, 2026 11:54
adamantmm
approved these changes
Jul 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the ADAMANT Node API documentation to cover newly added, additive status-schedule discovery fields and the lifetime delegate forged total, keeping examples and field semantics aligned with current node behavior.
Changes:
- Document
forged(decimal string in base units) forGET /api/delegatesandGET /api/delegates/get, and clarify it is not returned by delegate search. - Document
consensusinGET /api/blocks/getStatus. - Extend
GET /api/node/statusdocs withnetwork.consensus,consensusSchedule, andmilestoneSchedulesemantics and examples, including activation-boundary and compatibility notes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| api-endpoints/delegates.md | Adds forged field documentation and updates delegate list/single-delegate examples; clarifies search response excludes forged. |
| api-endpoints/blockchain.md | Documents consensus in /api/blocks/getStatus and adds schedule/activation semantics plus examples for /api/node/status. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jul 16, 2026
Closed
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Document the additive Node API fields introduced for consensus/reward schedule discovery, lifetime delegate forged totals, and the corrected next-forger schedule semantics.
consensusCodeNameinGET /api/blocks/getStatus;network.consensusCodeName,consensusSchedule, andmilestoneScheduleinGET /api/node/status;forgeddecimal string to delegate list and single-delegate examples;forged;GET /api/delegates/getNextForgersis a next-block snapshot, including round boundaries, refresh behavior, andlimitconstraints.Related issue
Closes #36
How to test
The affected Blockchain and Delegates pages were also inspected in the local VitePress preview.
Review follow-up also improves the node status prose and uses the canonical internal WebSocket documentation link.
Checklist