plugin-barman-cloud/docs/markdown/members.tpl
Niccolò Fei 74bdb9a590
feat: generate apidoc using genref (#228)
Closes #206

Signed-off-by: Niccolò Fei <niccolo.fei@enterprisedb.com>
Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
Co-authored-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
2025-03-27 22:42:46 +01:00

35 lines
965 B
Smarty

{{ define "members" }}
{{- /* . is a apiType */ -}}
{{- range .GetMembers -}}
{{- /* . is a apiMember */ -}}
{{- if not .Hidden }}
<tr><td><code>{{ .FieldName }}</code>
{{- if and (not .IsOptional) (not .IsInline) }} <B>[Required]</B>{{- end -}}
<br/>
{{/* Link for type reference */}}
{{- with .GetType -}}
{{- if .Link -}}
<a href="{{ .Link }}"><i>{{ .DisplayName }}</i></a>
{{- else -}}
<i>{{ .DisplayName }}</i>
{{- end -}}
{{- end }}
</td>
<td>
{{- if .IsInline -}}
(Members of <code>{{ .FieldName }}</code> are embedded into this type.)
{{- end }}
{{ if .GetComment -}}
{{ .GetComment }}
{{- else -}}
<span class="text-muted">No description provided.</span>
{{- end }}
{{- if and (eq (.GetType.Name.Name) "ObjectMeta") -}}
Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.
{{- end -}}
</td>
</tr>
{{- end }}
{{- end }}
{{ end }}