Fix allOf merges using external refs (oapi-codegen#941)

octomad · Andrew Young · web-flow · commit 4175ea2c4b69 · 2023-03-14T09:20:04.000-07:00
Co-authored-by: Andrew Young &lt;andrew.young@verizonmedia.com&gt;
diff --git a/pkg/codegen/codegen_test.go b/pkg/codegen/codegen_test.go
@@ -145,8 +145,11 @@ func TestExampleOpenAPICodeGeneration(t *testing.T) {
 		},
 	}
 
+	loader := openapi3.NewLoader()
+	loader.IsExternalRefsAllowed = true
+
 	// Get a spec from the test definition in this file:
-	swagger, err := openapi3.NewLoader().LoadFromData([]byte(testOpenAPIDefinition))
+	swagger, err := loader.LoadFromData([]byte(testOpenAPIDefinition))
 	assert.NoError(t, err)
 
 	// Run our code generation:
diff --git a/pkg/codegen/filter_test.go b/pkg/codegen/filter_test.go
@@ -23,8 +23,11 @@ func TestFilterOperationsByTag(t *testing.T) {
 			},
 		}
 
+		loader := openapi3.NewLoader()
+		loader.IsExternalRefsAllowed = true
+
 		// Get a spec from the test definition in this file:
-		swagger, err := openapi3.NewLoader().LoadFromData([]byte(testOpenAPIDefinition))
+		swagger, err := loader.LoadFromData([]byte(testOpenAPIDefinition))
 		assert.NoError(t, err)
 
 		// Run our code generation:
@@ -49,8 +52,11 @@ func TestFilterOperationsByTag(t *testing.T) {
 			},
 		}
 
+		loader := openapi3.NewLoader()
+		loader.IsExternalRefsAllowed = true
+
 		// Get a spec from the test definition in this file:
-		swagger, err := openapi3.NewLoader().LoadFromData([]byte(testOpenAPIDefinition))
+		swagger, err := loader.LoadFromData([]byte(testOpenAPIDefinition))
 		assert.NoError(t, err)
 
 		// Run our code generation:
diff --git a/pkg/codegen/merge_schemas.go b/pkg/codegen/merge_schemas.go
@@ -53,10 +53,10 @@ func valueWithPropagatedRef(ref *openapi3.SchemaRef) (openapi3.Schema, error) {
 	}
 
 	pathParts := strings.Split(ref.Ref, "#")
-	if len(pathParts) != 2 {
+	if len(pathParts) < 1 || len(pathParts) > 2 {
 		return openapi3.Schema{}, fmt.Errorf("unsupported reference: %s", ref.Ref)
 	}
-	remoteComponent, _ := pathParts[0], pathParts[1]
+	remoteComponent := pathParts[0]
 
 	// remote ref
 	schema := *ref.Value
diff --git a/pkg/codegen/test_schema.json b/pkg/codegen/test_schema.json
@@ -0,0 +1,15 @@
+{
+  "title": "node",
+  "type": "object",
+  "description": "Represents a node",
+  "properties": {
+    "id": {
+      "type": "string",
+      "format": "uri-reference"
+    },
+    "type": {
+      "type": "string",
+      "pattern": "^[A-Z][a-zA-Z0-9]*$"
+    }
+  }
+}
diff --git a/pkg/codegen/test_spec.yaml b/pkg/codegen/test_spec.yaml
@@ -108,6 +108,25 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /user:
+    get:
+      tags:
+        - mergeAllOf
+      summary: Merges allOf ref-ing a JSON schema
+      operationId: getUser
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        default:
+          description: Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 
 components:
   schemas:
@@ -177,3 +196,12 @@ components:
             - na
             - single
             - double
+    User:
+      allOf:
+        - $ref: ./test_schema.json
+        - type: object
+          additionalProperties: false
+          properties:
+            name:
+              type: string
+              description: User name

Original file line number	Diff line number	Diff line change
`@@ -53,10 +53,10 @@ func valueWithPropagatedRef(ref *openapi3.SchemaRef) (openapi3.Schema, error) {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`pathParts := strings.Split(ref.Ref, "#")`
`56`		`- if len(pathParts) != 2 {`
	`56`	`+ if len(pathParts) < 1 \|\| len(pathParts) > 2 {`
`57`	`57`	`return openapi3.Schema{}, fmt.Errorf("unsupported reference: %s", ref.Ref)`
`58`	`58`	`}`
`59`		`- remoteComponent, _ := pathParts[0], pathParts[1]`
	`59`	`+ remoteComponent := pathParts[0]`
`60`	`60`
`61`	`61`	`// remote ref`
`62`	`62`	`schema := *ref.Value`