summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2022-11-23 18:01:07 +0000
committerGitHub <noreply@github.com>2022-11-23 18:01:07 +0000
commitdfa53900dcc7e67db70c9ef7bdb14e4a423349f9 (patch)
tree897c8fde0c706e55165c64c6a041a5040d23a021 /lib
parentbebfdad795add9fbc8c6c1393d1b817d542474ed (diff)
Publish constants metadata to API (#19143)
* Publish metadata * Ensure content is sorted
Diffstat (limited to 'lib')
-rwxr-xr-xlib/python/qmk/cli/generate/api.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py
index a98a12b628..8650a36b84 100755
--- a/lib/python/qmk/cli/generate/api.py
+++ b/lib/python/qmk/cli/generate/api.py
@@ -18,6 +18,23 @@ TEMPLATE_PATH = DATA_PATH / 'templates/api/'
BUILD_API_PATH = Path('.build/api_data/')
+def _list_constants(output_folder):
+ """Produce a map of available constants
+ """
+ ret = {}
+ for file in (output_folder / 'constants').glob('**/*_[0-9].[0-9].[0-9].json'):
+ name, version = file.stem.rsplit('_', 1)
+ if name not in ret:
+ ret[name] = []
+ ret[name].append(version)
+
+ # Ensure content is sorted
+ for name in ret:
+ ret[name] = sorted(ret[name])
+
+ return ret
+
+
def _resolve_keycode_specs(output_folder):
"""To make it easier for consumers, publish pre-merged spec files
"""
@@ -69,6 +86,7 @@ def generate_api(cli):
keyboard_list_file = v1_dir / 'keyboard_list.json' # A simple list of keyboard targets
keyboard_aliases_file = v1_dir / 'keyboard_aliases.json' # A list of historical keyboard names and their new name
keyboard_metadata_file = v1_dir / 'keyboard_metadata.json' # All the data configurator/via needs for initialization
+ constants_metadata_file = v1_dir / 'constants_metadata.json' # Metadata for available constants
usb_file = v1_dir / 'usb.json' # A mapping of USB VID/PID -> keyboard target
if BUILD_API_PATH.exists():
@@ -132,6 +150,7 @@ def generate_api(cli):
keyboard_list_json = json.dumps({'last_updated': current_datetime(), 'keyboards': keyboard_list}, cls=InfoJSONEncoder)
keyboard_aliases_json = json.dumps({'last_updated': current_datetime(), 'keyboard_aliases': keyboard_aliases}, cls=InfoJSONEncoder)
keyboard_metadata_json = json.dumps(keyboard_metadata, cls=InfoJSONEncoder)
+ constants_metadata_json = json.dumps({'last_updated': current_datetime(), 'constants': _list_constants(v1_dir)})
if not cli.args.dry_run:
keyboard_all_file.write_text(keyboard_all_json)
@@ -139,3 +158,4 @@ def generate_api(cli):
keyboard_list_file.write_text(keyboard_list_json)
keyboard_aliases_file.write_text(keyboard_aliases_json)
keyboard_metadata_file.write_text(keyboard_metadata_json)
+ constants_metadata_file.write_text(constants_metadata_json)