chore: change default allowAdditionalProperties and minify tests

Author: vadyvas

packages/core/src/rules/common/__tests__/no-invalid-parameter-examples.test.ts

@@ -52,67 +52,6 @@ describe('no-invalid-parameter-examples', () => {
     `);
   });
 
-  it('should report on invalid example with additional properties when allowAdditionalProperties is false', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /users:
-            get:
-              parameters:
-                - name: filter
-                  in: query
-                  schema:
-                    type: object
-                    properties:
-                      name:
-                        type: string
-                      age:
-                        type: number
-                  example:
-                    name: "John"
-                    age: 30
-                    extraProperty: "not allowed"
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await createConfig({
-        rules: {
-          'no-invalid-parameter-examples': {
-            severity: 'error',
-            allowAdditionalProperties: false,
-          },
-        },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": {
-            "pointer": "#/paths/~1users/get/parameters/0",
-            "source": "foobar.yaml",
-          },
-          "location": [
-            {
-              "pointer": "#/paths/~1users/get/parameters/0/example/extraProperty",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: must NOT have unevaluated properties \`extraProperty\`.",
-          "ruleId": "no-invalid-parameter-examples",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
   it('should report on invalid example in examples object when allowAdditionalProperties is false', async () => {
     const document = parseYamlToDocument(
       outdent`

packages/core/src/rules/common/__tests__/no-invalid-schema-examples.test.ts

@@ -85,63 +85,6 @@ describe('no-invalid-schema-examples', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
-  it('should report on invalid example with additional properties', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          schemas:
-            Car:
-              type: object
-              properties:
-                color:
-                  type: string
-                model:
-                  type: string
-              example:
-                color: "red"
-                model: "sedan"
-                extraProperty: "not allowed"
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await createConfig({
-        rules: {
-          'no-invalid-schema-examples': {
-            severity: 'error',
-            allowAdditionalProperties: false,
-          },
-        },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": {
-            "pointer": "#/components/schemas/Car",
-            "source": "foobar.yaml",
-          },
-          "location": [
-            {
-              "pointer": "#/components/schemas/Car/example/extraProperty",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Example value must conform to the schema: must NOT have unevaluated properties \`extraProperty\`.",
-          "ruleId": "no-invalid-schema-examples",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
   it('should report on invalid examples with additional properties', async () => {
     const document = parseYamlToDocument(
       outdent`

packages/core/src/rules/common/no-invalid-parameter-examples.ts

@@ -10,7 +10,8 @@ export const NoInvalidParameterExamples: any = (opts: any) => {
       leave(parameter: Oas3Parameter, ctx: UserContext) {
         const allowAdditionalProperties = isDefined(opts.allowAdditionalProperties)
           ? opts.allowAdditionalProperties
-          : true;
+          : false;
+
         if (isDefined(parameter.example)) {
           validateExample(
             parameter.example,

packages/core/src/rules/common/no-invalid-schema-examples.ts

@@ -12,7 +12,7 @@ export const NoInvalidSchemaExamples: Oas3Rule | Oas2Rule = (opts: any) => {
         const examples = (schema as Oas3_1Schema).examples;
         const allowAdditionalProperties = isDefined(opts.allowAdditionalProperties)
           ? opts.allowAdditionalProperties
-          : true;
+          : false;
 
         if (examples) {
           for (const example of examples) {

packages/core/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts

@@ -735,7 +735,7 @@ describe('no-invalid-media-type-examples', () => {
     `);
   });
 
-  it('should allow additional properties by default for example', async () => {
+  it('should report additional properties by default for example', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -771,47 +771,26 @@ describe('no-invalid-media-type-examples', () => {
       }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should allow additional properties by default for examples', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              responses:
-                200:
-                  content:
-                    application/json:
-                      examples:
-                        example1:
-                          value:
-                            color: "red"
-                            model: "sedan"
-                            extraProperty: "allowed by default"
-                      schema:
-                        type: object
-                        properties:
-                          color:
-                            type: string
-                          model:
-                            type: string
-      `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await createConfig({
-        rules: {
-          'no-invalid-media-type-examples': 'error',
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "from": {
+            "pointer": "#/paths/~1pet/get/responses/200/content/application~1json",
+            "source": "foobar.yaml",
+          },
+          "location": [
+            {
+              "pointer": "#/paths/~1pet/get/responses/200/content/application~1json/example/extraProperty",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example value must conform to the schema: must NOT have unevaluated properties \`extraProperty\`.",
+          "ruleId": "no-invalid-media-type-examples",
+          "severity": "error",
+          "suggest": [],
         },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+      ]
+    `);
   });
 });

packages/core/src/rules/oas3/no-invalid-media-type-examples.ts

@@ -17,7 +17,7 @@ export const ValidContentExamples: Oas3Rule = (opts) => {
         const { location, resolve } = ctx;
         const allowAdditionalProperties = isDefined(opts.allowAdditionalProperties)
           ? opts.allowAdditionalProperties
-          : true;
+          : false;
 
         if (isDefined(mediaType.example)) {
           resolveAndValidateExample(mediaType.example, location.child('example'));

tests/e2e/lint/no-invalid-examples-allow-additional-properties-in-config/redocly.yaml

@@ -8,7 +8,6 @@ rules:
     allowAdditionalProperties: true
   no-invalid-parameter-examples:
     severity: error
-    allowAdditionalProperties: false
   no-invalid-media-type-examples:
     severity: error
     allowAdditionalProperties: false