{{/* Render the response part of a single HTTP API operation, given: * `responses`: OpenAPI/Swagger data specifying the responses * `path`: the path where this definition was found, to enable us to resolve "$ref" This template renders: * a summary of all the different responses * details of the body for each response code * body parameters, which may be more complex, containing nested objects * response body examples */}} {{ $responses := .responses }} {{ $path := .path }}

Responses

{{ range $code, $response := $responses }} {{ end }}
Status Description
{{ $code }} {{ $response.description | markdownify }}
{{ range $code, $response := $responses }} {{ if $response.schema }}

{{$code}} response

{{ $schema := partial "json-schema/resolve-refs" (dict "schema" $response.schema "path" $path) }} {{ $schema := partial "json-schema/resolve-allof" $schema }} {{/* All this is to work out how to express the content of the response in the case where it is an array. */}} {{ if eq $schema.type "array" }} {{ $type_of := "" }} {{ if reflect.IsSlice $schema.items }} {{ $types := slice }} {{ range $schema.items }} {{ if .title }} {{ $types = $types | append .title}} {{ else }} {{ $types = $types | append .type }} {{ end }} {{ end }} {{ $type_of = delimit $types ", "}} {{ else }} {{ $type_of = $schema.items.title }} {{ end }}

Array of {{ $type_of }}.

{{ end }} {{/* render object tables for any objects referenced in the response. (This will be a no-op for response types which aren't objects or arrays.) */}} {{ $additional_types := partial "json-schema/resolve-additional-types" $schema }} {{ $additional_types = uniq $additional_types }} {{ range $additional_types }} {{ partial "openapi/render-object-table" (dict "caption" .title "properties" .properties "required" .required) }} {{ end }} {{/* render an example. currently this is only supported for arrays and objects. */}} {{ if or (eq $schema.type "object") (eq $schema.type "array") }} {{ $example := partial "json-schema/resolve-example" $schema }} {{ if $response.examples }} {{ $example = partial "json-schema/resolve-refs" (dict "schema" $response.examples "path" $path) }} {{ $example = index $example "application/json" }} {{ end }} {{ $example_json := jsonify (dict "indent" " ") $example }} {{ $example_json = replace $example_json "\\u003c" "<" }} {{ $example_json = replace $example_json "\\u003e" ">" | safeHTML }} ```json {{ $example_json }} ``` {{ end }} {{ end }} {{ end }}