aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 23:24:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: document that we should annotate added and deprecated schemas.

Browse Source 
No longer just delete them!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2023-01-10 07:21:30 +10:30
parent 404e961bad
commit 3f8199bbfd
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/schemas/WRITING_SCHEMAS.md
View File

@@ -10,6 +10,15 @@ use a subset of the full [JSON Schema Specification](https://json-schema.org/),
but if you find that limiting it's probably a sign that you should simplify but if you find that limiting it's probably a sign that you should simplify
your JSON output. your JSON output.
## Updating a Schema
If you add a field, you should add it to the schema, and you must add
"added": "VERSION" (where VERSION is the next release version!).
Similarly, if you deprecate a field, add "deprecated": "VERSION" (where
VERSION is the next release version). They will be removed two versions
later.
## How to Write a Schema ## How to Write a Schema
Name the schema doc/schemas/`command`.schema.json: the testsuite should Name the schema doc/schemas/`command`.schema.json: the testsuite should