RPC Documents Consolidation #6995
Merged
Conversation
This file contains 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
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
2 times, most recently
from
f194d79
to
00cc09d
Compare
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
4 times, most recently
from
73f3159
to
f0f853f
Compare
|
@ShahanaFarooqui, this is tagged for version v24.02. I plan to call a feature freeze on the 29th, and given that this PR is still drafted I wanted to ask whether you are planning on finalizing this by then, or if more time is needed. |
|
@cdecker I need some help in fixing the CI and I am hoping to be able to do that around Jan 26th. I will update the milestone if it is not ready by then. |
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
17 times, most recently
from
00ff825
to
b5ee65e
Compare
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
from
2bfa27b
to
786cac5
Compare
In general, results should always be an object, so we can add new fields later (e.g. warnings!). But we violated this for "stop", and when "recover" used the same infrastructure, it started doing the same thing. I'm assuming nobody cares, so we don't need to do a deprecation cycle. Changelog-Changed: JSON-RPC: `stop` and `recover` now return a JSON object (not a raw string!) like every other command does. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
We actually use this in multiple places for requests. The key difference between this and msat is what we do when presented with a raw number! I prefer insisting on explicit suffixes, for this reason, but at least this will document the field correctly! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Some rpc commands did not have their corresponding *.request.json files to generate the consolidated json
Adding missing *.schema.json files for rpc commands to create consolidated json files. Updating and deleting other as per requirement.
Added descriptions for rpc command parameters This also performs the following fixes: 1. delforward parameters are compulsory (required). 2. disableinvoicerequest request added `added` field. 3. invoice request order fixed (label then description, not vice-versa!). 4. listpeers log levels are a proper enum 5. description parameter documented for sendonion requests. 6. deprecatred amount_msat removed from sendpay request. 7. sendpay request partid type fixed to u64 (was u16!) 8. sendpay request localinvreqid type tightened to hash (was hex) 9. sendpay request payment_metadata and description fields documented. 10. sendpsbt request reserve type fixed to u32 (was boolean) 11. utxopsbt request satoshi type fixed to msat_or_all (was msat) 12. withdraw request parameter satoshi is compulsory (required) 13. fundchannel_start request amount is sat, not msat_or_all. 14. openchannel_init request amount is sat, not msat 15. openchannel_init close_to is a string, not hex. 16: invoice labels can be strings OR numbers. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
- Makes emergency schema stricter - Fixes some formatting
This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
Merge information from `*.request.json` & `*.schema.json`. Also consolidate remaining details from `*.md` files and create a single file in schemas folder.
rustyrussell
requested changes
Mar 18, 2024
daywalker90
reviewed
Mar 18, 2024
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
3 times, most recently
from
1b077b9
to
7215463
Compare
This was referenced Mar 19, 2024
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
3 times, most recently
from
458d51b
to
19826f0
Compare
- Update `make doc-all` script
- `fromschema.py` script
- Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file
- Updated to print request params
- Added `oneOfMany` condition for request params
- Added `pairedWith` condition for request params
- Added `dependentUpon` condition for request params
- Updated for pre and post_return_value for response
- Hiding `hidden` fields
- `descriptions` are array now
- Unified gaps between titles
- Added default key-value pair
- script: msggen, sql-schema, listconfig and pyln-testing script updates
This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
- Updated doc/Makefile for generating schemas/lightning-sql.json
- Read the lightning-sql template from schemas/lightning-sql-template.json
- Generate sql tables data and merge it with json object read from above template
- Save final merged object in schemas/lightning-sql.json
- Updated doc/Makefile to auto generate lightning-sql.7.md and lightning-sql.7
- Deleted schemas/lightning-sql.json and adding it into .gitignore
- Added lightning-sql specific titles in the fromschema.py script
- Fixed test_sql by changing the sequence for listpeerchannels `reestablished` field
- Ignoring lightning-sql.json for msggen schema.json because it is auto generated by sql plugin and lightning-sql-template.json.
This PR will generate doc/lightning-*.md file for rpc commands. It will get the information from consolidated doc/schemas/lightning-*.json file and use it to generate markdown file for RPC commands. Changelog-Changed: Documentation: great documentation rewrite, all reference pages now generated from the fully-tested JSON schemas and include examples.
ShahanaFarooqui
force-pushed
the
docs-consolidation
branch
from
19826f0
to
85f7040
Compare
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.
This PR will generate
doc/lightning-*.mdfile contents for rpc commands. It will get the information from consolidateddoc/schemas/lightning-*.jsonand use it to generate markdown for RPC commands.Changelog-Changed: Documentation: great documentation rewrite, all reference pages now generated from the fully-tested JSON schemas and include examples.