fix(docs): filter Optional markers from validation column

The crd-ref-docs tool v0.3.0 introduced a change that started
rendering `+optional` Go code markers as `Optional: {}` in the
validation column of API documentation. This appeared as an empty JSON
object and was redundant since the Required column already displayed
this information. This updates the documentation template to filter
out these Optional markers while preserving meaningful validation
rules like patterns and enums. It also removes redundant customMarkers
configuration.

Closes #722

Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
This commit is contained in:
Marco Nenciarini 2026-01-09 17:14:04 +01:00
parent 5001fe7831
commit 3947d43eea
No known key found for this signature in database
GPG Key ID: 589F03F01BA55038
3 changed files with 2 additions and 5 deletions

View File

@ -86,7 +86,7 @@ tasks:
# renovate: datasource=git-refs depName=crd-gen-refs lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_CRDGENREF_SHA: ee59e34a99940e45f87a16177b1d640975b05b74
# renovate: datasource=go depName=github.com/elastic/crd-ref-docs
CRDREFDOCS_VERSION: v0.2.0
CRDREFDOCS_VERSION: v0.3.0
cmds:
- >
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@${DAGGER_CRDGENREF_SHA}

View File

@ -1,9 +1,6 @@
processor:
ignoreGroupVersions:
- "GVK"
customMarkers:
- name: "optional"
target: field
ignoreFields:
# - "status$"
- "TypeMeta$"

View File

@ -31,7 +31,7 @@ _Appears in:_
{{ end -}}
{{ range $type.Members -}}
| `{{ .Name }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} | {{ if not .Markers.optional -}}True{{- end }} | {{ markdownRenderDefault .Default }} | {{ range .Validation -}} {{ markdownRenderFieldDoc . }} <br />{{ end }} |
| `{{ .Name }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} | {{ if not .Markers.optional -}}True{{- end }} | {{ markdownRenderDefault .Default }} | {{ range .Validation -}}{{- $v := markdownRenderFieldDoc . }}{{- if and $v (ne $v "Optional: {}") (ne $v "Optional: \\{\\}") -}} {{ $v }} <br />{{ end }}{{- end }} |
{{ end -}}
{{ end -}}