Add OpenAPI generation for maps of string -> object (#15519)

Author: slevenick

mmv1/openapi_generate/parser.go

@@ -303,7 +303,7 @@ func parseOpenApi(resourcePath, resourceName string, root *openapi3.T) []any {
 		if strings.Contains(strings.ToLower(param.Value.Name), strings.ToLower(resourceName)) {
 			idParam = param.Value.Name
 		}
-		paramObj := writeObject(param.Value.Name, param.Value.Schema, propType(param.Value.Schema), true)
+		paramObj := WriteObject(param.Value.Name, param.Value.Schema, propType(param.Value.Schema), true)
 		description := param.Value.Description
 		if strings.TrimSpace(description) == "" {
 			description = "No description"
@@ -336,7 +336,7 @@ func propType(prop *openapi3.SchemaRef) openapi3.Types {
 	}
 }
 
-func writeObject(name string, obj *openapi3.SchemaRef, objType openapi3.Types, urlParam bool) api.Type {
+func WriteObject(name string, obj *openapi3.SchemaRef, objType openapi3.Types, urlParam bool) api.Type {
 	var field api.Type
 
 	switch name {
@@ -394,8 +394,17 @@ func writeObject(name string, obj *openapi3.SchemaRef, objType openapi3.Types, u
 		}
 
 		field.Type = "NestedObject"
-
-		field.Properties = buildProperties(obj.Value.Properties, obj.Value.Required)
+		if obj.Value.AdditionalProperties.Schema != nil {
+			field.Type = "Map"
+			field.KeyName = "TODO: CHANGEME"
+			var valueType api.Type
+			valueType.Name = "TODO: CHANGEME"
+			valueType.Type = "NestedObject"
+			valueType.Properties = buildProperties(obj.Value.AdditionalProperties.Schema.Value.Properties, obj.Value.AdditionalProperties.Schema.Value.Required)
+			field.ValueType = &valueType
+		} else {
+			field.Properties = buildProperties(obj.Value.Properties, obj.Value.Required)
+		}
 	case "array":
 		field.Type = "Array"
 		var subField api.Type
@@ -454,7 +463,7 @@ func buildProperties(props openapi3.Schemas, required []string) []*api.Type {
 	properties := []*api.Type{}
 	for _, k := range slices.Sorted(maps.Keys(props)) {
 		prop := props[k]
-		propObj := writeObject(k, prop, propType(prop), false)
+		propObj := WriteObject(k, prop, propType(prop), false)
 		if slices.Contains(required, k) {
 			propObj.Required = true
 		}

mmv1/openapi_generate/parser_test.go

@@ -0,0 +1,24 @@
+package openapi_generate
+
+import (
+	"context"
+	"github.com/getkin/kin-openapi/openapi3"
+	"testing"
+)
+
+func TestMapType(t *testing.T) {
+	_ = NewOpenapiParser("/fake", "/fake")
+	ctx := context.Background()
+	loader := &openapi3.Loader{Context: ctx, IsExternalRefsAllowed: true}
+	doc, _ := loader.LoadFromFile("./test_data/test_api.yaml")
+	_ = doc.Validate(ctx)
+
+	petSchema := doc.Paths.Map()["/pets"].Post.Parameters[0].Value.Schema
+	mmObject := WriteObject("pet", petSchema, propType(petSchema), false)
+	if mmObject.KeyName == "" || mmObject.Type != "Map" {
+		t.Error("Failed to parse map type")
+	}
+	if len(mmObject.ValueType.Properties) != 4 {
+		t.Errorf("Expected 4 properties, found %d", len(mmObject.ValueType.Properties))
+	}
+}

mmv1/openapi_generate/test_data/test_api.yaml

@@ -0,0 +1,128 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        200:
+          description: An paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:    
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      parameters:
+        - name: pet
+          in: body
+          required: true
+          description: The pet to create
+          schema:
+            type: object
+            additionalProperties:
+              $ref: "#/components/schemas/Pet"
+      responses:
+        201:
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        200:
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+        mapType:
+          type: object
+          additionalProperties: 
+            $ref: "#/components/schemas/Food"
+    Food:
+      required:
+        - name
+      properties:
+        name:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string