diff mbox series

[2/8] bitbake-setup.schema.json: Add examples property

Message ID 20260406172110.2050236-3-rob.woolley@windriver.com
State New
Headers show
Series bitbake-setup JSON Schema: Fix linting errors | expand

Commit Message

Woolley, Rob April 6, 2026, 5:21 p.m. UTC 
This resolves the jsonschema linting error:
    Set a non-empty examples array at the top level of the schema
    to illustrate the expected data (top_level_examples)

This example intentionally only references bitbake as a minimal
example that focuses on the tool itself.

Signed-off-by: Rob Woolley <rob.woolley@windriver.com>
---
 setup-schema/bitbake-setup.schema.json | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
diff mbox series

Patch

diff --git a/setup-schema/bitbake-setup.schema.json b/setup-schema/bitbake-setup.schema.json
index d340c9785..976e2cdf7 100644
--- a/setup-schema/bitbake-setup.schema.json
+++ b/setup-schema/bitbake-setup.schema.json
@@ -1,6 +1,27 @@ 
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "description": "Schema for bitbake-setup configuration files",
+    "examples" : {
+        "description": "Example bitbake-setup configuration file",
+        "sources": {
+            "bitbake": {
+                "git-remote": {
+                    "remotes": {
+                        "origin": {
+                            "uri": "https://git.openembedded.org/bitbake"
+                        }
+                    },
+                    "branch": "master",
+                    "rev": "master"
+                },
+                "path": "bitbake"
+            }
+        },
+        "bitbake-setup": {
+            "configurations": []
+        },
+        "version": "1.0"
+    },
     "title": "bitbake-setup configuration file",
     "type": "object",
     "required": [