5fbfdd6821
* Add tr as child of thead in HTML tables It is invalid HTML for th to be the direct children of thead Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Remove unnecessary HTML code end tag Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Avoid nesting p HTML elements A p HTML element cannot contain other block elements, so the "parent" element is closed when the first "child" one is opened. We need to use Page.RenderString with options to force Hugo to keep the wrapping p elements even if the content contains a single paragraph. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add missing HTML details end tags Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Replace HTML a self-closing tag with start and end tags The a element start and end tags are mandatory. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Replace obsolete HTML name attribute with id Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add changelog Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
71 lines
1.7 KiB
HTML
71 lines
1.7 KiB
HTML
{{/*
|
|
|
|
This template is used to render EDUs and PDUs in the server-server and room versions specs.
|
|
|
|
It expects to be passed a `path` parameter, which is a path, relative to /data,
|
|
pointing to a schema file. The file extension is omitted. For example:
|
|
|
|
{{% definition path="api/server-server/definitions/edu" %}}
|
|
|
|
This template replaces the old {{definition_*}} template.
|
|
|
|
*/}}
|
|
|
|
{{ $path := .Params.path }}
|
|
{{ $compact := .Params.compact }}
|
|
{{ $pieces := split $path "/" }}
|
|
|
|
{{/* The definition is referenced by the .path parameter */}}
|
|
{{ $definition := index .Site.Data $pieces }}
|
|
|
|
{{ if not $definition }}
|
|
{{ errorf "site data %s not found" $path }}
|
|
{{ end }}
|
|
|
|
{{/* Resolve $ref and allOf */}}
|
|
{{ $definition = partial "json-schema/resolve-refs" (dict "schema" $definition "path" $path) }}
|
|
{{ $definition = partial "json-schema/resolve-allof" $definition }}
|
|
|
|
{{ $anchor_base := printf "definition-%s" (anchorize $definition.title) }}
|
|
|
|
<section class="rendered-data definition" id="{{ $anchor_base }}">
|
|
|
|
<details {{ if not $compact }}open{{ end }}>
|
|
<summary>
|
|
|
|
<h1>
|
|
<code>{{ $definition.title }}</code>
|
|
</h1>
|
|
|
|
</summary>
|
|
|
|
<hr/>
|
|
|
|
{{ if (index $definition "x-addedInMatrixVersion") }}
|
|
{{ partial "added-in" (dict "v" (index $definition "x-addedInMatrixVersion")) }}
|
|
{{ end }}
|
|
|
|
{{ $definition.description | markdownify }}
|
|
|
|
|
|
{{ $additional_types := partial "json-schema/resolve-additional-types" (dict
|
|
"schema" $definition
|
|
"anchor_base" $anchor_base
|
|
"name" (printf "\"%s\"" $path))
|
|
}}
|
|
|
|
{{ range $additional_types }}
|
|
{{ partial "openapi/render-object-table" . }}
|
|
{{end}}
|
|
|
|
<h2>Examples</h2>
|
|
|
|
{{ $example := partial "json-schema/resolve-example" $definition }}
|
|
|
|
```json
|
|
{{ jsonify (dict "indent" " ") $example }}
|
|
```
|
|
|
|
</details>
|
|
|
|
</section>
|