WFS and shared types markers added

Author: daronozdemir

api/v3/shared_types.go

@@ -22,6 +22,7 @@ const (
 	ServiceTypeWFS ServiceType = "WFS"
 )
 
+// WMSWFS is the common interface used for both WMS and WFS resources.
 // +kubebuilder:object:generate=false
 type WMSWFS interface {
 	*WFS | *WMS
@@ -35,86 +36,165 @@ type WMSWFS interface {
 	HasPostgisData() bool
 	// Sha1 hash of the objects name
 	ID() string
+	// URLPath returns the configured service URL
 	URLPath() string
 
 	GeoPackages() []*Gpkg
 }
 
+// Mapfile references a ConfigMap key where an external mapfile is stored.
+// +kubebuilder:validation:Type=object
 type Mapfile struct {
 	ConfigMapKeyRef corev1.ConfigMapKeySelector `json:"configMapKeyRef"`
 }
 
+// Options configures optional behaviors of the operator, like ingress, casing, and data prefetching.
+// +kubebuilder:validation:Type=object
 type Options struct {
+	// IncludeIngress dictates whether to deploy an Ingress or ensure none exists.
 	// +kubebuilder:default:=true
 	IncludeIngress bool `json:"includeIngress"`
 
+	// AutomaticCasing enables automatic conversion from snake_case to camelCase.
 	// +kubebuilder:default:=true
 	AutomaticCasing bool `json:"automaticCasing"`
 
+	// ValidateRequests enables request validation against the service schema.
 	// +kubebuilder:default:=true
 	ValidateRequests *bool `json:"validateRequests,omitempty"`
 
+	// RewriteGroupToDataLayers merges group layers into individual data layers.
 	// +kubebuilder:default:=false
 	RewriteGroupToDataLayers *bool `json:"rewriteGroupToDataLayers,omitempty"`
 
+	// DisableWebserviceProxy disables the built-in proxy for external web services.
 	// +kubebuilder:default:=false
 	DisableWebserviceProxy *bool `json:"disableWebserviceProxy,omitempty"`
 
+	// Whether to prefetch data from blob storage, and store it on the local filesystem.
+	// If `false`, the data will be served directly out of blob storage
 	// +kubebuilder:default:=true
 	PrefetchData *bool `json:"prefetchData,omitempty"`
 
+	// ValidateChildStyleNameEqual ensures child style names match the parent style.
+	// +kubebuilder:default=false
 	ValidateChildStyleNameEqual *bool `json:"validateChildStyleNameEqual,omitempty"`
 }
 
+// Inspire holds INSPIRE-specific metadata for the service.
+// +kubebuilder:validation:Type=object
 type Inspire struct {
-	ServiceMetadataURL       MetadataURL `json:"serviceMetadataUrl"`
-	SpatialDatasetIdentifier string      `json:"spatialDatasetIdentifier"`
-	Language                 string      `json:"language"`
+	// ServiceMetadataURL references the CSW or custom metadata record.
+	ServiceMetadataURL MetadataURL `json:"serviceMetadataUrl"`
+
+	// SpatialDatasetIdentifier is the ID uniquely identifying the dataset.
+	SpatialDatasetIdentifier string `json:"spatialDatasetIdentifier"`
+
+	// Language of the INSPIRE metadata record (e.g., "nl" or "en").
+	Language string `json:"language"`
 }
 
 type MetadataURL struct {
-	CSW    *Metadata `json:"csw"`
-	Custom *Custom   `json:"custom,omitempty"`
+	// CSW describes a metadata record via a metadataIdentifier (UUID).
+	CSW *Metadata `json:"csw"`
+
+	// Custom allows arbitrary href
+	Custom *Custom `json:"custom,omitempty"`
 }
 
+// Metadata holds the UUID of a CSW metadata record
 type Metadata struct {
+	// MetadataIdentifier is the record's UUID
+	// +kubebuilder:validation:Format:=uuid
+	// +kubebuilder:validation:MinLength:=1
 	MetadataIdentifier string `json:"metadataIdentifier"`
 }
 
+// Custom represents a non-CSW metadata link with an href and MIME type.
+// +kubebuilder:validation:Schemaless
+// +kubebuilder:pruning:PreserveUnknownFields
+// +kubebuilder:validation:Type=object
 type Custom struct {
+	// +kubebuilder:validation:Pattern=`^https?://.*$`
+	// +kubebuilder:validation:MinLength=1
 	Href string `json:"href"`
 	Type string `json:"type"`
 }
 
+// Data holds the data source configuration
+// +kubebuilder:validation:XValidation:rule="has(self.gpkg) || has(self.tif) || has(self.postgis)", message="Atleast one of the datasource should be provided (postgis, gpkg, tif)"
 type Data struct {
-	Gpkg    *Gpkg    `json:"gpkg,omitempty"`
+	// Gpkg configures a GeoPackage file source
+	Gpkg *Gpkg `json:"gpkg,omitempty"`
+
+	// Postgis configures a Postgis table source
 	Postgis *Postgis `json:"postgis,omitempty"`
-	TIF     *TIF     `json:"tif,omitempty"`
+
+	// TIF configures a GeoTIF raster source
+	TIF *TIF `json:"tif,omitempty"`
 }
 
+// Gpkg configures a Geopackage data source
+// +kubebuilder:validation:Type=object
 type Gpkg struct {
-	BlobKey      string   `json:"blobKey"`
-	TableName    string   `json:"tableName"`
-	GeometryType string   `json:"geometryType"`
-	Columns      []Column `json:"columns"`
+	// Blobkey identifies the location/bucket of the .gpkg file
+	// +kubebuilder:validation:Pattern=`\.gpkg$`
+	BlobKey string `json:"blobKey"`
+
+	// TableName is the table within the geopackage
+	// +kubebuilder:validation:MinLength:=1
+	TableName string `json:"tableName"`
+
+	// GeometryType of the table, must match an OGC type
+	// +kubebuilder:validation:Pattern:=`^(Multi)?(Point|LineString|Polygon)$`
+	GeometryType string `json:"geometryType"`
+
+	// Columns to visualize for this table
+	// +kubebuilder:validation:MinItems:=1
+	Columns []Column `json:"columns"`
 }
 
 // Postgis - reference to table in a Postgres database
+// +kubebuilder:validation:Type=object
 type Postgis struct {
-	TableName    string   `json:"tableName"`
-	GeometryType string   `json:"geometryType"`
-	Columns      []Column `json:"columns"`
+	// TableName in postGIS
+	// +kubebuilder:validation:MinLength=1
+	TableName string `json:"tableName"`
+
+	// GeometryType of the table
+	// +kubebuilder:validation:Pattern=`^(Multi)?(Point|LineString|Polygon)$`
+	GeometryType string `json:"geometryType"`
+
+	// Columns to expose from table
+	// +kubebuilder:validation:MinItems=1
+	Columns []Column `json:"columns"`
 }
 
+// TIF configures a GeoTIFF raster data source
+// +kubebuilder:validation:Type=object
 type TIF struct {
-	BlobKey                     string  `json:"blobKey"`
-	Resample                    *string `json:"resample,omitempty"`
-	Offsite                     *string `json:"offsite,omitempty"`
-	GetFeatureInfoIncludesClass *bool   `json:"getFeatureInfoIncludesClass,omitempty"`
+	// BlobKey to the TIFF file
+	// +kubebuilder:validation:Pattern=`\.(tif|tiff)$`
+	BlobKey string `json:"blobKey"`
+
+	// Resample method
+	Resample *string `json:"resample,omitempty"`
+
+	// Offsite color for nodata removal
+	Offsite *string `json:"offsite,omitempty"`
+
+	// Include class names in GetFeatureInfo responses
+	GetFeatureInfoIncludesClass *bool `json:"getFeatureInfoIncludesClass,omitempty"`
 }
 
+// Column maps a source column name to an optional alias for output.
+// +kubebuilder:validation:Type=object
 type Column struct {
-	Name  string  `json:"name"`
+	// Name of the column in the data source.
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name"`
+
+	// Alias for the column in the service output.
 	Alias *string `json:"alias,omitempty"`
 }
 

api/v3/wfs_types.go

@@ -68,17 +68,16 @@ func init() {
 type WFSSpec struct {
 	// Optional lifecycle settings
 	Lifecycle *shared_model.Lifecycle `json:"lifecycle,omitempty"`
+
 	// +kubebuilder:validation:Type=object
 	// +kubebuilder:validation:Schemaless
 	// +kubebuilder:pruning:PreserveUnknownFields
 	// Optional strategic merge patch for the pod in the deployment. E.g. to patch the resources or add extra env vars.
-
 	PodSpecPatch                 *corev1.PodSpec                            `json:"podSpecPatch,omitempty"`
 	HorizontalPodAutoscalerPatch *autoscalingv2.HorizontalPodAutoscalerSpec `json:"horizontalPodAutoscalerPatch,omitempty"`
 	Options                      Options                                    `json:"options,omitempty"`
 
 	// service configuration
-	// +kubebuilder:validation:Required
 	Service WFSService `json:"service"`
 }
 
@@ -92,14 +91,12 @@ type WFSService struct {
 	URL string `json:"url"`
 
 	// check for Inspire services
-	// +kubebuilder:default="false"
 	Inspire *Inspire `json:"inspire,omitempty"`
 
 	// External Mapfile reference
 	Mapfile *Mapfile `json:"mapfile,omitempty"`
 
 	// Reference to OwnerInfo CR
-	// TODO no webhook yet?
 	// +kubebuilder:validation:MinLength:=1
 	OwnerInfoRef string `json:"ownerInfoRef"`
 
@@ -150,7 +147,6 @@ type Bbox struct {
 }
 
 // FeatureType defines a WFS feature
-// +kubebuilder:validation:Required
 type FeatureType struct {
 	// Name of the feature
 	// +kubebuilder:validation:MinLength:=1
@@ -177,15 +173,18 @@ type FeatureType struct {
 	// +kubebuilder:validation:Type:=object
 	Bbox *FeatureBbox `json:"bbox,omitempty"`
 
-	// Featuretype data connection
-	// +kubebuilder:validation:Required
+	// FeatureType data connection
 	Data Data `json:"data"`
 }
 
+// FeatureType bounding box, if provided it overrides the default extent
 type FeatureBbox struct {
+	// DefaultCRS defines the feature’s bounding box in the service’s own CRS
 	//nolint:tagliatelle
-	DefaultCRS shared_model.BBox  `json:"defaultCRS"`
-	WGS84      *shared_model.BBox `json:"wgs84,omitempty"`
+	DefaultCRS shared_model.BBox `json:"defaultCRS"`
+
+	// WGS84, if provided, gives the same bounding box reprojected into EPSG:4326.
+	WGS84 *shared_model.BBox `json:"wgs84,omitempty"`
 }
 
 func (wfs *WFS) HasPostgisData() bool {