qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-09-30 05:50:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Render request/response in XAP docs

Browse Source
This commit is contained in:
zvecr
2022-05-26 18:22:54 +01:00
parent 32404cbb77
commit f727692fd1
9 changed files with 79 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
data/templates/xap/docs/route_request.md.j2
+8
View File
@@ -0,0 +1,8 @@
{%- if subroute.request_type == 'struct' -%}
<br>__Request:__
{%- for member in subroute.request_struct_members -%}
<br>{{ "&nbsp;"|safe*4 }}* {{ member.name }}: `{{ member.type }}`
{%- endfor -%}
{%- elif subroute.request_type -%}
<br>__Request:__ `{{ subroute.request_type }}`
{%- endif -%}
data/templates/xap/docs/route_response.md.j2
+8
View File
@@ -0,0 +1,8 @@
{%- if subroute.return_type == 'struct' -%}
<br>__Response:__
{%- for member in subroute.return_struct_members -%}
<br>{{ "&nbsp;"|safe*4 }}* {{ member.name }}: `{{ member.type }}`
{%- endfor -%}
{%- elif subroute.return_type -%}
<br>__Response:__ `{{ subroute.return_type }}`
{%- endif -%}
data/templates/xap/docs/routes.md.j2
+3 -3
View File
@@ -3,10 +3,10 @@
{{ route.description }}
{% if route.routes %}
| Name | Route | Tags | Definition |
| -- | -- | -- | -- |
| Name | Route | Tags | Payloads | Description |
| -- | -- | -- | -- | -- |
{%- for subid, subroute in route.routes | dictsort %}
| {{ subroute.name }} | `{{ id }} {{ subid }}` | {% if 'secure' == subroute.permissions %}__Secure__{% endif %} | {{ subroute.description.replace('\n', '<br>') }} |
| {{ subroute.name }} | `{{ id }} {{ subid }}` | {% if 'secure' == subroute.permissions %}__Secure__{% endif %} | {%- include 'route_request.md.j2' -%}{%- include 'route_response.md.j2' -%} | {{ subroute.description.replace('\n', '<br>') }}|
{%- endfor %}
{% endif %}
{%- endfor %}
data/xap/xap_0.0.1.hjson
-2
View File
@@ -223,8 +223,6 @@
* Returns the BCD-encoded version in the format of XX.YY.ZZZZ => `0xXXYYZZZZ`
* e.g. 3.2.115 will match `0x03020115`, or bytes {0x15,0x01,0x02,0x03}.
* Response:
* `u32` value.
'''
return_type: u32
return_purpose: bcd-version
data/xap/xap_0.1.0.hjson
-2
View File
@@ -226,8 +226,6 @@
* Returns the BCD-encoded version in the format of XX.YY.ZZZZ => `0xXXYYZZZZ`
* e.g. 3.2.115 will match `0x03020115`, or bytes {0x15,0x01,0x02,0x03}.
* Response:
* `u32` value.
'''
return_type: u32
return_purpose: bcd-version
data/xap/xap_0.2.0.hjson
+5 -5
View File
@@ -28,7 +28,7 @@
type: command
name: Get Layer Count
define: GET_LAYER_COUNT
description: TODO
description: Query maximum number of layers that can be addressed within the keymap.
return_type: u8
return_constant: DYNAMIC_KEYMAP_LAYER_COUNT
}
@@ -36,7 +36,7 @@
type: command
name: Get Keycode
define: GET_KEYMAP_KEYCODE
description: TODO
description: Query the Keycode at the requested location.
request_type: struct
request_struct_length: 3
request_struct_members: [
@@ -60,7 +60,7 @@
type: command
name: Set Keycode
define: SET_KEYMAP_KEYCODE
description: TODO
description: Modify the Keycode at the requested location.
permissions: secure
request_type: struct
request_struct_length: 5
@@ -113,7 +113,7 @@
type: command
name: Get Keycode
define: GET_ENCODER_KEYCODE
description: TODO
description: Query the Keycode at the requested location.
request_type: struct
request_struct_length: 3
request_struct_members: [
@@ -138,7 +138,7 @@
name: Set Keycode
define: SET_ENCODER_KEYCODE
permissions: secure
description: TODO
description: Modify the Keycode at the requested location.
request_type: struct
request_struct_length: 5
request_struct_members: [