@redocly/openapi-core 1.25.8 → 1.25.10

package/src/rules/oas3/__tests__/component-name-unique.test.ts

@@ -44,18 +44,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/schemas/SomeSchema",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'schemas/SomeSchema' is not unique. It is defined at:
-        - /foobar.yaml#/components/schemas/SomeSchema
+            "message": "Component 'schemas/SomeSchema' is not unique. It is also defined at:
         - /test.yaml#/components/schemas/SomeSchema",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/components/schemas/SomeSchema",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'schemas/SomeSchema' is not unique. It is also defined at:
+        - /foobar.yaml#/components/schemas/SomeSchema",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -99,18 +112,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/schemas/SomeSchema",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'schemas/SomeSchema' is not unique. It is defined at:
-        - /foobar.yaml#/components/schemas/SomeSchema
+            "message": "Component 'schemas/SomeSchema' is not unique. It is also defined at:
         - /SomeSchema.yaml",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/",
+                "reportOnKey": false,
+                "source": "/SomeSchema.yaml",
+              },
+            ],
+            "message": "Component 'schemas/SomeSchema' is not unique. It is also defined at:
+        - /foobar.yaml#/components/schemas/SomeSchema",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -202,18 +228,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/parameters/ParameterOne",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'parameters/ParameterOne' is not unique. It is defined at:
-        - /foobar.yaml#/components/parameters/ParameterOne
+            "message": "Component 'parameters/ParameterOne' is not unique. It is also defined at:
         - /test.yaml#/components/parameters/ParameterOne",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/components/parameters/ParameterOne",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'parameters/ParameterOne' is not unique. It is also defined at:
+        - /foobar.yaml#/components/parameters/ParameterOne",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -261,18 +300,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/parameters/ParameterOne",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'parameters/ParameterOne' is not unique. It is defined at:
-        - /foobar.yaml#/components/parameters/ParameterOne
+            "message": "Component 'parameters/ParameterOne' is not unique. It is also defined at:
         - /ParameterOne.yaml",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/",
+                "reportOnKey": false,
+                "source": "/ParameterOne.yaml",
+              },
+            ],
+            "message": "Component 'parameters/ParameterOne' is not unique. It is also defined at:
+        - /foobar.yaml#/components/parameters/ParameterOne",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -378,18 +430,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/responses/SuccessResponse",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'responses/SuccessResponse' is not unique. It is defined at:
-        - /foobar.yaml#/components/responses/SuccessResponse
+            "message": "Component 'responses/SuccessResponse' is not unique. It is also defined at:
         - /test.yaml#/components/responses/SuccessResponse",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/components/responses/SuccessResponse",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'responses/SuccessResponse' is not unique. It is also defined at:
+        - /foobar.yaml#/components/responses/SuccessResponse",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -444,18 +509,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/responses/SuccessResponse",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'responses/SuccessResponse' is not unique. It is defined at:
-        - /foobar.yaml#/components/responses/SuccessResponse
+            "message": "Component 'responses/SuccessResponse' is not unique. It is also defined at:
         - /SuccessResponse.yaml",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/",
+                "reportOnKey": false,
+                "source": "/SuccessResponse.yaml",
+              },
+            ],
+            "message": "Component 'responses/SuccessResponse' is not unique. It is also defined at:
+        - /foobar.yaml#/components/responses/SuccessResponse",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -565,18 +643,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/requestBodies/MyRequestBody",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is defined at:
-        - /foobar.yaml#/components/requestBodies/MyRequestBody
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
         - /test.yaml#/components/requestBodies/MyRequestBody",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/components/requestBodies/MyRequestBody",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
+        - /foobar.yaml#/components/requestBodies/MyRequestBody",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -632,18 +723,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/requestBodies/MyRequestBody",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is defined at:
-        - /foobar.yaml#/components/requestBodies/MyRequestBody
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
         - /MyRequestBody.yaml",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/",
+                "reportOnKey": false,
+                "source": "/MyRequestBody.yaml",
+              },
+            ],
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
+        - /foobar.yaml#/components/requestBodies/MyRequestBody",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -761,13 +865,12 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/requestBodies/MyRequestBody",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is defined at:
-        - /foobar.yaml#/components/requestBodies/MyRequestBody
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
         - /test.yaml#/components/requestBodies/MyRequestBody",
             "ruleId": "component-name-unique",
             "severity": "error",
@@ -776,18 +879,45 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/requestBodies/MyRequestBody",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
+        - /foobar.yaml#/components/requestBodies/MyRequestBody",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
+          {
+            "location": [
+              {
+                "pointer": "#/components/schemas/SomeSchema",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'schemas/SomeSchema' is not unique. It is defined at:
-        - /foobar.yaml#/components/schemas/SomeSchema
+            "message": "Component 'schemas/SomeSchema' is not unique. It is also defined at:
         - /test.yaml#/components/schemas/SomeSchema",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/components/schemas/SomeSchema",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'schemas/SomeSchema' is not unique. It is also defined at:
+        - /foobar.yaml#/components/schemas/SomeSchema",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });
@@ -804,18 +934,31 @@ describe('Oas3 component-name-unique', () => {
           {
             "location": [
               {
-                "pointer": "#/",
+                "pointer": "#/components/requestBodies/MyRequestBody",
                 "reportOnKey": false,
                 "source": "/foobar.yaml",
               },
             ],
-            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is defined at:
-        - /foobar.yaml#/components/requestBodies/MyRequestBody
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
         - /test.yaml#/components/requestBodies/MyRequestBody",
             "ruleId": "component-name-unique",
             "severity": "error",
             "suggest": [],
           },
+          {
+            "location": [
+              {
+                "pointer": "#/components/requestBodies/MyRequestBody",
+                "reportOnKey": false,
+                "source": "/test.yaml",
+              },
+            ],
+            "message": "Component 'requestBodies/MyRequestBody' is not unique. It is also defined at:
+        - /foobar.yaml#/components/requestBodies/MyRequestBody",
+            "ruleId": "component-name-unique",
+            "severity": "error",
+            "suggest": [],
+          },
         ]
       `);
     });

package/src/rules/oas3/component-name-unique.ts

@@ -1,3 +1,4 @@
+import type { Location } from '../../ref-utils';
 import type { Problem, UserContext } from '../../walk';
 import type { Oas2Rule, Oas3Rule, Oas3Visitor } from '../../visitors';
 import type {
@@ -21,8 +22,10 @@ const TYPE_NAME_TO_OPTION_COMPONENT_NAME: { [key: string]: string } = {
   [TYPE_NAME_REQUEST_BODY]: 'requestBodies',
 };
 
+type ComponentsMapValue = { absolutePointers: Set<string>; locations: Location[] };
+
 export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
-  const components = new Map<string, Set<string>>();
+  const components = new Map<string, ComponentsMapValue>();
 
   const typeNames: string[] = [];
   if (options.schemas !== 'off') {
@@ -46,32 +49,31 @@ export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
           const resolvedRef = resolve(ref);
           if (!resolvedRef.location) return;
 
-          addComponentFromAbsoluteLocation(
-            typeName,
-            resolvedRef.location.absolutePointer.toString()
-          );
+          addComponentFromAbsoluteLocation(typeName, resolvedRef.location);
         }
       },
     },
     Root: {
       leave(root: Oas3Definition, ctx: UserContext) {
         components.forEach((value, key, _) => {
-          if (value.size > 1) {
+          if (value.absolutePointers.size > 1) {
             const component = getComponentFromKey(key);
             const optionComponentName = getOptionComponentNameForTypeName(component.typeName);
-            const definitions = Array.from(value)
-              .map((v) => `- ${v}`)
-              .join('\n');
-
-            const problem: Problem = {
-              message: `Component '${optionComponentName}/${component.componentName}' is not unique. It is defined at:\n${definitions}`,
-            };
-
             const componentSeverity = optionComponentName ? options[optionComponentName] : null;
-            if (componentSeverity) {
-              problem.forceSeverity = componentSeverity;
+            for (const location of value.locations) {
+              const definitions = Array.from(value.absolutePointers)
+                .filter((v) => v !== location.absolutePointer.toString())
+                .map((v) => `- ${v}`)
+                .join('\n');
+              const problem: Problem = {
+                message: `Component '${optionComponentName}/${component.componentName}' is not unique. It is also defined at:\n${definitions}`,
+                location: location,
+              };
+              if (componentSeverity) {
+                problem.forceSeverity = componentSeverity;
+              }
+              ctx.report(problem);
             }
-            ctx.report(problem);
           }
         });
       },
@@ -81,7 +83,7 @@ export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
   if (options.schemas != 'off') {
     rule.NamedSchemas = {
       Schema(_: Oas3Schema, { location }: UserContext) {
-        addComponentFromAbsoluteLocation(TYPE_NAME_SCHEMA, location.absolutePointer.toString());
+        addComponentFromAbsoluteLocation(TYPE_NAME_SCHEMA, location);
       },
     };
   }
@@ -89,7 +91,7 @@ export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
   if (options.responses != 'off') {
     rule.NamedResponses = {
       Response(_: Oas3Response, { location }: UserContext) {
-        addComponentFromAbsoluteLocation(TYPE_NAME_RESPONSE, location.absolutePointer.toString());
+        addComponentFromAbsoluteLocation(TYPE_NAME_RESPONSE, location);
       },
     };
   }
@@ -97,7 +99,7 @@ export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
   if (options.parameters != 'off') {
     rule.NamedParameters = {
       Parameter(_: Oas3Parameter, { location }: UserContext) {
-        addComponentFromAbsoluteLocation(TYPE_NAME_PARAMETER, location.absolutePointer.toString());
+        addComponentFromAbsoluteLocation(TYPE_NAME_PARAMETER, location);
       },
     };
   }
@@ -105,10 +107,7 @@ export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
   if (options.requestBodies != 'off') {
     rule.NamedRequestBodies = {
       RequestBody(_: Oas3RequestBody, { location }: UserContext) {
-        addComponentFromAbsoluteLocation(
-          TYPE_NAME_REQUEST_BODY,
-          location.absolutePointer.toString()
-        );
+        addComponentFromAbsoluteLocation(TYPE_NAME_REQUEST_BODY, location);
       },
     };
   }
@@ -127,20 +126,23 @@ export const ComponentNameUnique: Oas3Rule | Oas2Rule = (options) => {
     return componentName;
   }
 
-  function addFoundComponent(
-    typeName: string,
-    componentName: string,
-    absoluteLocation: string
-  ): void {
+  function addFoundComponent(typeName: string, componentName: string, location: Location): void {
     const key = getKeyForComponent(typeName, componentName);
-    const locations = components.get(key) ?? new Set();
-    locations.add(absoluteLocation);
-    components.set(key, locations);
+    const entry: ComponentsMapValue = components.get(key) ?? {
+      absolutePointers: new Set(),
+      locations: [],
+    };
+    const absoluteLocation = location.absolutePointer.toString();
+    if (!entry.absolutePointers.has(absoluteLocation)) {
+      entry.absolutePointers.add(absoluteLocation);
+      entry.locations.push(location);
+    }
+    components.set(key, entry);
   }
 
-  function addComponentFromAbsoluteLocation(typeName: string, absoluteLocation: string): void {
-    const componentName = getComponentNameFromAbsoluteLocation(absoluteLocation);
-    addFoundComponent(typeName, componentName, absoluteLocation);
+  function addComponentFromAbsoluteLocation(typeName: string, location: Location): void {
+    const componentName = getComponentNameFromAbsoluteLocation(location.absolutePointer.toString());
+    addFoundComponent(typeName, componentName, location);
   }
 };