Skip to content

Generate notification and hook documentation from schemas and synchronize them#9076

Open
daywalker90 wants to merge 6 commits intoElementsProject:masterfrom
daywalker90:notification-markdown-sync
Open

Generate notification and hook documentation from schemas and synchronize them#9076
daywalker90 wants to merge 6 commits intoElementsProject:masterfrom
daywalker90:notification-markdown-sync

Conversation

@daywalker90
Copy link
Copy Markdown
Collaborator

Based on #9058

Fixes: #8369

I've pushed these changes to the v1_notification_schemas readme.com branch and you can start exploring it there, if you have an invite:
https://docs.corelightning.org/v1_notification_schemas/reference/notification-balance_snapshot

Added schemas for: peer_connected, recover, commitment_revocation, db_write,
invoice_payment, openchannel, openchannel2, openchannel2_changed,
openchannel2_sign, rbf_channel, htlc_accepted, rpc_command, custommsg,
onion_message_recv and onion_message_recv_secret

Changelog-None
…arameters

We use it later for the `rpc_command` hook

Changelog-None
hooks are not for grpc, so we create a new object "rpc-only-enum-map" in .msggen.json
and don't generate any grpc related code

Changelog-None
We can now make practical use of the generated code from the hook schemas.
…down generation

also includes formatting fixes for the bkpr-report schema, brackets usually need escaping in mdx

Changelog-None
@daywalker90 daywalker90 added this to the 26.06 milestone Apr 21, 2026
@daywalker90 daywalker90 requested a review from cdecker as a code owner April 21, 2026 13:08
and publish them to the readme.com instance of course!

Changelog-None
@daywalker90 daywalker90 force-pushed the notification-markdown-sync branch from 220c7c0 to 8940d01 Compare April 21, 2026 13:22
@ifyouhavethisemail-afk

This comment was marked as low quality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for notifications and hooks should be based on schemas.

2 participants