2678370f2c
* Use the resolve-refs partial as soon as possible Call it right after accessing the site.Data, since it is recursing it will solve all references in the tree. That way we don't need to wonder where to call it, we trust the validators that the refs will be used in the right place. * Enable strict $ref rule in OpenAPI validator * Document use of $ref to compose examples * Fix schema path in event-fields shortcode Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
106 lines
3.6 KiB
HTML
106 lines
3.6 KiB
HTML
{{/*
|
|
|
|
Render the request part of a single HTTP API operation, given:
|
|
|
|
* `parameters`: OpenAPI data specifying the parameters
|
|
* `request_body`: OpenAPI data specifying the request body
|
|
* `anchor_base`: a prefix to add to the HTML anchors generated for each object
|
|
|
|
This template renders:
|
|
* the "simple parameters" (header, path, query parameters)
|
|
* body parameters, which may be more complex, containing nested objects
|
|
* response body examples
|
|
|
|
*/}}
|
|
|
|
{{ $parameters := .parameters }}
|
|
{{ $request_body := .request_body }}
|
|
{{ $anchor_base := .anchor_base }}
|
|
|
|
<h2>Request</h2>
|
|
|
|
{{ if or $parameters $request_body }}
|
|
|
|
{{ if $parameters }}
|
|
<h3>Request parameters</h3>
|
|
|
|
{{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "header" "caption" "header parameters") }}
|
|
{{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "path" "caption" "path parameters") }}
|
|
{{ partial "openapi/render-parameters" (dict "parameters" $parameters "type" "query" "caption" "query parameters") }}
|
|
|
|
{{ end }}
|
|
|
|
{{ if $request_body }}
|
|
<h3>Request body</h3>
|
|
{{/*
|
|
A request can have several content types.
|
|
*/}}
|
|
{{ $json_body := index $request_body.content "application/json" }}
|
|
{{ if $json_body }}
|
|
{{/*
|
|
Display the JSON schemas
|
|
*/}}
|
|
{{ $schema := partial "json-schema/resolve-allof" $json_body.schema }}
|
|
|
|
{{ $additional_types := partial "json-schema/resolve-additional-types" (dict "schema" $schema "anchor_base" $anchor_base) }}
|
|
{{ range $additional_types }}
|
|
{{ partial "openapi/render-object-table" . }}
|
|
{{ end }}
|
|
{{ else }}
|
|
{{/*
|
|
Show the content types and description.
|
|
*/}}
|
|
{{ $mimes := slice }}
|
|
{{ $descriptions := slice }}
|
|
{{ range $mime, $body := $request_body.content }}
|
|
{{ $mimes = $mimes | append $mime }}
|
|
{{ $descriptions = $descriptions | append $request_body.description }}
|
|
{{ end }}
|
|
{{ partial "openapi/render-content-type" (dict "content_types" $mimes "descriptions" $descriptions) }}
|
|
{{ end }}
|
|
|
|
<h3>Request body example</h3>
|
|
{{/*
|
|
Show all the examples.
|
|
*/}}
|
|
{{ range $mime, $body := $request_body.content }}
|
|
{{ $example := dict }}
|
|
|
|
{{ if $body.schema }}
|
|
{{ $schema := partial "json-schema/resolve-allof" $body.schema }}
|
|
|
|
{{ $example = partial "json-schema/resolve-example" $schema }}
|
|
{{ end }}
|
|
|
|
{{ if and (eq ($example | len) 0) $body.example }}
|
|
{{/*
|
|
If no example was generated from the schema, fallback to the
|
|
main example.
|
|
*/}}
|
|
{{ $example = $body.example }}
|
|
{{ end }}
|
|
|
|
{{ if eq $mime "application/json" }}
|
|
{{ $example_json := jsonify (dict "indent" " ") $example }}
|
|
{{ $example_json = replace $example_json "\\u003c" "<" }}
|
|
{{ $example_json = replace $example_json "\\u003e" ">" | safeHTML }}
|
|
```json
|
|
{{ $example_json }}
|
|
```
|
|
{{ else }}
|
|
{{ $example = $example | safeHTML }}
|
|
{{/*
|
|
We need to set a language for the code otherwise the styling
|
|
is different than other examples.
|
|
*/}}
|
|
```json
|
|
{{ $example }}
|
|
```
|
|
{{ end }}
|
|
|
|
{{ end }}
|
|
{{ end }}
|
|
|
|
{{ else }}
|
|
<p>No request parameters or request body.</p>
|
|
{{ end }}
|