Only require additionalProperties when required fields are present.

Signed-off-by: dblock <[email protected]>

tools/src/tester/MergedOpenApiSpec.ts

@@ -34,15 +34,15 @@ export default class MergedOpenApiSpec {
   }
 
   private inject_additional_properties(ctx: SpecificationContext, spec: OpenAPIV3.Document): void {
-    const visitor = new SchemaVisitor((_ctx, schema) => {
-      if ('properties' in schema && schema.additionalProperties === undefined) {
+    const visitor = new SchemaVisitor((_ctx, schema: any) => {
+      if (('required' in schema) && ('properties' in schema) && !('additionalProperties' in schema)) {
         // causes any undeclared field in the response to produce an error
-        (schema as any).additionalProperties = {
+        schema.additionalProperties = {
           not: true,
           errorMessage: "property is not defined in the spec"
         }
       }
-    });
+    })
 
     visitor.visit_specification(ctx, spec)
   }

tools/tests/tester/MergedOpenApiSpec.test.ts

@@ -10,16 +10,27 @@
 import { Logger } from 'Logger'
 import MergedOpenApiSpec from "tester/MergedOpenApiSpec"
 
-const spec = new MergedOpenApiSpec('tools/tests/tester/fixtures/specs/complete', new Logger())
-
-test('adds additionalProperties when not present', () => {
+describe('additionalProperties', () => {
+  const spec = new MergedOpenApiSpec('tools/tests/tester/fixtures/specs/complete', new Logger())
   const responses: any = spec.spec().components?.responses
-  const schema = responses['info@200'].content['application/json'].schema  
-  expect(schema.additionalProperties).toEqual({ not: true, errorMessage: 'property is not defined in the spec' })
-})
 
-test('does not add additionalProperties when present', () => {
-  const responses: any = spec.spec().components?.responses
-  const schema = responses['info@201'].content['application/json'].schema  
-  expect(schema.additionalProperties).toEqual(true)
+  test('is added with required fields', () => {
+    const schema = responses['info@200'].content['application/json'].schema
+    expect(schema.additionalProperties).toEqual({ not: true, errorMessage: 'property is not defined in the spec' })
+  })
+
+  test('is not added when true', () => {
+    const schema = responses['info@201'].content['application/json'].schema
+    expect(schema.additionalProperties).toEqual(true)
+  })
+
+  test('is not added when object', () => {
+    const schema = responses['info@404'].content['application/json'].schema
+    expect(schema.additionalProperties).toEqual({ type: 'object' })
+  })
+
+  test('is not added unless required is present', () => {
+    const schema = responses['info@500'].content['application/json'].schema
+    expect(schema.additionalProperties).toBeUndefined()
+  })
 })

tools/tests/tester/fixtures/specs/complete/namespaces/index.yaml

@@ -12,6 +12,10 @@ paths:
           $ref: '#/components/responses/info@200'
         '201':
           $ref: '#/components/responses/info@201'
+        '404':
+          $ref: '#/components/responses/info@404'
+        '500':
+          $ref: '#/components/responses/info@500'
 components:
   responses:
     info@200:
@@ -37,3 +41,25 @@ components:
             required:
               - tagline
             additionalProperties: true
+    info@404:
+      description: ''
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              tagline:
+                type: string
+            required:
+              - tagline
+            additionalProperties:
+              type: object
+    info@500:
+      description: ''
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              tagline:
+                type: string