Merge pull request #92 from losisin/feature/set-properties-on-object

feature: set properties in object
losisin · Sep 23, 2024 · 2358d58 · 2358d58
2 parents b303504 + e800756
commit 2358d58
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/pkg/schema.go b/pkg/schema.go
@@ -27,6 +27,7 @@ type Schema struct {
 	Required             []string           `json:"required,omitempty"`
 	Items                *Schema            `json:"items,omitempty"`
 	ItemsEnum            []any              `json:"itemsEnum,omitempty"`
+	ItemProperties       map[string]*Schema `json:"itemProperties,omitempty"`
 	Properties           map[string]*Schema `json:"properties,omitempty"`
 	Title                string             `json:"title,omitempty"`
 	Description          string             `json:"description,omitempty"`
@@ -196,6 +197,13 @@ func processComment(schema *Schema, comment string) (isRequired bool, isHidden b
 				schema.Items = &Schema{
 					Type: value,
 				}
+			case "itemProperties":
+				if schema.Items.Type == "object" {
+					var itemProps map[string]*Schema
+					if err := json.Unmarshal([]byte(value), &itemProps); err == nil {
+						schema.Items.Properties = itemProps
+					}
+				}
 			case "itemEnum":
 				if schema.Items == nil {
 					schema.Items = &Schema{}

diff --git a/pkg/schema_test.go b/pkg/schema_test.go
@@ -297,8 +297,8 @@ func TestProcessComment(t *testing.T) {
 		{
 			name:             "Set array",
 			schema:           &Schema{},
-			comment:          "# @schema minItems:1;maxItems:10;uniqueItems:true;item:boolean",
-			expectedSchema:   &Schema{MinItems: uint64Ptr(1), MaxItems: uint64Ptr(10), UniqueItems: true, Items: &Schema{Type: "boolean"}},
+			comment:          "# @schema minItems:1;maxItems:10;uniqueItems:true;item:object;itemProperties:{\"key\": {\"type\": \"string\"}}",
+			expectedSchema:   &Schema{MinItems: uint64Ptr(1), MaxItems: uint64Ptr(10), UniqueItems: true, Items: &Schema{Type: "object", Properties: map[string]*Schema{"key": {Type: "string"}}}},
 			expectedRequired: false,
 		},
 		{

diff --git a/testdata/full.schema.json b/testdata/full.schema.json
@@ -125,9 +125,17 @@
         },
         "imagePullSecrets": {
             "items": {
+                "properties": {
+                    "key": {
+                        "type": "string"
+                    }
+                },
                 "type": "object"
             },
-            "type": "array"
+            "type": [
+                "array",
+                "null"
+            ]
         },
         "labels": {
             "type": "object"

diff --git a/testdata/full.yaml b/testdata/full.yaml
@@ -18,7 +18,7 @@ replicas: 2 # @schema minimum: 1 ; maximum: 10 ; multipleOf: 2
 fullnameOverride: bar # @schema pattern: ^[a-z]$ ; title: My title ; description: My description
 
 # Arrays
-imagePullSecrets: [] # @schema item: object
+imagePullSecrets: [] # @schema type:[array, null]; item: object ; itemProperties: {"key": {"type": "string"}}
 
 tolerations: # @schema minItems: 1 ; maxItems: 10 ; uniqueItems: true
   - key: "bar"