feat(crd-from-oas): add support for additionalProperties

Author: pmalek

.mise.toml

@@ -116,7 +116,6 @@ run = "golangci-lint-kube-api-linter run -v --config .golangci-kube-api.yaml ./a
 
 [tasks.test-crdsvalidation]
 description = "Run CRD validation tests"
-dir = "./{{env.DIR}}"
 # Update test paths below if more API groups are added
 run = '''
 export KUBEBUILDER_ASSETS=$(setup-envtest use -p path)

api/x-konnect/v1alpha1/eventgateway_types.go

@@ -6,12 +6,26 @@ type GatewayDescription string
 // GatewayName The name of the Gateway.
 type GatewayName string
 
+// LabelsValue is the value type for Labels.
+//
+// +kubebuilder:validation:MinLength=1
+// +kubebuilder:validation:MaxLength=63
+// +kubebuilder:validation:Pattern=`^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$`
+type LabelsValue string
+
 // Labels store metadata of an entity that can be used for filtering an entity
 // list or for searching across entity types.
 //
 // Keys must be of length 1-63 characters, and cannot start with "kong",
 // "konnect", "mesh", "kic", or "_".
-type Labels map[string]string
+type Labels map[string]LabelsValue
+
+// LabelsUpdateValue is the value type for LabelsUpdate.
+//
+// +kubebuilder:validation:MinLength=1
+// +kubebuilder:validation:MaxLength=63
+// +kubebuilder:validation:Pattern=`^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$`
+type LabelsUpdateValue string
 
 // LabelsUpdate Labels store metadata of an entity that can be used for
 // filtering an entity list or for searching across entity types.
@@ -20,7 +34,7 @@ type Labels map[string]string
 //
 // Keys must be of length 1-63 characters, and cannot start with "kong",
 // "konnect", "mesh", "kic", or "_".
-type LabelsUpdate map[string]string
+type LabelsUpdate map[string]LabelsUpdateValue
 
 // MinRuntimeVersion The minimum runtime version supported by the API.
 // This is the lowest version of the data plane

api/x-konnect/v1alpha1/portal_types.go

@@ -66,6 +66,10 @@ spec:
                     type: string
                   labels:
                     additionalProperties:
+                      description: LabelsValue is the value type for Labels.
+                      maxLength: 63
+                      minLength: 1
+                      pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
                       type: string
                     description: |-
                       Labels store metadata of an entity that can be used for filtering an entity

api/x-konnect/v1alpha1/schema_types.go

@@ -178,6 +178,10 @@ spec:
                     type: string
                   labels:
                     additionalProperties:
+                      description: LabelsUpdateValue is the value type for LabelsUpdate.
+                      maxLength: 63
+                      minLength: 1
+                      pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
                       type: string
                     description: |-
                       Labels store metadata of an entity that can be used for filtering an entity

config/crd/kong-operator/x-konnect.konghq.com_eventgateways.yaml

@@ -187,7 +187,8 @@ func (g *Generator) generateSchemaTypes(refs map[string]bool, parsed *parser.Par
 			comment := formatSchemaComment(refName, schema.Description)
 
 			// Generate based on schema type
-			if len(schema.Properties) > 0 {
+			switch {
+			case len(schema.Properties) > 0:
 				// It's an object type - generate a struct
 				buf.WriteString(comment)
 				fmt.Fprintf(&buf, "type %s struct {\n", refName)
@@ -198,7 +199,26 @@ func (g *Generator) generateSchemaTypes(refs map[string]bool, parsed *parser.Par
 					fmt.Fprintf(&buf, "\t%s %s `json:\"%s\"`\n", goFieldName(prop.Name), g.goType(prop), jsonTag(prop))
 				}
 				buf.WriteString("}\n\n")
-			} else {
+
+			case schema.AdditionalProperties != nil:
+				// Map type with value constraints: generate a dedicated value type
+				// with native kubebuilder markers, then define the map using it.
+				valueTypeName := refName + "Value"
+				valueBaseType := propertyToGoBaseType(schema.AdditionalProperties)
+
+				fmt.Fprintf(&buf, "// %s is the value type for %s.\n", valueTypeName, refName)
+				if markers := valueTypeMarkers(schema.AdditionalProperties); len(markers) > 0 {
+					buf.WriteString("//\n")
+					for _, marker := range markers {
+						fmt.Fprintf(&buf, "// %s\n", marker)
+					}
+				}
+				fmt.Fprintf(&buf, "type %s %s\n\n", valueTypeName, valueBaseType)
+
+				buf.WriteString(comment)
+				fmt.Fprintf(&buf, "type %s map[string]%s\n\n", refName, valueTypeName)
+
+			default:
 				// Generate based on the schema's actual type
 				buf.WriteString(comment)
 				goType := schemaToGoType(schema)

config/crd/kong-operator/x-konnect.konghq.com_portals.yaml

@@ -596,6 +596,89 @@ func TestFormatSchemaComment(t *testing.T) {
 	}
 }
 
+func TestGenerateSchemaTypes_MapWithValueTypes(t *testing.T) {
+	g := NewGenerator(Config{
+		APIVersion: "v1alpha1",
+	})
+
+	parsed := &parser.ParsedSpec{
+		Schemas: map[string]*parser.Schema{
+			"Labels": {
+				Name:          "Labels",
+				Description:   "Labels store metadata.",
+				Type:          "object",
+				MaxProperties: func() *int64 { v := int64(50); return &v }(),
+				AdditionalProperties: &parser.Property{
+					Type:      "string",
+					MinLength: func() *int64 { v := int64(1); return &v }(),
+					MaxLength: func() *int64 { v := int64(63); return &v }(),
+					Pattern:   `^[a-z0-9A-Z]+$`,
+				},
+			},
+			"LabelsUpdate": {
+				Name:        "LabelsUpdate",
+				Description: "LabelsUpdate store metadata.",
+				Type:        "object",
+				AdditionalProperties: &parser.Property{
+					Type:      "string",
+					MinLength: func() *int64 { v := int64(1); return &v }(),
+					MaxLength: func() *int64 { v := int64(63); return &v }(),
+					Pattern:   `^[a-z0-9A-Z]+$`,
+				},
+			},
+		},
+	}
+
+	refs := map[string]bool{
+		"Labels":       true,
+		"LabelsUpdate": true,
+	}
+
+	content := g.generateSchemaTypes(refs, parsed)
+
+	// Labels should generate a value type with native markers, then a map type using it
+	assert.Contains(t, content, "type LabelsValue string")
+	assert.Contains(t, content, "type Labels map[string]LabelsValue")
+	assert.Contains(t, content, "+kubebuilder:validation:MinLength=1")
+	assert.Contains(t, content, "+kubebuilder:validation:MaxLength=63")
+	assert.Contains(t, content, "+kubebuilder:validation:Pattern=`^[a-z0-9A-Z]+$`")
+
+	// LabelsUpdate should also generate a value type
+	assert.Contains(t, content, "type LabelsUpdateValue string")
+	assert.Contains(t, content, "type LabelsUpdate map[string]LabelsUpdateValue")
+
+	// No CEL XValidation rules or MaxProperties on the type (goes on the field)
+	assert.NotContains(t, content, "XValidation")
+	assert.NotContains(t, content, "MaxProperties")
+}
+
+func TestGenerateSchemaTypes_NoValueTypeForNonMapTypes(t *testing.T) {
+	g := NewGenerator(Config{
+		APIVersion: "v1alpha1",
+	})
+
+	parsed := &parser.ParsedSpec{
+		Schemas: map[string]*parser.Schema{
+			"GatewayName": {
+				Name:        "GatewayName",
+				Description: "The name of the Gateway.",
+				Type:        "string",
+			},
+		},
+	}
+
+	refs := map[string]bool{
+		"GatewayName": true,
+	}
+
+	content := g.generateSchemaTypes(refs, parsed)
+
+	assert.Contains(t, content, "type GatewayName string")
+	assert.NotContains(t, content, "Value")
+	assert.NotContains(t, content, "XValidation")
+	assert.NotContains(t, content, "MaxProperties")
+}
+
 func TestParseSDKTypePath(t *testing.T) {
 	tests := []struct {
 		name       string

crd-from-oas/pkg/generator/generator.go

@@ -6,12 +6,13 @@ const (
 	kbOptional = "+optional"
 	kbRequired = "+required"
 
-	kbValidationMaxLengthFmt = "+kubebuilder:validation:MaxLength=%d"
-	kbValidationMinLengthFmt = "+kubebuilder:validation:MinLength=%d"
-	kbValidationPatternFmt   = "+kubebuilder:validation:Pattern=`%s`"
-	kbValidationMinimumFmt   = "+kubebuilder:validation:Minimum=%v"
-	kbValidationMaximumFmt   = "+kubebuilder:validation:Maximum=%v"
-	kbValidationEnumFmt      = "+kubebuilder:validation:Enum=%s"
+	kbValidationMaxLengthFmt     = "+kubebuilder:validation:MaxLength=%d"
+	kbValidationMinLengthFmt     = "+kubebuilder:validation:MinLength=%d"
+	kbValidationPatternFmt       = "+kubebuilder:validation:Pattern=`%s`"
+	kbValidationMinimumFmt       = "+kubebuilder:validation:Minimum=%v"
+	kbValidationMaximumFmt       = "+kubebuilder:validation:Maximum=%v"
+	kbValidationEnumFmt          = "+kubebuilder:validation:Enum=%s"
+	kbValidationMaxPropertiesFmt = "+kubebuilder:validation:MaxProperties=%d"
 
 	kbDefaultBoolFmt   = "+kubebuilder:default=%t"
 	kbDefaultStringFmt = "+kubebuilder:default=%s"
@@ -20,12 +21,13 @@ const (
 func markerOptional() string { return kbOptional }
 func markerRequired() string { return kbRequired }
 
-func markerValidationMaxLength(v int) string  { return fmt.Sprintf(kbValidationMaxLengthFmt, v) }
-func markerValidationMinLength(v int) string  { return fmt.Sprintf(kbValidationMinLengthFmt, v) }
-func markerValidationPattern(v string) string { return fmt.Sprintf(kbValidationPatternFmt, v) }
-func markerValidationMinimum(v any) string    { return fmt.Sprintf(kbValidationMinimumFmt, v) }
-func markerValidationMaximum(v any) string    { return fmt.Sprintf(kbValidationMaximumFmt, v) }
-func markerValidationEnum(v string) string    { return fmt.Sprintf(kbValidationEnumFmt, v) }
+func markerValidationMaxLength(v int) string     { return fmt.Sprintf(kbValidationMaxLengthFmt, v) }
+func markerValidationMinLength(v int) string     { return fmt.Sprintf(kbValidationMinLengthFmt, v) }
+func markerValidationPattern(v string) string    { return fmt.Sprintf(kbValidationPatternFmt, v) }
+func markerValidationMinimum(v any) string       { return fmt.Sprintf(kbValidationMinimumFmt, v) }
+func markerValidationMaximum(v any) string       { return fmt.Sprintf(kbValidationMaximumFmt, v) }
+func markerValidationEnum(v string) string       { return fmt.Sprintf(kbValidationEnumFmt, v) }
+func markerValidationMaxProperties(v int) string { return fmt.Sprintf(kbValidationMaxPropertiesFmt, v) }
 
 func markerDefaultBool(v bool) string     { return fmt.Sprintf(kbDefaultBoolFmt, v) }
 func markerDefaultString(v string) string { return fmt.Sprintf(kbDefaultStringFmt, v) }

crd-from-oas/pkg/generator/generator_test.go

@@ -72,6 +72,11 @@ func KubebuilderTags(prop *parser.Property, entityName string, fieldConfig *conf
 		}
 	}
 
+	// Map MaxProperties constraint (applies to both ref and inline map types)
+	if prop.MaxProperties != nil {
+		tags = append(tags, markerValidationMaxProperties(int(*prop.MaxProperties)))
+	}
+
 	// Add custom validations from config
 	if fieldConfig != nil {
 		customValidations := fieldConfig.GetFieldValidations(entityName, prop.Name)
@@ -80,3 +85,37 @@ func KubebuilderTags(prop *parser.Property, entityName string, fieldConfig *conf
 
 	return tags
 }
+
+// valueTypeMarkers generates kubebuilder validation markers for a map value type
+// based on the additionalProperties constraints from the OpenAPI spec.
+func valueTypeMarkers(ap *parser.Property) []string {
+	var markers []string
+	if ap.Type == "string" {
+		if ap.MinLength != nil {
+			markers = append(markers, markerValidationMinLength(int(*ap.MinLength)))
+		}
+		if ap.MaxLength != nil {
+			markers = append(markers, markerValidationMaxLength(int(*ap.MaxLength)))
+		}
+		if ap.Pattern != "" {
+			markers = append(markers, markerValidationPattern(ap.Pattern))
+		}
+	}
+	return markers
+}
+
+// propertyToGoBaseType returns the Go base type for a simple property.
+func propertyToGoBaseType(prop *parser.Property) string {
+	switch prop.Type {
+	case "string":
+		return "string"
+	case "integer":
+		return "int"
+	case "boolean":
+		return "bool"
+	case "number":
+		return "float64"
+	default:
+		return "string"
+	}
+}