sdbus++: events: add description for metadata
It is useful to document the purpose of a metadata field. Add it
to the schema and make it required.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I88f994a6004583bef586c86091dfff0c18d2bddf
diff --git a/tools/sdbusplus/schemas/events.schema.yaml b/tools/sdbusplus/schemas/events.schema.yaml
index d0af09b..26e8816 100644
--- a/tools/sdbusplus/schemas/events.schema.yaml
+++ b/tools/sdbusplus/schemas/events.schema.yaml
@@ -29,6 +29,11 @@
type: string
pattern: "^[A-Z_][A-Z0-9_]*$"
description: The name of the metadata field.
+ description:
+ type: string
+ description:
+ A description of the field for use by
+ developers.
type:
type: string
pattern: "(string)|(size)|(u?int64)|(double)|(object_path)|(enum\\[.*\\])"
@@ -41,6 +46,7 @@
only in the extended `DiagnosticData`).
required:
- name
+ - description
- type
minItems: 1
required: