diff mbox series

[v4,7/9] layers.schema.json: Add examples property

Message ID 20260619-b4-schema-v4-7-1e25a4651b80@windriver.com
State New
Headers show
Series bitbake-setup JSON Schema: Fix linting errors | expand

Commit Message

Rob Woolley June 19, 2026, 5:39 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 the bitbake layer
to provide an example of a single layer schema.

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

Comments

Yoann Congal June 19, 2026, 8:14 p.m. UTC | #1
On Fri Jun 19, 2026 at 7:39 PM CEST, Rob Woolley via lists.openembedded.org wrote:
> 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 the bitbake layer
> to provide an example of a single layer schema.
>
> Signed-off-by: Rob Woolley <rob.woolley@windriver.com>

Thanks Rob :)

Reviewed-by: Yoann Congal <yoann.congal@smile.fr>

> ---
>  setup-schema/layers.schema.json | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>
> diff --git a/setup-schema/layers.schema.json b/setup-schema/layers.schema.json
> index afeac1869..26a0f842a 100644
> --- a/setup-schema/layers.schema.json
> +++ b/setup-schema/layers.schema.json
> @@ -2,6 +2,20 @@
>      "$schema": "https://json-schema.org/draft/2020-12/schema",
>      "description": "A schema for a manifest of layers to setup",
>      "title": "OpenEmbedded Layer Setup Schema",
> +    "examples" : [
> +        {
> +            "sources": {
> +                "bitbake": {
> +                    "git-remote": {
> +                        "uri": "https://git.openembedded.org/bitbake",
> +                        "rev": "master"
> +                    },
> +                    "path": "bitbake"
> +                }
> +            },
> +            "version": "1.0"
> +        }
> +    ],
>      "type": "object",
>      "additionalProperties": false,
>      "required": [
diff mbox series

Patch

diff --git a/setup-schema/layers.schema.json b/setup-schema/layers.schema.json
index afeac1869..26a0f842a 100644
--- a/setup-schema/layers.schema.json
+++ b/setup-schema/layers.schema.json
@@ -2,6 +2,20 @@ 
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "description": "A schema for a manifest of layers to setup",
     "title": "OpenEmbedded Layer Setup Schema",
+    "examples" : [
+        {
+            "sources": {
+                "bitbake": {
+                    "git-remote": {
+                        "uri": "https://git.openembedded.org/bitbake",
+                        "rev": "master"
+                    },
+                    "path": "bitbake"
+                }
+            },
+            "version": "1.0"
+        }
+    ],
     "type": "object",
     "additionalProperties": false,
     "required": [