mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-11 13:23:09 +01:00
fee70c33e4
The crd-ref-docs tool automatically recognizes the +optional marker
comments in Go code and renders them as validation entries. A recent
upstream change in github.com/elastic/crd-ref-docs master branch
started rendering these as `Optional: {}` text in the validation
column, which looks like an empty JSON object and is redundant since
the Required column already shows this information.
Update the documentation template to filter out these Optional markers
while preserving meaningful validation rules like patterns and enums.
Also remove the now-redundant customMarkers configuration, as the
current version of crd-ref-docs recognizes the optional marker without
explicit configuration.
Closes #722
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
18 lines
598 B
YAML
18 lines
598 B
YAML
processor:
|
|
ignoreGroupVersions:
|
|
- "GVK"
|
|
ignoreFields:
|
|
# - "status$"
|
|
- "TypeMeta$"
|
|
ignoreTypes:
|
|
- "ObjectStoreList$"
|
|
|
|
render:
|
|
# Version of Kubernetes to use when generating links to Kubernetes API documentation.
|
|
# renovate: datasource=git-refs depName=kubernetes/kubernetes lookupName=https://github.com/kubernetes/kubernetes
|
|
kubernetesVersion: 1.32
|
|
knownTypes:
|
|
- name: BarmanObjectStoreConfiguration
|
|
package: github.com/cloudnative-pg/barman-cloud/pkg/api
|
|
link: https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api#BarmanObjectStoreConfiguration
|