{{/* Render a table listing the properties of an object, given: * `title`: optional caption for the table * `anchor`: optional HTML element id for the table * `properties`: dictionary of the properties to list, each given as: `property_name` : `property_data` * `required`: array containing the names of required properties. In some cases (such as response body specifications) this isn't used, and instead properties have a `required` boolean attribute. We support this too. */}} {{ $title := .title }} {{ $properties := .properties}} {{ $required := .required}} {{ if $properties }}
Name | Type | Description | {{ range $property_name, $property := $properties }} {{ $property := partial "json-schema/resolve-allof" $property }} {{/* If the property has a `title`, use that rather than `type`. This means we can write things like `EventFilter` rather than `object`. */}} {{ $type := $property.type}} {{ if $property.title }} {{ $type = $property.title }} {{ end }} {{/* If the property is an array, indicate this with square brackets, like `[type]`. */}} {{ if eq $type "array"}} {{ $items := $property.items }} {{ if $property.items }} {{ $items = partial "json-schema/resolve-allof" $property.items }} {{ end }} {{ $inner_type := $items.type }} {{ if $items.title }} {{ $inner_type = $items.title }} {{ end }} {{ $type = delimit (slice "[" $inner_type "]") "" }} {{ end }} {{/* If the property is an enum, indicate this. */}} {{ if (and (eq $type "string") ($property.enum)) }} {{ $type = "enum" }} {{ end }} {{/* If the property uses `additionalProperties` to describe its internal structure, handle this. */}} {{ if reflect.IsMap $property.additionalProperties }} {{ if $property.additionalProperties.title }} {{ $type = delimit (slice "{ string: " $property.additionalProperties.title "}" ) "" }} {{ end }} {{ end }} {{/* Handle two ways of indicating "required", one for simple parameters, the other for request and response body objects. */}} {{ $required := cond (or (in $required $property_name) ( eq $property.required true )) true false }}
---|---|---|
{{ $property_name }} |
{{ $type }} |
{{ if $required }}Required: {{end -}}
{{ $property.description | markdownify -}}
{{ if eq $type "enum"}} One of: |