aboutsummaryrefslogtreecommitdiff
path: root/docs/api_docs.md
diff options
context:
space:
mode:
authorQMK Bot <[email protected]>2024-05-30 02:01:09 +0000
committerQMK Bot <[email protected]>2024-05-30 02:01:09 +0000
commit47356b220101b4f5b8ca71b2e1aa4f04256dd60f (patch)
tree7cf20bd01edf0285053cd9548944fd4133a27567 /docs/api_docs.md
parentb36c7b99ae57e8d848373f44755510308c4eefa3 (diff)
parent6ef97172889ccd5db376b2a9f8825489e24fdac4 (diff)
downloadqmk_firmware-47356b220101b4f5b8ca71b2e1aa4f04256dd60f.tar.gz
qmk_firmware-47356b220101b4f5b8ca71b2e1aa4f04256dd60f.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/api_docs.md')
-rw-r--r--docs/api_docs.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/api_docs.md b/docs/api_docs.md
index 3324bc545b..f4ba19c42a 100644
--- a/docs/api_docs.md
+++ b/docs/api_docs.md
@@ -67,7 +67,7 @@ Once your compile job has finished you'll check the `result` key. The value of t
* `firmware_source_url`: A list of URLs for the full firmware source code
* `output`: The stdout and stderr for this compile job. Errors will be found here.
-## Constants :id=qmk-constants
+## Constants {#qmk-constants}
If you're writing a tool that leverages constants used within QMK, the API is used to publish "locked-in" versions of those constants in order to ensure that any third-party tooling has a canonical set of information to work with.
@@ -81,9 +81,13 @@ $ curl https://keyboards.develop.qmk.fm/v1/constants_metadata.json # For `develo
{"last_updated": "2022-11-26 12:00:00 GMT", "constants": {"keycodes": ["0.0.1", "0.0.2"]}}
```
-!> Versions exported by the `master` endpoint are locked-in. Any extra versions that exist on the `develop` endpoint which don't exist in `master` are subject to change.
+::: warning
+Versions exported by the `master` endpoint are locked-in. Any extra versions that exist on the `develop` endpoint which don't exist in `master` are subject to change.
+:::
-?> Only keycodes are currently published, but over time all other "externally visible" IDs are expected to appear on these endpoints.
+::: tip
+Only keycodes are currently published, but over time all other "externally visible" IDs are expected to appear on these endpoints.
+:::
To retrieve the constants associated with a subsystem, the endpoint format is as follows:
```