Add Json Schema for Published packages

Signed-off-by: Jos Verlinde <[email protected]>
Josverl · Dec 7, 2024 · def071d · def071d
1 parent 8aaed63
commit def071d
Showing 1 changed file with 55 additions and 0 deletions.
diff --git a/data/schema/packages-v1.0.0.json b/data/schema/packages-v1.0.0.json
@@ -0,0 +1,55 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Root",
+    "type": "object",
+    "required": [
+        "$schema",
+        "packages"
+    ],
+    "description": "A list of  MicroPython stub/version combinations that have been published to PyPI.",
+    "additionalProperties": false,
+    "properties": {
+        "$schema": {
+            "$id": "#root/$schema",
+            "title": "$schema",
+            "type": "string"
+        },
+        "packages": {
+            "$id": "#root/packages",
+            "title": "Stub Packages",
+            "type": "array",
+            "default": [],
+            "items": {
+                "type": "array",
+                "description": "An object representing a stub/version combination.",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "description": "The name of the package as published on PyPI."
+                    },
+                    "mpy_version": {
+                        "type": "string",
+                        "description": "The MicroPython version for which the stubs are valid. Must be a valid SemVer string."
+                    },
+                    "port": {
+                        "type": "string",
+                        "description": "The port for the package."
+                    },
+                    "board": {
+                        "type": "string",
+                        "description": "The board for the package. [Optional]"
+                    },
+                    "variant": {
+                        "type": "string",
+                        "description": "The variant of the package. [Optional]"
+                    }
+                },
+                "required": [
+                    "name",
+                    "mpy_version",
+                    "port"
+                ]
+            }
+        }
+    }
+}