@redocly/openapi-core 1.8.2 → 1.9.1

package/src/__tests__/ref-utils.test.ts

@@ -96,6 +96,28 @@ describe('ref-utils', () => {
     expect(result).toMatchInlineSnapshot(`[]`);
   });
 
+  it('should parse a ref correctly', () => {
+    expect(parseRef('./info.yaml#/description')).toEqual({
+      uri: './info.yaml',
+      pointer: ['description'],
+    });
+  });
+
+  it('should parse a ref which contain a hash in the middle', () => {
+    // Here `info#description.md` is a file name
+    expect(parseRef('./info#description.md')).toEqual({
+      uri: './info#description.md',
+      pointer: [],
+    });
+  });
+
+  it('should parse a ref which ends with a hash', () => {
+    expect(parseRef('./info.yaml#')).toEqual({
+      uri: './info.yaml',
+      pointer: [],
+    });
+  });
+
   describe('refBaseName', () => {
     it('returns base name for file reference', () => {
       expect(refBaseName('../testcase/Pet.yaml')).toStrictEqual('Pet');

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -74,6 +74,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "no-invalid-parameter-examples": "off",
     "no-invalid-schema-examples": "off",
     "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
     "no-unresolved-refs": "error",
     "operation-2xx-response": "warn",
     "operation-4xx-response": "error",
@@ -198,6 +199,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "no-invalid-parameter-examples": "off",
     "no-invalid-schema-examples": "off",
     "no-path-trailing-slash": "error",
+    "no-required-schema-properties-undefined": "off",
     "no-unresolved-refs": "error",
     "operation-2xx-response": "error",
     "operation-4xx-response": "off",

package/src/config/__tests__/load.test.ts

@@ -137,6 +137,19 @@ describe('getConfig', () => {
           "severity": "warn",
           "suggest": [],
         },
+        {
+          "location": [
+            {
+              "pointer": "#/theme",
+              "reportOnKey": false,
+              "source": "fixtures/resolve-refs-in-config/config-with-refs.yaml",
+            },
+          ],
+          "message": "Can't resolve $ref: ENOENT: no such file or directory 'fixtures/resolve-refs-in-config/wrong-ref.yaml'",
+          "ruleId": "configuration no-unresolved-refs",
+          "severity": "warn",
+          "suggest": [],
+        },
         {
           "from": {
             "pointer": "#/rules",
@@ -154,19 +167,6 @@ describe('getConfig', () => {
           "severity": "warn",
           "suggest": [],
         },
-        {
-          "location": [
-            {
-              "pointer": "#/theme",
-              "reportOnKey": false,
-              "source": "fixtures/resolve-refs-in-config/config-with-refs.yaml",
-            },
-          ],
-          "message": "Can't resolve $ref: ENOENT: no such file or directory 'fixtures/resolve-refs-in-config/wrong-ref.yaml'",
-          "ruleId": "configuration no-unresolved-refs",
-          "severity": "warn",
-          "suggest": [],
-        },
       ]
     `);
   });

package/src/config/all.ts

@@ -43,6 +43,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'path-params-defined': 'error',
     'required-string-property-missing-min-length': 'error',
     'response-contains-header': 'error',
+    'no-required-schema-properties-undefined': 'error',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'error',

package/src/config/minimal.ts

@@ -40,6 +40,7 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'response-contains-header': 'off',
     'path-segment-plural': 'off',
     'scalar-property-missing-example': 'off',
+    'no-required-schema-properties-undefined': 'off',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'off',

package/src/config/recommended-strict.ts

@@ -40,6 +40,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'required-string-property-missing-min-length': 'off',
     'response-contains-header': 'off',
     'scalar-property-missing-example': 'off',
+    'no-required-schema-properties-undefined': 'off',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'off',

package/src/config/recommended.ts

@@ -40,6 +40,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'required-string-property-missing-min-length': 'off',
     'response-contains-header': 'off',
     'scalar-property-missing-example': 'off',
+    'no-required-schema-properties-undefined': 'off',
   },
   oas2Rules: {
     'boolean-parameter-prefixes': 'off',

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

@@ -1,8 +1,9 @@
-import type { Oas2Decorator } from '../../visitors';
 import { Location } from '../../ref-utils';
-import type { Oas2Components } from '../../typings/swagger';
 import { isEmptyObject } from '../../utils';
 
+import type { Oas2Decorator } from '../../visitors';
+import type { Oas2Components } from '../../typings/swagger';
+
 export const RemoveUnusedComponents: Oas2Decorator = () => {
   const components = new Map<
     string,

package/src/decorators/oas3/remove-unused-components.ts

@@ -1,8 +1,9 @@
-import type { Oas3Decorator } from '../../visitors';
 import { Location } from '../../ref-utils';
-import type { Oas3Components } from '../../typings/openapi';
 import { isEmptyObject } from '../../utils';
 
+import type { Oas3Decorator } from '../../visitors';
+import type { Oas3Components } from '../../typings/openapi';
+
 export const RemoveUnusedComponents: Oas3Decorator = () => {
   const components = new Map<
     string,

package/src/lint.ts

@@ -112,6 +112,7 @@ export async function lintConfig(opts: {
   resolvedRefMap?: ResolvedRefMap;
   severity?: ProblemSeverity;
   externalRefResolver?: BaseResolver;
+  externalConfigTypes?: Record<string, NodeType>;
 }) {
   const { document, severity, externalRefResolver = new BaseResolver() } = opts;
 
@@ -126,7 +127,7 @@ export async function lintConfig(opts: {
     rules: { spec: 'error' },
   });
 
-  const types = normalizeTypes(ConfigTypes, config);
+  const types = normalizeTypes(opts.externalConfigTypes || ConfigTypes, config);
   const rules: (RuleInstanceConfig & {
     visitor: NestedVisitObject<unknown, Oas3Visitor | Oas3Visitor[]>;
   })[] = [

package/src/ref-utils.ts

@@ -43,15 +43,15 @@ export function escapePointer<T extends string | number>(fragment: T): T {
 }
 
 export function parseRef(ref: string): { uri: string | null; pointer: string[] } {
-  const [uri, pointer] = ref.split('#/');
+  const [uri, pointer = ''] = ref.split('#/');
   return {
-    uri: uri || null,
-    pointer: pointer ? pointer.split('/').map(unescapePointer).filter(isTruthy) : [],
+    uri: (uri.endsWith('#') ? uri.slice(0, -1) : uri) || null,
+    pointer: parsePointer(pointer),
   };
 }
 
 export function parsePointer(pointer: string) {
-  return pointer.substr(2).split('/').map(unescapePointer);
+  return pointer.split('/').map(unescapePointer).filter(isTruthy);
 }
 
 export function pointerBaseName(pointer: string) {

package/src/resolve.ts

@@ -269,8 +269,20 @@ export async function resolveDocument(opts: {
         if (itemsType === undefined && type !== unknownType && type !== SpecExtension) {
           return;
         }
+        const isTypeAFunction = typeof itemsType === 'function';
         for (let i = 0; i < node.length; i++) {
-          walk(node[i], itemsType || unknownType, joinPointer(nodeAbsoluteRef, i));
+          const itemType = isTypeAFunction
+            ? itemsType(node[i], joinPointer(nodeAbsoluteRef, i))
+            : itemsType;
+          // we continue resolving unknown types, but stop early on known scalars
+          if (itemType === undefined && type !== unknownType && type !== SpecExtension) {
+            continue;
+          }
+          walk(
+            node[i],
+            isNamedType(itemType) ? itemType : unknownType,
+            joinPointer(nodeAbsoluteRef, i)
+          );
         }
         return;
       }