Add: option to apply enum on array items

losisin · Jun 12, 2024 · c08b884 · c08b884
1 parent 710fd2f
commit c08b884
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/pkg/schema.go b/pkg/schema.go
@@ -26,6 +26,7 @@ type Schema struct {
 	PatternProperties    interface{}        `json:"patternProperties,omitempty"`
 	Required             []string           `json:"required,omitempty"`
 	Items                *Schema            `json:"items,omitempty"`
+	ItemsEnum            []any              `json:"itemsEnum,omitempty"`
 	Properties           map[string]*Schema `json:"properties,omitempty"`
 	Title                string             `json:"title,omitempty"`
 	Description          string             `json:"description,omitempty"`
@@ -187,6 +188,11 @@ func processComment(schema *Schema, comment string) (isRequired bool) {
 				schema.Items = &Schema{
 					Type: value,
 				}
+			case "itemEnum":
+				if schema.Items == nil {
+					schema.Items = &Schema{}
+				}
+				schema.Items.Enum = processList(value, false)
 			case "additionalProperties":
 				if v, err := strconv.ParseBool(value); err == nil {
 					schema.AdditionalProperties = &v

diff --git a/pkg/schema_test.go b/pkg/schema_test.go
@@ -301,6 +301,13 @@ func TestProcessComment(t *testing.T) {
 			expectedSchema:   &Schema{MinItems: uint64Ptr(1), MaxItems: uint64Ptr(10), UniqueItems: true, Items: &Schema{Type: "boolean"}},
 			expectedRequired: false,
 		},
+		{
+			name:             "Set array item enum",
+			schema:           &Schema{},
+			comment:          "# @schema minItems:1;maxItems:10;uniqueItems:true;item:boolean;itemEnum:[\"one\",\"two\"]",
+			expectedSchema:   &Schema{MinItems: uint64Ptr(1), MaxItems: uint64Ptr(10), UniqueItems: true, Items: &Schema{Type: "boolean", Enum: []any{"one", "two"}}},
+			expectedRequired: false,
+		},
 		{
 			name:             "Set object",
 			schema:           &Schema{},