Merge pull request #85 from Teamwork/fix/array-of-enums-not-showing

Fix: Array of enums wasn't being documented

docparse/jsonschema.go

@@ -507,6 +507,12 @@ arrayStart:
 
 		p.Items = &Schema{Type: JSONSchemaType(typ.Name)}
 
+		// Generally an item is an enum rather than the array itself
+		if p.Enum != nil {
+			p.Items.Enum = p.Enum
+			p.Enum = nil
+		}
+
 		// Map []byte to []string.
 		if typ.Name == "byte" {
 			p.Items = nil
@@ -556,8 +562,11 @@ arrayStart:
 		return err
 	}
 	if t != "" {
-		p.Type = t
-		if isPrimitive(p.Type) {
+		if isPrimitive(t) {
+			if p.Items == nil {
+				p.Items = &Schema{}
+			}
+			p.Items.Type = t
 			return nil
 		}
 	}

docparse/jsonschema_test.go

@@ -27,6 +27,7 @@ func TestFieldToProperty(t *testing.T) {
 		"pkg":       {Reference: "mail.Address"},
 		"pkgSlice":  {Type: "array", Items: &Schema{Reference: "mail.Address"}},
 		"pkgSliceP": {Type: "array", Items: &Schema{Reference: "mail.Address"}},
+		"cSlice":    {Type: "array", Items: &Schema{Type: "string"}},
 		"deeper":    {Reference: "a.refAnother"},
 		"docs": {Type: "string", Description: "This has some documentation!",
 			Required: []string{"docs"},

docparse/testdata/src/a/a.go

@@ -27,6 +27,7 @@ type foo struct {
 	pkg       mail.Address
 	pkgSlice  []mail.Address
 	pkgSliceP []*mail.Address
+	cSlice    []customStr
 	deeper    refAnother
 
 	// This has some documentation! {required}

testdata/openapi2/src/params-embed/in.go

@@ -1,10 +1,17 @@
 package params
 
+type customType string
+
 type common struct {
 	// FieldTasks common description.
 	//
 	// {enum: name priority status description}
 	FieldTasks []string `query:"fields[tasks]"`
+
+	// CustomTypes common description.
+	//
+	// {enum: blue red yellow}
+	CustomTypes []customType `query:"customTypes"`
 }
 
 type queryRef struct {

testdata/openapi2/src/params-embed/want.yaml

@@ -27,11 +27,21 @@ paths:
         type: array
         items:
           type: string
-        enum:
-        - name
-        - priority
-        - status
-        - description
+          enum:
+          - name
+          - priority
+          - status
+          - description
+      - name: customTypes
+        in: query
+        description: CustomTypes common description.
+        type: array
+        items:
+          type: string
+          enum:
+          - blue
+          - red
+          - yellow
       responses:
         200:
           description: 200 OK (no data)