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

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

@@ -31,6 +31,7 @@ describe('Oas3 spec', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/",
@@ -44,6 +45,7 @@ describe('Oas3 spec', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/paths/~1test/get/parameters/0",
@@ -59,4 +61,81 @@ describe('Oas3 spec', () => {
       ]
     `);
   });
+
+  it('should report with "referenced from"', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      components:
+        requestBodies:
+          TestRequestBody:
+            content:
+              application/json:
+                schema:
+                  type: object
+        schemas:
+          TestSchema:
+            title: TestSchema
+            allOf:
+              - $ref: "#/components/requestBodies/TestRequestBody"
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ spec: 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "The field \`paths\` must be present on this level.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "The field \`info\` must be present on this level.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": Object {
+            "pointer": "#/components/schemas/TestSchema/allOf/0",
+            "source": "foobar.yaml",
+          },
+          "location": Array [
+            Object {
+              "pointer": "#/components/requestBodies/TestRequestBody/content",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Property \`content\` is not expected here.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
 });

package/src/rules/common/assertions/__tests__/utils.test.ts

@@ -70,13 +70,13 @@ describe('Oas3 assertions', () => {
           },
         ];
 
-        const visitors = buildVisitorObject('MediaTypeMap', context, () => {}) as any;
+        const visitors = buildVisitorObject('MediaTypesMap', context, () => {}) as any;
 
         expect(visitors).toMatchInlineSnapshot(`
           Object {
             "Operation": Object {
               "ResponsesMap": Object {
-                "MediaTypeMap": [Function],
+                "MediaTypesMap": [Function],
                 "skip": [Function],
               },
               "skip": [Function],

package/src/rules/common/no-ambiguous-paths.ts

@@ -5,7 +5,7 @@ import { Oas2Paths } from '../../typings/swagger';
 
 export const NoAmbiguousPaths: Oas3Rule | Oas2Rule = () => {
   return {
-    PathMap(pathMap: Oas3Paths | Oas2Paths, { report, location }: UserContext) {
+    PathsMap(pathMap: Oas3Paths | Oas2Paths, { report, location }: UserContext) {
       const seenPaths: string[] = [];
 
       for (const currentPath of Object.keys(pathMap)) {

package/src/rules/common/no-identical-paths.ts

@@ -5,7 +5,7 @@ import { Oas2Paths } from '../../typings/swagger';
 
 export const NoIdenticalPaths: Oas3Rule | Oas2Rule = () => {
   return {
-    PathMap(pathMap: Oas3Paths | Oas2Paths, { report, location }: UserContext) {
+    PathsMap(pathMap: Oas3Paths | Oas2Paths, { report, location }: UserContext) {
       const pathsMap = new Map<string, string>();
       for (const pathName of Object.keys(pathMap)) {
         const id = pathName.replace(/{.+?}/g, '{VARIABLE}');

package/src/rules/common/operation-2xx-response.ts

@@ -7,7 +7,7 @@ export const Operation2xxResponse: Oas3Rule | Oas2Rule = () => {
       const codes = Object.keys(responses);
       if (!codes.some((code) => code === 'default' || /2[Xx0-9]{2}/.test(code))) {
         report({
-          message: 'Operation must have at least one `2xx` response.',
+          message: 'Operation must have at least one `2XX` response.',
           location: { reportOnKey: true },
         });
       }

package/src/rules/common/operation-4xx-response.ts

@@ -8,7 +8,7 @@ export const Operation4xxResponse: Oas3Rule | Oas2Rule = () => {
 
       if (!codes.some((code) => /4[Xx0-9]{2}/.test(code))) {
         report({
-          message: 'Operation must have at least one `4xx` response.',
+          message: 'Operation must have at least one `4XX` response.',
           location: { reportOnKey: true },
         });
       }

package/src/rules/common/operation-operationId.ts

@@ -6,7 +6,7 @@ import { Oas3Operation } from '../../typings/openapi';
 
 export const OperationOperationId: Oas3Rule | Oas2Rule = () => {
   return {
-    DefinitionRoot: {
+    Root: {
       PathItem: {
         Operation(operation: Oas2Operation | Oas3Operation, ctx: UserContext) {
           validateDefinedAndNonEmpty('operationId', operation, ctx);

package/src/rules/common/operation-tag-defined.ts

@@ -7,7 +7,7 @@ export const OperationTagDefined: Oas3Rule | Oas2Rule = () => {
   let definedTags: Set<string>;
 
   return {
-    DefinitionRoot(root: Oas2Definition | Oas3Definition) {
+    Root(root: Oas2Definition | Oas3Definition) {
       definedTags = new Set((root.tags ?? []).map((t) => t.name));
     },
     Operation(operation: Oas2Operation | Oas3Operation, { report, location }: UserContext) {

package/src/rules/common/path-not-include-query.ts

@@ -3,7 +3,7 @@ import { UserContext } from '../../walk';
 
 export const PathNotIncludeQuery: Oas3Rule | Oas2Rule = () => {
   return {
-    PathMap: {
+    PathsMap: {
       PathItem(_operation: object, { report, key }: UserContext) {
         if (key.toString().includes('?')) {
           report({

package/src/rules/common/{operation-security-defined.ts → security-defined.ts}

@@ -1,10 +1,10 @@
 import { Oas3Rule, Oas2Rule } from '../../visitors';
 import { Location } from '../../ref-utils';
 import { UserContext } from '../../walk';
-import { Oas2SecurityScheme } from '../../typings/swagger';
-import { Oas3SecurityScheme } from '../../typings/openapi';
+import { Oas2Definition, Oas2Operation, Oas2SecurityScheme } from '../../typings/swagger';
+import { Oas3Definition, Oas3Operation, Oas3SecurityScheme } from '../../typings/openapi';
 
-export const OperationSecurityDefined: Oas3Rule | Oas2Rule = () => {
+export const SecurityDefined: Oas3Rule | Oas2Rule = () => {
   const referencedSchemes = new Map<
     string,
     {
@@ -13,9 +13,11 @@ export const OperationSecurityDefined: Oas3Rule | Oas2Rule = () => {
     }
   >();
 
+  let eachOperationHasSecurity: boolean = true;
+
   return {
     DefinitionRoot: {
-      leave(_: object, { report }: UserContext) {
+      leave(root: Oas2Definition | Oas3Definition, { report }: UserContext) {
         for (const [name, scheme] of referencedSchemes.entries()) {
           if (scheme.defined) continue;
           for (const reportedFromLocation of scheme.from) {
@@ -25,6 +27,14 @@ export const OperationSecurityDefined: Oas3Rule | Oas2Rule = () => {
             });
           }
         }
+
+        if (root.security || eachOperationHasSecurity) {
+          return;
+        } else {
+          report({
+            message: `Every API should have security defined on the root level or for each operation.`,
+          });
+        }
       },
     },
     SecurityScheme(_securityScheme: Oas2SecurityScheme | Oas3SecurityScheme, { key }: UserContext) {
@@ -41,5 +51,10 @@ export const OperationSecurityDefined: Oas3Rule | Oas2Rule = () => {
         }
       }
     },
+    Operation(operation: Oas2Operation | Oas3Operation) {
+      if (!operation?.security) {
+        eachOperationHasSecurity = false;
+      }
+    },
   };
 };

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;
@@ -32,6 +38,7 @@ export const OasSpec: Oas3Rule | Oas2Rule = () => {
         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(),
           });
         }
@@ -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

@@ -34,7 +34,7 @@ export const RemoveUnusedComponents: Oas2Rule = () => {
         }
       },
     },
-    DefinitionRoot: {
+    Root: {
       leave(root, ctx) {
         const data = ctx.getVisitorData() as { removedCount: number };
         data.removedCount = 0;

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__/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",