Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add categories in RPC documentation #7485

Merged

Conversation

ShahanaFarooqui
Copy link
Collaborator

@ShahanaFarooqui ShahanaFarooqui commented Jul 23, 2024

  • Adding readonly category for get & list commands except listdatastore
  • Removing category and verbose from json_command structure
  • Removing description from json_command structure
  • Removing category, description and long_description from plugin_command struct

Changelog-None.

@ShahanaFarooqui ShahanaFarooqui added this to the v24.08 milestone Jul 23, 2024
@ShahanaFarooqui ShahanaFarooqui requested a review from cdecker as a code owner July 23, 2024 02:58
@ShahanaFarooqui ShahanaFarooqui force-pushed the doc-rpc-categories branch 2 times, most recently from e2aa506 to 24e0707 Compare July 23, 2024 05:43
@ShahanaFarooqui ShahanaFarooqui marked this pull request as draft July 23, 2024 05:44
@ShahanaFarooqui ShahanaFarooqui force-pushed the doc-rpc-categories branch 3 times, most recently from 20c04a6 to 19afa12 Compare July 24, 2024 02:04
@ShahanaFarooqui ShahanaFarooqui marked this pull request as ready for review July 25, 2024 19:37
Copy link
Contributor

@rustyrussell rustyrussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack c8698fe

@rustyrussell rustyrussell merged commit 2ff3e55 into ElementsProject:master Jul 31, 2024
36 checks passed
ShahanaFarooqui added a commit to ShahanaFarooqui/lightning that referenced this pull request Aug 3, 2024
…m method

Category, description and long description from `json_command` and `plugin_command` have been removed in favour of getting them from json schema.  Reference PR: Add categories in RPC documentation ElementsProject#7485

Deprecating them in pyln-client as well. They will remove completely in future releases.

Changelog-None.
ShahanaFarooqui added a commit to ShahanaFarooqui/lightning that referenced this pull request Aug 6, 2024
…m method

Category, description and long description from `json_command` and `plugin_command` have been removed in favour of getting them from json schema.  Reference PR: Add categories in RPC documentation ElementsProject#7485

Deprecating them in pyln-client as well. They will remove completely in future releases.

Changelog-Deprecated: pyln-client: category, description and long descriptions for RPC commands are deprecated now.
rustyrussell pushed a commit that referenced this pull request Aug 7, 2024
…m method

Category, description and long description from `json_command` and `plugin_command` have been removed in favour of getting them from json schema.  Reference PR: Add categories in RPC documentation #7485

Deprecating them in pyln-client as well. They will remove completely in future releases.

Changelog-Deprecated: pyln-client: category, description and long descriptions for RPC commands are deprecated now.
Copy link
Collaborator

@Lagrang3 Lagrang3 Aug 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too bad this breaks new plugins from running on older nodes. For example renepay compiled on the master branch after this PR a82f1fe, will not run on v24.05, because description will be missing from the getmanifest response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants