Document the `page` and `module` partial args

1 month ago · a815c3058d
parent 715e66fa00
commit a815c3058d
2 changed files with 4 additions and 0 deletions
--- a/layouts/_partials/openapi/render-api.html
+++ b/layouts/_partials/openapi/render-api.html
@ -7,6 +7,8 @@
  of each value in `paths` to get a complete URL.
  * `anchor_base`: an optional prefix for the HTML IDs generated by
  this template.
+  * `page`: the (Hugo) Page object to store endpoint metadata in the Scratch of. Used to build the endpoints TOC.
+  * `module`: the current CS API module name, if any. Used to group endpoints in the TOC.

  This template replaces the old {{*_http_api}} template.

--- a/layouts/_partials/openapi/render-operation.html
+++ b/layouts/_partials/openapi/render-operation.html
@ -7,6 +7,8 @@
  * `operation_data`: the OpenAPI data for the operation
  * `anchor_base`: an optional prefix for the HTML IDs generated by
  this template.
+  * `page`: the (Hugo) Page object to store endpoint metadata in the Scratch of. Used to build the endpoints TOC.
+  * `module`: the current CS API module name, if any. Used to group endpoints in the TOC.

  This template renders the operation as a `<section>` containing: