plugin-barman-cloud/docs/config.yaml
Niccolò Fei d62ffba8fb feat: generate apidoc using genref
Signed-off-by: Niccolò Fei <niccolo.fei@enterprisedb.com>
2025-03-27 17:17:41 +01:00

47 lines
2.2 KiB
YAML

hiddenMemberFields:
- "TypeMeta"
externalPackages:
- match: ^github\.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1\.RelabelConfig$
target: https://pkg.go.dev/github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1#RelabelConfig
- match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.Duration$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration
- match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.GroupVersionKind$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind
- match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.GroupVersionResource$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource
- match: ^k8s\.io/apimachinery/pkg/types\.UID$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID
- match: ^k8s\.io/apimachinery/pkg/runtime\.RawExtension$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension
- match: ^k8s\.io/apimachinery/pkg/api/resource\.Quantity$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity
- match: ^k8s\.io/apimachinery/pkg/api/resource\.QuantityValue$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue
- match: ^k8s\.io/apimachinery/pkg/runtime\.Unknown$
target: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown
- match: ^time\.Duration$
target: https://pkg.go.dev/time#Duration
- match: ^k8s\.io/(api|apimachinery/pkg/apis)/
target: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#{{- lower .TypeIdentifier -}}-{{- arrIndex .PackageSegments -1 -}}-{{- arrIndex .PackageSegments -2 -}}
- match: ^github\.com/cloudnative-pg/machinery
target: https://pkg.go.dev/github.com/cloudnative-pg/machinery/pkg/api/#{{- .TypeIdentifier }}
- match: ^github\.com/cloudnative-pg/barman-cloud
target: https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api/#{{- .TypeIdentifier }}
hideTypePatterns:
- "ParseError$"
- "\\.ObjectStoreList$"
markdownDisabled: false
stripPrefix:
- k8s.io/api/
- k8s.io/apimachinery/pkg/apis/
apis:
- name: plugin-barman-cloud
title: API Reference
package: github.com/cloudnative-pg/plugin-barman-cloud
path: api/v1