diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-05-30 12:00:41 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 12:00:41 +1000 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/api_docs.md | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/api_docs.md')
| -rw-r--r-- | docs/api_docs.md | 10 |
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 | |||
| 67 | * `firmware_source_url`: A list of URLs for the full firmware source code | 67 | * `firmware_source_url`: A list of URLs for the full firmware source code |
| 68 | * `output`: The stdout and stderr for this compile job. Errors will be found here. | 68 | * `output`: The stdout and stderr for this compile job. Errors will be found here. |
| 69 | 69 | ||
| 70 | ## Constants :id=qmk-constants | 70 | ## Constants {#qmk-constants} |
| 71 | 71 | ||
| 72 | 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. | 72 | 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. |
| 73 | 73 | ||
| @@ -81,9 +81,13 @@ $ curl https://keyboards.develop.qmk.fm/v1/constants_metadata.json # For `develo | |||
| 81 | {"last_updated": "2022-11-26 12:00:00 GMT", "constants": {"keycodes": ["0.0.1", "0.0.2"]}} | 81 | {"last_updated": "2022-11-26 12:00:00 GMT", "constants": {"keycodes": ["0.0.1", "0.0.2"]}} |
| 82 | ``` | 82 | ``` |
| 83 | 83 | ||
| 84 | !> 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. | 84 | ::: warning |
| 85 | 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. | ||
| 86 | ::: | ||
| 85 | 87 | ||
| 86 | ?> Only keycodes are currently published, but over time all other "externally visible" IDs are expected to appear on these endpoints. | 88 | ::: tip |
| 89 | Only keycodes are currently published, but over time all other "externally visible" IDs are expected to appear on these endpoints. | ||
| 90 | ::: | ||
| 87 | 91 | ||
| 88 | To retrieve the constants associated with a subsystem, the endpoint format is as follows: | 92 | To retrieve the constants associated with a subsystem, the endpoint format is as follows: |
| 89 | ``` | 93 | ``` |
