Compare commits

...

5 Commits

Author SHA1 Message Date
WebSpider
965693ac4e
Merge 05f4ab5b08 into 08ab561429 2026-02-09 21:44:00 +01:00
Marco Nenciarini
08ab561429
docs(apidoc): filter Optional markers from validation column (#723)
Some checks failed
release-please / release-please (push) Failing after 4s
The crd-ref-docs tool v0.3.0 started rendering `+optional` Go markers as
`Optional: {}` in API documentation's validation column. This appeared
as redundant empty JSON objects since the Required column already
conveyed this information. The PR updates the documentation template to
filter these markers while keeping meaningful validation rules like
patterns and enums, and removes unnecessary customMarkers configuration.

Closes #722

Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
2026-02-04 13:46:51 +01:00
WebSpider
05f4ab5b08
Merge branch 'main' into docs-https 2025-12-04 14:43:36 +01:00
Nils Vogels
1282d103ca fix: move port to autocert port
Signed-off-by: Nils Vogels <n.vogels@aves-it.nl>
2025-12-04 14:41:18 +01:00
Nils Vogels
5719bee22a chore(docs): change example urls to be secure by default
Signed-off-by: Nils Vogels <n.vogels@aves-it.nl>
2025-11-14 12:41:57 +01:00
6 changed files with 8 additions and 11 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 # renovate: datasource=git-refs depName=crd-gen-refs lookupName=https://github.com/cloudnative-pg/daggerverse currentValue=main
DAGGER_CRDGENREF_SHA: ee59e34a99940e45f87a16177b1d640975b05b74 DAGGER_CRDGENREF_SHA: ee59e34a99940e45f87a16177b1d640975b05b74
# renovate: datasource=go depName=github.com/elastic/crd-ref-docs # renovate: datasource=go depName=github.com/elastic/crd-ref-docs
CRDREFDOCS_VERSION: v0.2.0 CRDREFDOCS_VERSION: v0.3.0
cmds: cmds:
- > - >
GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@${DAGGER_CRDGENREF_SHA} GITHUB_REF= dagger -s call -m github.com/cloudnative-pg/daggerverse/crd-ref-docs@${DAGGER_CRDGENREF_SHA}

View File

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

View File

@ -31,7 +31,7 @@ _Appears in:_
{{ end -}} {{ end -}}
{{ range $type.Members -}} {{ 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: \\{\\}") -}} {{ $v }} <br />{{ end }}{{- end }} |
{{ end -}} {{ end -}}
{{ end -}} {{ end -}}

View File

@ -64,7 +64,7 @@ spec:
backup: backup:
barmanObjectStore: barmanObjectStore:
destinationPath: s3://backups/ destinationPath: s3://backups/
endpointURL: http://minio-eu:9000 endpointURL: https://minio-eu:9443
s3Credentials: s3Credentials:
accessKeyId: accessKeyId:
name: minio-eu name: minio-eu
@ -87,7 +87,7 @@ metadata:
spec: spec:
configuration: configuration:
destinationPath: s3://backups/ destinationPath: s3://backups/
endpointURL: http://minio-eu:9000 endpointURL: https://minio-eu:9443
s3Credentials: s3Credentials:
accessKeyId: accessKeyId:
name: minio-eu name: minio-eu
@ -205,7 +205,7 @@ spec:
- name: pg-eu - name: pg-eu
barmanObjectStore: barmanObjectStore:
destinationPath: s3://backups/ destinationPath: s3://backups/
endpointURL: http://minio-eu:9000 endpointURL: https://minio-eu:9443
serverName: pg-eu serverName: pg-eu
s3Credentials: s3Credentials:
accessKeyId: accessKeyId:
@ -228,7 +228,7 @@ metadata:
spec: spec:
configuration: configuration:
destinationPath: s3://backups/ destinationPath: s3://backups/
endpointURL: http://minio-eu:9000 endpointURL: https://minio-eu:9443
s3Credentials: s3Credentials:
accessKeyId: accessKeyId:
name: minio-eu name: minio-eu

View File

@ -478,7 +478,7 @@ metadata:
spec: spec:
configuration: configuration:
destinationPath: s3://BUCKET_NAME/ destinationPath: s3://BUCKET_NAME/
endpointURL: http://<tenant>-hl:9000 endpointURL: https://<tenant>-hl:9000
s3Credentials: s3Credentials:
accessKeyId: accessKeyId:
name: minio-creds name: minio-creds

View File

@ -32,7 +32,7 @@ metadata:
spec: spec:
configuration: configuration:
destinationPath: s3://backups/ destinationPath: s3://backups/
endpointURL: http://minio:9000 endpointURL: https://minio:9000
s3Credentials: s3Credentials:
accessKeyId: accessKeyId:
name: minio name: minio