@redocly/openapi-core 1.0.0-beta.106 → 1.0.0-beta.109

package/src/rules/common/spec.ts

@@ -6,13 +6,18 @@ import { isPlainObject } from '../../utils';
 
 export const OasSpec: Oas3Rule | Oas2Rule = () => {
   return {
-    any(node: any, { report, type, location, key, resolve, ignoreNextVisitorsOnNode }) {
+    any(
+      node: any,
+      { report, type, location, rawLocation, key, resolve, ignoreNextVisitorsOnNode }
+    ) {
       const nodeType = oasTypeOf(node);
+      const refLocation = rawLocation !== location ? rawLocation : undefined;
 
       if (type.items) {
         if (nodeType !== 'array') {
           report({
             message: `Expected type \`${type.name}\` (array) but got \`${nodeType}\``,
+            from: refLocation,
           });
           ignoreNextVisitorsOnNode();
         }
@@ -20,6 +25,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
       } else if (nodeType !== 'object') {
         report({
           message: `Expected type \`${type.name}\` (object) but got \`${nodeType}\``,
+          from: refLocation,
         });
         ignoreNextVisitorsOnNode();
         return;
@@ -28,10 +34,11 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
       const required =
         typeof type.required === 'function' ? type.required(node, key) : type.required;
 
-      for (let propName of required || []) {
+      for (const propName of required || []) {
         if (!(node as object).hasOwnProperty(propName)) {
           report({
             message: `The field \`${propName}\` must be present on this level.`,
+            from: refLocation,
             location: [{ reportOnKey: true }],
           });
         }
@@ -49,6 +56,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
           }
           report({
             message: `The field \`${propName}\` is not allowed here.`,
+            from: refLocation,
             location: location.child([propName]).key(),
           });
         }
@@ -57,7 +65,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
       const requiredOneOf = type.requiredOneOf || null;
       if (requiredOneOf) {
         let hasProperty = false;
-        for (let propName of requiredOneOf || []) {
+        for (const propName of requiredOneOf || []) {
           if ((node as object).hasOwnProperty(propName)) {
             hasProperty = true;
           }
@@ -67,6 +75,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
             message: `Must contain at least one of the following fields: ${type.requiredOneOf?.join(
               ', '
             )}.`,
+            from: refLocation,
             location: [{ reportOnKey: true }],
           });
       }
@@ -91,6 +100,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
           report({
             message: `Property \`${propName}\` is not expected here.`,
             suggest: getSuggest(propName, Object.keys(type.properties)),
+            from: refLocation,
             location: propLocation.key(),
           });
           continue;
@@ -111,12 +121,14 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
               message: `\`${propName}\` can be one of the following only: ${propSchema.enum
                 .map((i) => `"${i}"`)
                 .join(', ')}.`,
+              from: refLocation,
               suggest: getSuggest(propValue, propSchema.enum),
             });
           }
         } else if (propSchema.type && !matchesJsonSchemaType(propValue, propSchema.type, false)) {
           report({
             message: `Expected type \`${propSchema.type}\` but got \`${propValueType}\`.`,
+            from: refLocation,
             location: propLocation,
           });
         } else if (propValueType === 'array' && propSchema.items?.type) {
@@ -126,6 +138,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
             if (!matchesJsonSchemaType(item, itemsType, false)) {
               report({
                 message: `Expected type \`${itemsType}\` but got \`${oasTypeOf(item)}\`.`,
+                from: refLocation,
                 location: propLocation.child([i]),
               });
             }
@@ -136,6 +149,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
           if (propSchema.minimum > node[propName]) {
             report({
               message: `The value of the ${propName} field must be greater than or equal to ${propSchema.minimum}`,
+              from: refLocation,
               location: location.child([propName]),
             });
           }

package/src/rules/common/tags-alphabetical.ts

@@ -5,7 +5,7 @@ import { UserContext } from '../../walk';
 
 export const TagsAlphabetical: Oas3Rule | Oas2Rule = () => {
   return {
-    DefinitionRoot(root: Oas2Definition | Oas3Definition, { report, location }: UserContext) {
+    Root(root: Oas2Definition | Oas3Definition, { report, location }: UserContext) {
       if (!root.tags) return;
       for (let i = 0; i < root.tags.length - 1; i++) {
         if (root.tags[i].name > root.tags[i + 1].name) {

package/src/rules/oas2/index.ts

@@ -25,7 +25,7 @@ import { OperationDescription } from '../common/operation-description';
 import { PathNotIncludeQuery } from '../common/path-not-include-query';
 import { ParameterDescription } from '../common/parameter-description';
 import { OperationSingularTag } from '../common/operation-singular-tag';
-import { OperationSecurityDefined } from '../common/operation-security-defined';
+import { SecurityDefined } from '../common/security-defined';
 import { NoUnresolvedRefs } from '../no-unresolved-refs';
 import { PathHttpVerbsOrder } from '../common/path-http-verbs-order';
 import { NoIdenticalPaths } from '../common/no-identical-paths';
@@ -71,7 +71,7 @@ export const rules = {
   'path-params-defined': PathParamsDefined as Oas2Rule,
   'parameter-description': ParameterDescription as Oas2Rule,
   'operation-singular-tag': OperationSingularTag as Oas2Rule,
-  'operation-security-defined': OperationSecurityDefined as Oas2Rule,
+  'security-defined': SecurityDefined as Oas2Rule,
   'no-unresolved-refs': NoUnresolvedRefs as Oas2Rule,
   'no-identical-paths': NoIdenticalPaths as Oas2Rule,
   'no-ambiguous-paths': NoAmbiguousPaths as Oas2Rule,

package/src/rules/oas2/remove-unused-components.ts

@@ -4,7 +4,7 @@ import { Oas2Components } from '../../typings/swagger';
 import { isEmptyObject } from '../../utils';
 
 export const RemoveUnusedComponents: Oas2Rule = () => {
-  let components = new Map<
+  const components = new Map<
     string,
     { used: boolean; componentType?: keyof Oas2Components; name: string }
   >();
@@ -34,12 +34,12 @@ export const RemoveUnusedComponents: Oas2Rule = () => {
         }
       },
     },
-    DefinitionRoot: {
+    Root: {
       leave(root, ctx) {
         const data = ctx.getVisitorData() as { removedCount: number };
         data.removedCount = 0;
 
-        let rootComponents = new Set<keyof Oas2Components>();
+        const rootComponents = new Set<keyof Oas2Components>();
         components.forEach((usageInfo) => {
           const { used, name, componentType } = usageInfo;
           if (!used && componentType) {

package/src/rules/oas2/request-mime-type.ts

@@ -5,7 +5,7 @@ import { validateMimeType } from '../../utils';
 
 export const RequestMimeType: Oas2Rule = ({ allowedValues }) => {
   return {
-    DefinitionRoot(root: Oas2Definition, ctx: UserContext) {
+    Root(root: Oas2Definition, ctx: UserContext) {
       validateMimeType({ type: 'consumes', value: root }, ctx, allowedValues);
     },
     Operation: {

package/src/rules/oas2/response-mime-type.ts

@@ -5,7 +5,7 @@ import { validateMimeType } from '../../utils';
 
 export const ResponseMimeType: Oas2Rule = ({ allowedValues }) => {
   return {
-    DefinitionRoot(root: Oas2Definition, ctx: UserContext) {
+    Root(root: Oas2Definition, ctx: UserContext) {
       validateMimeType({ type: 'produces', value: root }, ctx, allowedValues);
     },
     Operation: {

package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts

@@ -3,8 +3,8 @@ import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
-describe('Oas3 as3-no-servers-empty-enum', () => {
-  it('oas3-no-servers-empty-enum: should report on server object with empty enum and unknown enum value', async () => {
+describe('Oas3 as3-no-server-variables-empty-enum', () => {
+  it('oas3-no-server-variables-empty-enum: should report on server object with empty enum and unknown enum value', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -24,7 +24,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -38,7 +38,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
             },
           ],
           "message": "Server variable with \`enum\` must be a non-empty array.",
-          "ruleId": "no-servers-empty-enum",
+          "ruleId": "no-server-variables-empty-enum",
           "severity": "error",
           "suggest": Array [],
         },
@@ -51,7 +51,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
             },
           ],
           "message": "Server variable define \`enum\` and \`default\`. \`enum\` must include default value",
-          "ruleId": "no-servers-empty-enum",
+          "ruleId": "no-server-variables-empty-enum",
           "severity": "error",
           "suggest": Array [],
         },
@@ -59,7 +59,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     `);
   });
 
-  it('oas3-no-servers-empty-enum: should report on server object with empty enum', async () => {
+  it('oas3-no-server-variables-empty-enum: should report on server object with empty enum', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -78,7 +78,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -92,7 +92,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
             },
           ],
           "message": "Server variable with \`enum\` must be a non-empty array.",
-          "ruleId": "no-servers-empty-enum",
+          "ruleId": "no-server-variables-empty-enum",
           "severity": "error",
           "suggest": Array [],
         },
@@ -100,7 +100,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     `);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because variables is empty object', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because variables is empty object', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -117,13 +117,13 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because variable is empty object', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because variable is empty object', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -141,13 +141,13 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because enum contains default value', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because enum contains default value', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -168,13 +168,13 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it('oas3-no-servers-empty-enum: should be success because enum contains default value', async () => {
+  it('oas3-no-server-variables-empty-enum: should be success because enum contains default value', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -197,7 +197,7 @@ describe('Oas3 as3-no-servers-empty-enum', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-servers-empty-enum': 'error' }),
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

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

@@ -76,7 +76,7 @@ describe('no-invalid-media-type-examples', () => {
     `);
   });
 
-  it('should report on invalid example with disallowAdditionalProperties', async () => {
+  it('should report on invalid example with allowAdditionalProperties', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -109,7 +109,7 @@ describe('no-invalid-media-type-examples', () => {
       config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
-          disallowAdditionalProperties: true,
+          allowAdditionalProperties: false,
         },
       }),
     });
@@ -137,7 +137,7 @@ describe('no-invalid-media-type-examples', () => {
     `);
   });
 
-  it('should not on invalid example with disallowAdditionalProperties', async () => {
+  it('should not on invalid example with allowAdditionalProperties', async () => {
     const document = parseYamlToDocument(
       outdent`
         openapi: 3.0.0
@@ -169,7 +169,7 @@ describe('no-invalid-media-type-examples', () => {
       config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
-          disallowAdditionalProperties: true,
+          allowAdditionalProperties: false,
         },
       }),
     });
@@ -219,7 +219,7 @@ describe('no-invalid-media-type-examples', () => {
       config: await makeConfig({
         'no-invalid-media-type-examples': {
           severity: 'error',
-          disallowAdditionalProperties: true,
+          allowAdditionalProperties: false,
         },
       }),
     });

package/src/rules/oas3/__tests__/operation-4xx-problem-details-rfc7807.test.ts

@@ -0,0 +1,145 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Oas3 operation-4xx-problem-details-rfc7807', () => {
+  it('should report `4xx` must have content type `application/problem+json` ', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: "3.0.0"
+        paths:
+          /pets:
+            get:
+              summary: List all pets
+              operationId: listPets
+              responses:
+                '400':
+                  description: Test
+                  content:
+                    application/json:
+                      schema:
+                        type: object
+                        properties:
+                          type:
+                            type: string
+                          title:
+                            type: string
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'operation-4xx-problem-details-rfc7807': 'error' }),
+    });
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/paths/~1pets/get/responses/400",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Response \`4xx\` must have content-type \`application/problem+json\`.",
+          "ruleId": "operation-4xx-problem-details-rfc7807",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should report `application/problem+json` must have `type` property', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: "3.0.0"
+        paths:
+          /pets:
+            get:
+              summary: List all pets
+              operationId: listPets
+              responses:
+                '400':
+                  description: Test
+                  content:
+                    application/problem+json:
+                      schema:
+                        type: object
+                        properties:
+                          title:
+                            type: string
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'operation-4xx-problem-details-rfc7807': 'error' }),
+    });
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/paths/~1pets/get/responses/400/content/application~1problem+json/schema/properties/type",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "SchemaProperties object should contain \`type\` field.",
+          "ruleId": "operation-4xx-problem-details-rfc7807",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should report `application/problem+json` must have `schema` property', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: "3.0.0"
+        paths:
+          /pets:
+            get:
+              summary: List all pets
+              operationId: listPets
+              responses:
+                '400':
+                  description: Test
+                  content:
+                    application/problem+json:
+                      example: asd
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'operation-4xx-problem-details-rfc7807': 'error' }),
+    });
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/paths/~1pets/get/responses/400/content/application~1problem+json/schema",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "MediaType object should contain \`schema\` field.",
+          "ruleId": "operation-4xx-problem-details-rfc7807",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+});

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -47,6 +47,7 @@ describe('Oas3 Structural visitor basic', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info/contact/url",
@@ -60,6 +61,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info/contact/email",
@@ -73,6 +75,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info/license",
@@ -103,6 +106,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/servers/0/variables/a/enum/0",
@@ -116,6 +120,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/tags/0",
@@ -129,6 +134,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/tags/1",
@@ -175,6 +181,7 @@ describe('Oas3 Structural visitor basic', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/components1",
@@ -203,6 +210,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info/contact/test",
@@ -244,6 +252,7 @@ describe('Oas3 Structural visitor basic', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/",
@@ -270,6 +279,7 @@ describe('Oas3 Structural visitor basic', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info",