aboutsummaryrefslogtreecommitdiff
path: root/data/schemas
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2025-02-26 22:25:41 +1100
committerGitHub <noreply@github.com>2025-02-26 22:25:41 +1100
commit1efc82403bebe759272d1ba7a79d9dfa0d5df506 (patch)
treec356ae7afeb0849926534beb5dd4515f693abf99 /data/schemas
parent63b095212b157c4522bdeda3de144fb87213085d (diff)
downloadqmk_firmware-1efc82403bebe759272d1ba7a79d9dfa0d5df506.tar.gz
qmk_firmware-1efc82403bebe759272d1ba7a79d9dfa0d5df506.zip
Community modules (#24848)
Diffstat (limited to 'data/schemas')
-rw-r--r--data/schemas/community_module.jsonschema17
-rw-r--r--data/schemas/keyboard.jsonschema17
-rw-r--r--data/schemas/keymap.jsonschema6
3 files changed, 35 insertions, 5 deletions
diff --git a/data/schemas/community_module.jsonschema b/data/schemas/community_module.jsonschema
new file mode 100644
index 0000000000..a3474476df
--- /dev/null
+++ b/data/schemas/community_module.jsonschema
@@ -0,0 +1,17 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema#",
+ "$id": "qmk.community_module.v1",
+ "title": "Community Module Information",
+ "type": "object",
+ "required": ["module_name", "maintainer"]
+ "properties": {
+ "module_name": {"$ref": "qmk.definitions.v1#/text_identifier"},
+ "maintainer": {"$ref": "qmk.definitions.v1#/text_identifier"},
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
+ "features": {"$ref": "qmk.keyboard.v1#/definitions/features_config"},
+ }
+}
diff --git a/data/schemas/keyboard.jsonschema b/data/schemas/keyboard.jsonschema
index 8b6cc7032b..9b63f62d45 100644
--- a/data/schemas/keyboard.jsonschema
+++ b/data/schemas/keyboard.jsonschema
@@ -31,6 +31,11 @@
"pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
}
}
+ "features_config": {
+ "$ref": "qmk.definitions.v1#/boolean_array",
+ "propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
+ "not": {"required": ["lto"]}
+ },
},
"type": "object",
"not": {"required": ["vendorId", "productId"]}, // reject via keys...
@@ -328,11 +333,7 @@
"enabled": {"type": "boolean"}
}
},
- "features": {
- "$ref": "qmk.definitions.v1#/boolean_array",
- "propertyNames": {"$ref": "qmk.definitions.v1#/snake_case"},
- "not": {"required": ["lto"]}
- },
+ "features": { "$ref": "#/definitions/features_config" },
"indicators": {
"type": "object",
"properties": {
@@ -467,6 +468,12 @@
"rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
}
},
+ "modules": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"mouse_key": {
"type": "object",
"properties": {
diff --git a/data/schemas/keymap.jsonschema b/data/schemas/keymap.jsonschema
index e967e45c53..b92a536c2c 100644
--- a/data/schemas/keymap.jsonschema
+++ b/data/schemas/keymap.jsonschema
@@ -71,6 +71,12 @@
"config": {"$ref": "qmk.keyboard.v1"},
"notes": {
"type": "string"
+ },
+ "modules": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
}
}