Clarify Cycles API documentation and balance calculations#8
Merged
Conversation
- dry-run doc: method does NOT execute when dryRun=true (was incorrectly stated as always running) - API reference: add optional balances field to extend response - architecture overview: add missing - debt to remaining formula https://claude.ai/code/session_01Vj82BkSJtkJPPpbUinb2Wp
5 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
2 participants
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.
Summary
This PR improves the accuracy and clarity of the Cycles protocol documentation by refining API response specifications, correcting dry-run behavior descriptions, and fixing the remaining balance calculation formula.
Key Changes
Extend Reservation API Response: Added formal response schema documentation for the 200 OK response, including field definitions for
status,expires_at_ms, and optionalbalancesarray. Updated the example JSON to include thebalancesfield.Dry-Run Behavior Clarification: Corrected the description of dry-run mode to accurately state that "the method does not execute" rather than "the method always runs." Added context that decisions are logged for monitoring purposes, allowing teams to observe enforcement behavior without affecting runtime.
Balance Calculation Formula: Fixed the
remainingbalance calculation to includedebtin the formula:allocated - spent - reserved - debt(previously omitted the debt component).Implementation Details
These changes ensure that:
https://claude.ai/code/session_01Vj82BkSJtkJPPpbUinb2Wp