Browse Source

Better request rendering

zvecr 2 years ago
parent
commit
b6eaad3bb0
6 changed files with 9 additions and 7 deletions
  1. 4 2
      data/templates/xap/docs/routes.md.j2
  2. 1 1
      docs/xap_0.0.1.md
  3. 1 1
      docs/xap_0.1.0.md
  4. 1 1
      docs/xap_0.2.0.md
  5. 1 1
      docs/xap_0.3.0.md
  6. 1 1
      docs/xap_protocol.md

+ 4 - 2
data/templates/xap/docs/routes.md.j2

@@ -1,16 +1,18 @@
-{%- macro gen_payload(name, type, members) -%}
+{%- macro gen_payload(name, type, purpose, members) -%}
 {%- if type == 'struct' -%}
 __{{ name }}:__
 {%- for member in members -%}
 <br>{{ "&nbsp;"|safe*4 }}* {{ member.name }}: `{{ member.type }}`
 {%- endfor -%}
+{%- elif purpose -%}
+__{{ name }}:__<br>{{ "&nbsp;"|safe*4 }}* {{ purpose }}: `{{ type }}`
 {%- elif type -%}
 __{{ name }}:__ `{{ type }}`
 {%- endif -%}
 {%- endmacro -%}
 
 {%- macro gen_payloads(route) -%}
-{{ gen_payload('Request', route.request_type, route.request_struct_members) }}{%- if route.return_type and route.request_type -%}<br><br>{% endif %}{{ gen_payload('Response', route.return_type, route.return_struct_members) }}
+{{ gen_payload('Request', route.request_type, route.request_purpose, route.request_struct_members) }}{%- if route.return_type and route.request_type -%}<br><br>{% endif %}{{ gen_payload('Response', route.return_type, null, route.return_struct_members) }}
 {%- endmacro -%}
 
 {%- macro gen_tags(route) -%}

+ 1 - 1
docs/xap_0.0.1.md

@@ -1,4 +1,4 @@
-<!--- Copyright 2023 QMK --->
+<!--- Copyright 2024 QMK --->
 <!--- SPDX-License-Identifier: GPL-2.0-or-later --->
 
 <!---

+ 1 - 1
docs/xap_0.1.0.md

@@ -1,4 +1,4 @@
-<!--- Copyright 2023 QMK --->
+<!--- Copyright 2024 QMK --->
 <!--- SPDX-License-Identifier: GPL-2.0-or-later --->
 
 <!---

+ 1 - 1
docs/xap_0.2.0.md

@@ -1,4 +1,4 @@
-<!--- Copyright 2023 QMK --->
+<!--- Copyright 2024 QMK --->
 <!--- SPDX-License-Identifier: GPL-2.0-or-later --->
 
 <!---

+ 1 - 1
docs/xap_0.3.0.md

@@ -1,4 +1,4 @@
-<!--- Copyright 2023 QMK --->
+<!--- Copyright 2024 QMK --->
 <!--- SPDX-License-Identifier: GPL-2.0-or-later --->
 
 <!---

+ 1 - 1
docs/xap_protocol.md

@@ -1,4 +1,4 @@
-<!--- Copyright 2023 QMK --->
+<!--- Copyright 2024 QMK --->
 <!--- SPDX-License-Identifier: GPL-2.0-or-later --->
 
 <!---