doc: update askrene constraint descriptions - #9395
Open
VirajsNexus wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Askrene RPC JSON schemas to clarify terminology, aiming to distinguish impressions from constraints in descriptions and to clarify what askrene-age reports as removed.
Changes:
- Updated several
timestampfield descriptions to refer to “impressions” instead of “constraints”. - Clarified
askrene-age’snum_removeddescription to include both constraints and impressions.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| doc/schemas/askrene-listlayers.json | Updates timestamp description text in constraints/impressions schema sections. |
| doc/schemas/askrene-inform-channel.json | Updates timestamp description text in constraints/impressions response schema sections. |
| doc/schemas/askrene-create-layer.json | Updates timestamp description for impressions in create-layer response schema. |
| doc/schemas/askrene-age.json | Updates num_removed description to include impressions. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| "type": "u64", | ||
| "description": [ | ||
| "The UNIX timestamp when this constraint was created." | ||
| "The UNIX timestamp when this impression was created." |
| "type": "u64", | ||
| "description": [ | ||
| "The UNIX timestamp when this constraint was created." | ||
| "The UNIX timestamp when this impression was created." |
Comment on lines
44
to
48
| "num_removed": { | ||
| "type": "u64", | ||
| "description": [ | ||
| "The number of constraints removed from *layer*" | ||
| "The number of constraints and impressions removed from *layer*" | ||
| ] |
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.
Update Askrene schema descriptions to refer to impressions instead of constraints where appropriate.
Also clarify that
askrene-agecounts both constraints and impressions removed from a layer.Checklist
The changelog has been updated in the relevant commit(s) according to the guidelines.
Not applicable: this is a documentation-only clarification.
Tests have been added or modified to reflect the changes.
Not applicable: no code behavior is changed.
Documentation has been reviewed and updated as needed.
Related issues have been listed and linked, including any that this PR closes.
Not applicable: no related issue.
Important: All PRs must consider how to reverse any persistent changes for
tools/lightning-downgrade.Not applicable: this PR makes no persistent/runtime changes.