@redocly/openapi-core 1.0.0-beta.110 → 1.0.0-beta.112

package/lib/types/oas3.js

@@ -12,7 +12,7 @@ const Root = {
         security: _1.listOf('SecurityRequirement'),
         tags: _1.listOf('Tag'),
         externalDocs: 'ExternalDocs',
-        paths: 'PathsMap',
+        paths: 'Paths',
         components: 'Components',
         'x-webhooks': 'WebhooksMap',
     },
@@ -81,7 +81,7 @@ const License = {
     },
     required: ['name'],
 };
-const PathsMap = {
+const Paths = {
     properties: {},
     additionalProperties: (_value, key) => key.startsWith('/') ? 'PathItem' : undefined,
 };
@@ -141,7 +141,7 @@ const Operation = {
         security: _1.listOf('SecurityRequirement'),
         servers: _1.listOf('Server'),
         requestBody: 'RequestBody',
-        responses: 'ResponsesMap',
+        responses: 'Responses',
         deprecated: { type: 'boolean' },
         callbacks: 'CallbacksMap',
         'x-codeSamples': _1.listOf('XCodeSample'),
@@ -174,7 +174,7 @@ const MediaType = {
         schema: 'Schema',
         example: { isExample: true },
         examples: 'ExamplesMap',
-        encoding: 'EncodingsMap',
+        encoding: 'EncodingMap',
     },
 };
 const Example = {
@@ -214,7 +214,7 @@ const Header = {
     },
     requiredOneOf: ['schema', 'content'],
 };
-const ResponsesMap = {
+const Responses = {
     properties: { default: 'Response' },
     additionalProperties: (_v, key) => responseCodeRegexp.test(key) ? 'Response' : undefined,
 };
@@ -378,7 +378,7 @@ const AuthorizationCode = {
     },
     required: ['authorizationUrl', 'tokenUrl', 'scopes'],
 };
-const SecuritySchemeFlows = {
+const OAuth2Flows = {
     properties: {
         implicit: 'ImplicitFlow',
         password: 'PasswordFlow',
@@ -394,7 +394,7 @@ const SecurityScheme = {
         in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
-        flows: 'SecuritySchemeFlows',
+        flows: 'OAuth2Flows',
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {
@@ -438,7 +438,7 @@ exports.Oas3Types = {
     Info,
     Contact,
     License,
-    PathsMap,
+    Paths,
     PathItem,
     Parameter,
     Operation,
@@ -450,10 +450,10 @@ exports.Oas3Types = {
     Example,
     ExamplesMap: _1.mapOf('Example'),
     Encoding,
-    EncodingsMap: _1.mapOf('Encoding'),
+    EncodingMap: _1.mapOf('Encoding'),
     Header,
     HeadersMap: _1.mapOf('Header'),
-    ResponsesMap,
+    Responses,
     Response,
     Link,
     Schema,
@@ -476,7 +476,7 @@ exports.Oas3Types = {
     PasswordFlow,
     ClientCredentials,
     AuthorizationCode,
-    SecuritySchemeFlows,
+    OAuth2Flows,
     SecurityScheme,
     XCodeSample,
     WebhooksMap,

package/lib/types/oas3_1.js

@@ -11,7 +11,7 @@ const Root = {
         security: _1.listOf('SecurityRequirement'),
         tags: _1.listOf('Tag'),
         externalDocs: 'ExternalDocs',
-        paths: 'PathsMap',
+        paths: 'Paths',
         webhooks: 'WebhooksMap',
         components: 'Components',
         jsonSchemaDialect: { type: 'string' },
@@ -67,7 +67,7 @@ const Operation = {
         security: _1.listOf('SecurityRequirement'),
         servers: _1.listOf('Server'),
         requestBody: 'RequestBody',
-        responses: 'ResponsesMap',
+        responses: 'Responses',
         deprecated: { type: 'boolean' },
         callbacks: _1.mapOf('Callback'),
         'x-codeSamples': _1.listOf('XCodeSample'),
@@ -175,7 +175,7 @@ const SecurityScheme = {
         in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
-        flows: 'SecuritySchemeFlows',
+        flows: 'OAuth2Flows',
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {

package/lib/types/redocly-yaml.js

@@ -5,7 +5,6 @@ const _1 = require(".");
 const utils_1 = require("../utils");
 const builtInRulesList = [
     'spec',
-    'info-description',
     'info-contact',
     'info-license',
     'info-license-url',
@@ -68,7 +67,7 @@ const nodeTypesList = [
     'Info',
     'Contact',
     'License',
-    'PathsMap',
+    'Paths',
     'PathItem',
     'Parameter',
     'Operation',
@@ -80,10 +79,10 @@ const nodeTypesList = [
     'Example',
     'ExamplesMap',
     'Encoding',
-    'EncodingsMap',
+    'EncodingMap',
     'Header',
     'HeadersMap',
-    'ResponsesMap',
+    'Responses',
     'Response',
     'Link',
     'LinksMap',
@@ -106,7 +105,7 @@ const nodeTypesList = [
     'PasswordFlow',
     'ClientCredentials',
     'AuthorizationCode',
-    'SecuritySchemeFlows',
+    'OAuth2Flows',
     'SecurityScheme',
     'XCodeSample',
     'WebhooksMap',
@@ -140,11 +139,7 @@ const RootConfigStyleguide = {
         } }, ConfigStyleguide.properties),
 };
 const ConfigRoot = {
-    properties: Object.assign(Object.assign({ organization: { type: 'string' }, apis: 'ConfigApis', apiDefinitions: {
-            type: 'object',
-            properties: {},
-            additionalProperties: { properties: { type: 'string' } },
-        } }, RootConfigStyleguide.properties), { styleguide: 'RootConfigStyleguide', lint: 'RootConfigStyleguide', 'features.openapi': 'ConfigReferenceDocs', referenceDocs: 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', region: { enum: ['us', 'eu'] }, resolve: {
+    properties: Object.assign(Object.assign({ organization: { type: 'string' }, apis: 'ConfigApis' }, RootConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', region: { enum: ['us', 'eu'] }, resolve: {
             properties: {
                 http: 'ConfigHTTP',
                 doNotResolveExamples: { type: 'boolean' },
@@ -209,16 +204,9 @@ const ObjectRule = {
     additionalProperties: {},
     required: ['severity'],
 };
-const Assert = {
+const AssertionDefinitionSubject = {
     properties: {
-        subject: (value) => {
-            if (Array.isArray(value)) {
-                return { type: 'array', items: { enum: nodeTypesList } };
-            }
-            else {
-                return { enum: nodeTypesList };
-            }
-        },
+        type: { enum: nodeTypesList },
         property: (value) => {
             if (Array.isArray(value)) {
                 return { type: 'array', items: { type: 'string' } };
@@ -230,10 +218,14 @@ const Assert = {
                 return { type: 'string' };
             }
         },
-        context: _1.listOf('Context'),
-        message: { type: 'string' },
-        suggest: { type: 'array', items: { type: 'string' } },
-        severity: { enum: ['error', 'warn', 'off'] },
+        filterInParentKeys: { type: 'array', items: { type: 'string' } },
+        filterOutParentKeys: { type: 'array', items: { type: 'string' } },
+        matchParentKeys: { type: 'string' },
+    },
+    required: ['type'],
+};
+const AssertionDefinitionAssertions = {
+    properties: {
         enum: { type: 'array', items: { type: 'string' } },
         pattern: { type: 'string' },
         casing: {
@@ -253,26 +245,49 @@ const Assert = {
         requireAny: { type: 'array', items: { type: 'string' } },
         disallowed: { type: 'array', items: { type: 'string' } },
         defined: { type: 'boolean' },
-        undefined: { type: 'boolean' },
+        // undefined: { type: 'boolean' }, // TODO: Remove `undefined` assertion from codebase overall
         nonEmpty: { type: 'boolean' },
         minLength: { type: 'integer' },
         maxLength: { type: 'integer' },
         ref: (value) => typeof value === 'string' ? { type: 'string' } : { type: 'boolean' },
+        const: (value) => {
+            if (typeof value === 'string') {
+                return { type: 'string' };
+            }
+            if (typeof value === 'number') {
+                return { type: 'number' };
+            }
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return;
+            }
+        },
     },
     additionalProperties: (_value, key) => {
         if (/^\w+\/\w+$/.test(key))
             return { type: 'object' };
         return;
     },
-    required: ['subject'],
 };
-const Context = {
+const AssertDefinition = {
     properties: {
-        type: { enum: nodeTypesList },
-        matchParentKeys: { type: 'array', items: { type: 'string' } },
-        excludeParentKeys: { type: 'array', items: { type: 'string' } },
+        subject: 'AssertionDefinitionSubject',
+        assertions: 'AssertionDefinitionAssertions',
     },
-    required: ['type'],
+    required: ['subject', 'assertions'],
+};
+const Assert = {
+    properties: {
+        subject: 'AssertionDefinitionSubject',
+        assertions: 'AssertionDefinitionAssertions',
+        where: _1.listOf('AssertDefinition'),
+        message: { type: 'string' },
+        suggest: { type: 'array', items: { type: 'string' } },
+        severity: { enum: ['error', 'warn', 'off'] },
+    },
+    required: ['subject', 'assertions'],
 };
 const ConfigLanguage = {
     properties: {
@@ -758,6 +773,16 @@ const ConfigReferenceDocs = {
         unstable_externalDescription: { type: 'boolean' },
         unstable_ignoreMimeParameters: { type: 'boolean' },
         untrustedDefinition: { type: 'boolean' },
+        mockServer: {
+            properties: {
+                url: { type: 'string' },
+                position: { enum: ['first', 'last', 'replace', 'off'] },
+                description: { type: 'string' },
+            },
+        },
+        showAccessMode: { type: 'boolean' },
+        preserveOriginalExtensionsName: { type: 'boolean' },
+        markdownHeadingsAnchorLevel: { type: 'number' },
     },
     additionalProperties: { type: 'string' },
 };
@@ -782,7 +807,7 @@ exports.ConfigTypes = {
     ConfigSidebarLinks,
     CommonConfigSidebarLinks,
     ConfigTheme,
-    Context,
+    AssertDefinition,
     ThemeColors,
     CommonThemeColors,
     BorderThemeColors,
@@ -829,4 +854,6 @@ exports.ConfigTypes = {
     Sidebar,
     Heading,
     Typography,
+    AssertionDefinitionAssertions,
+    AssertionDefinitionSubject,
 };

package/lib/utils.d.ts

@@ -46,3 +46,5 @@ export declare function showErrorForDeprecatedField(deprecatedField: string, upd
 export declare type Falsy = undefined | null | false | '' | 0;
 export declare function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy;
 export declare function identity<T>(value: T): T;
+export declare function keysOf<T>(obj: T): (keyof T)[];
+export declare function pickDefined<T extends Record<string, unknown>>(obj?: T): Record<string, unknown> | undefined;

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const minimatch = require("minimatch");
@@ -205,3 +205,21 @@ function identity(value) {
     return value;
 }
 exports.identity = identity;
+function keysOf(obj) {
+    if (!obj)
+        return [];
+    return Object.keys(obj);
+}
+exports.keysOf = keysOf;
+function pickDefined(obj) {
+    if (!obj)
+        return undefined;
+    const res = {};
+    for (const key in obj) {
+        if (obj[key] !== undefined) {
+            res[key] = obj[key];
+        }
+    }
+    return res;
+}
+exports.pickDefined = pickDefined;

package/lib/visitors.d.ts

@@ -4,11 +4,12 @@ import type { NormalizedNodeType } from './types';
 import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
+export declare type SkipFunctionContext = Pick<UserContext, 'location' | 'rawNode' | 'resolve' | 'rawLocation'>;
 export declare type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
 }, parents?: any, context?: any) => void;
 declare type VisitRefFunction = (node: OasRef, ctx: UserContext, resolved: ResolveResult<any>) => void;
-declare type SkipFunction<T> = (node: T, key: string | number) => boolean;
+declare type SkipFunction<T> = (node: T, key: string | number, ctx: SkipFunctionContext) => boolean;
 declare type VisitObject<T> = {
     enter?: VisitFunction<T>;
     leave?: VisitFunction<T>;
@@ -70,9 +71,10 @@ declare type Oas3FlatVisitor = {
     Info?: VisitFunctionOrObject<Oas3Info>;
     Contact?: VisitFunctionOrObject<Oas3Contact>;
     License?: VisitFunctionOrObject<Oas3License>;
-    PathsMap?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
+    Paths?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
     PathItem?: VisitFunctionOrObject<Oas3PathItem>;
-    Callback?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
+    Callback?: VisitFunctionOrObject<Oas3Callback>;
+    CallbacksMap?: VisitFunctionOrObject<Record<string, Oas3Callback>>;
     Parameter?: VisitFunctionOrObject<Oas3Parameter>;
     Operation?: VisitFunctionOrObject<Oas3Operation>;
     RequestBody?: VisitFunctionOrObject<Oas3RequestBody>;
@@ -81,7 +83,7 @@ declare type Oas3FlatVisitor = {
     Example?: VisitFunctionOrObject<Oas3Example>;
     Encoding?: VisitFunctionOrObject<Oas3Encoding>;
     Header?: VisitFunctionOrObject<Oas3Header>;
-    ResponsesMap?: VisitFunctionOrObject<Record<string, Oas3Response>>;
+    Responses?: VisitFunctionOrObject<Record<string, Oas3Response>>;
     Response?: VisitFunctionOrObject<Oas3Response>;
     Link?: VisitFunctionOrObject<Oas3Link>;
     Schema?: VisitFunctionOrObject<Oas3Schema>;
@@ -103,7 +105,7 @@ declare type Oas3FlatVisitor = {
     PasswordFlow?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['password']>;
     ClientCredentials?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['clientCredentials']>;
     AuthorizationCode?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['authorizationCode']>;
-    SecuritySchemeFlows?: VisitFunctionOrObject<Oas3SecurityScheme['flows']>;
+    OAuth2Flows?: VisitFunctionOrObject<Oas3SecurityScheme['flows']>;
     SecurityScheme?: VisitFunctionOrObject<Oas3SecurityScheme>;
 };
 declare type Oas2FlatVisitor = {
@@ -114,13 +116,13 @@ declare type Oas2FlatVisitor = {
     Info?: VisitFunctionOrObject<Oas2Info>;
     Contact?: VisitFunctionOrObject<Oas2Contact>;
     License?: VisitFunctionOrObject<Oas2License>;
-    PathsMap?: VisitFunctionOrObject<Record<string, Oas2PathItem>>;
+    Paths?: VisitFunctionOrObject<Record<string, Oas2PathItem>>;
     PathItem?: VisitFunctionOrObject<Oas2PathItem>;
     Parameter?: VisitFunctionOrObject<any>;
     Operation?: VisitFunctionOrObject<Oas2Operation>;
     Examples?: VisitFunctionOrObject<Record<string, any>>;
     Header?: VisitFunctionOrObject<Oas2Header>;
-    ResponsesMap?: VisitFunctionOrObject<Record<string, Oas2Response>>;
+    Responses?: VisitFunctionOrObject<Record<string, Oas2Response>>;
     Response?: VisitFunctionOrObject<Oas2Response>;
     Schema?: VisitFunctionOrObject<Oas2Schema>;
     Xml?: VisitFunctionOrObject<Oas2Xml>;

package/lib/visitors.js

@@ -4,13 +4,15 @@ exports.normalizeVisitors = void 0;
 const legacyTypesMap = {
     Root: 'DefinitionRoot',
     ServerVariablesMap: 'ServerVariableMap',
-    PathsMap: 'PathMap',
+    Paths: ['PathMap', 'PathsMap'],
     CallbacksMap: 'CallbackMap',
     MediaTypesMap: 'MediaTypeMap',
     ExamplesMap: 'ExampleMap',
-    EncodingsMap: 'EncodingMap',
+    EncodingMap: 'EncodingsMap',
     HeadersMap: 'HeaderMap',
     LinksMap: 'LinkMap',
+    OAuth2Flows: 'SecuritySchemeFlows',
+    Responses: 'ResponsesMap',
 };
 function normalizeVisitors(visitorsConfig, types) {
     const normalizedVisitors = {};
@@ -85,6 +87,13 @@ function normalizeVisitors(visitorsConfig, types) {
             }
         }
     }
+    function findLegacyVisitorNode(visitor, typeName) {
+        if (Array.isArray(typeName)) {
+            const name = typeName.find((name) => visitor[name]) || undefined;
+            return name && visitor[name];
+        }
+        return visitor[typeName];
+    }
     function normalizeVisitorLevel(ruleConf, visitor, parentContext, depth = 0) {
         const visitorKeys = Object.keys(types);
         if (depth === 0) {
@@ -101,7 +110,7 @@ function normalizeVisitors(visitorsConfig, types) {
         }
         for (const typeName of visitorKeys) {
             const typeVisitor = (visitor[typeName] ||
-                visitor[legacyTypesMap[typeName]]);
+                findLegacyVisitorNode(visitor, legacyTypesMap[typeName]));
             const normalizedTypeVisitor = normalizedVisitors[typeName];
             if (!typeVisitor)
                 continue;

package/lib/walk.js

@@ -112,7 +112,13 @@ function walkDocument(opts) {
                             location: resolvedLocation,
                             nextLevelTypeActivated: null,
                             withParentNode: (_g = (_f = context.parent) === null || _f === void 0 ? void 0 : _f.activatedOn) === null || _g === void 0 ? void 0 : _g.value.node,
-                            skipped: (_k = (((_j = (_h = context.parent) === null || _h === void 0 ? void 0 : _h.activatedOn) === null || _j === void 0 ? void 0 : _j.value.skipped) || (skip === null || skip === void 0 ? void 0 : skip(resolvedNode, key)))) !== null && _k !== void 0 ? _k : false,
+                            skipped: (_k = (((_j = (_h = context.parent) === null || _h === void 0 ? void 0 : _h.activatedOn) === null || _j === void 0 ? void 0 : _j.value.skipped) ||
+                                (skip === null || skip === void 0 ? void 0 : skip(resolvedNode, key, {
+                                    location,
+                                    rawLocation,
+                                    resolve,
+                                    rawNode: node,
+                                })))) !== null && _k !== void 0 ? _k : false,
                         };
                         context.activatedOn = utils_1.pushStack(context.activatedOn, activatedOn);
                         let ctx = context.parent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.110",
+  "version": "1.0.0-beta.112",
   "description": "",
   "main": "lib/index.js",
   "engines": {

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -94,7 +94,7 @@ rootType:
       name: ExternalDocs
     paths:
       properties: {}
-      name: PathsMap
+      name: Paths
     components:
       properties:
         parameters:

package/src/__tests__/lint.test.ts

@@ -61,11 +61,13 @@ describe('lint', () => {
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
           assert/operation-summary-length:
-            subject: Operation
-            property: summary
+            subject: 
+              type: Operation
+              property: summary
             message: Operation summary should start with an active verb
-            local/checkWordsCount: 
-              min: 3
+            assertions:
+              local/checkWordsCount: 
+                min: 3
       features.openapi:
         showConsole: true
         layout:
@@ -247,7 +249,24 @@ describe('lint', () => {
     );
     const results = await lintConfig({ document });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/referenceDocs",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`referenceDocs\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
   });
 
   it("'plugins' shouldn't be allowed in 'apis'", async () => {

package/src/__tests__/utils.test.ts

@@ -4,6 +4,7 @@ import {
   slash,
   getMatchingStatusCodeRange,
   doesYamlFileExist,
+  pickDefined,
 } from '../utils';
 import { isBrowser } from '../env';
 import * as fs from 'fs';
@@ -81,6 +82,16 @@ describe('utils', () => {
     });
   });
 
+  describe('pickDefined', () => {
+    it('returns undefined for undefined', () => {
+      expect(pickDefined(undefined)).toBeUndefined();
+    });
+
+    it('picks only defined values', () => {
+      expect(pickDefined({ a: 1, b: undefined, c: 3 })).toStrictEqual({ a: 1, c: 3 });
+    });
+  });
+
   describe('getMatchingStatusCodeRange', () => {
     it('should get the generalized form of status codes', () => {
       expect(getMatchingStatusCodeRange('202')).toEqual('2XX');

package/src/__tests__/walk.test.ts

@@ -1115,7 +1115,7 @@ describe('walk order', () => {
     expect(calls).toMatchInlineSnapshot(`
       Array [
         "enter Root",
-        "enter PathsMap",
+        "enter Paths",
         "enter PathItem",
         "enter ParameterList",
         "enter Parameter",
@@ -1134,7 +1134,7 @@ describe('walk order', () => {
         "leave ParameterList",
         "leave Operation",
         "leave PathItem",
-        "leave PathsMap",
+        "leave Paths",
         "enter Components",
         "enter NamedParameters",
         "leave NamedParameters",

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

@@ -39,7 +39,6 @@ Object {
     "assertions": "warn",
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
-    "info-description": "warn",
     "info-license": "warn",
     "info-license-url": "warn",
     "local/operation-id-not-test": "error",
@@ -73,7 +72,7 @@ Object {
 }
 `;
 
-exports[`resolveStyleguideConfig should resolve extends with local file config witch contains path to nested config 1`] = `
+exports[`resolveStyleguideConfig should resolve extends with local file config which contains path to nested config 1`] = `
 Object {
   "decorators": Object {},
   "doNotResolveExamples": undefined,
@@ -129,7 +128,6 @@ Object {
     ],
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
-    "info-description": "warn",
     "info-license": "warn",
     "info-license-url": "warn",
     "local/operation-id-not-test": "error",

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

@@ -1,5 +1,5 @@
 import { colorize } from '../../logger';
-import { asserts } from '../../rules/common/assertions/asserts';
+import { Asserts, asserts } from '../../rules/common/assertions/asserts';
 import { resolveStyleguideConfig, resolveApis, resolveConfig } from '../config-resolvers';
 const path = require('path');
 
@@ -100,7 +100,7 @@ describe('resolveStyleguideConfig', () => {
     }).toThrow('Circular dependency in config file');
   });
 
-  it('should resolve extends with local file config witch contains path to nested config', async () => {
+  it('should resolve extends with local file config which contains path to nested config', async () => {
     const styleguideConfig = {
       extends: ['local-config-with-file.yaml'],
     };
@@ -143,7 +143,7 @@ describe('resolveStyleguideConfig', () => {
 
     expect(plugins).toBeDefined();
     expect(plugins?.length).toBe(2);
-    expect(asserts['test-plugin/checkWordsCount']).toBeDefined();
+    expect(asserts['test-plugin/checkWordsCount' as keyof Asserts]).toBeDefined();
   });
 
   it('should throw error when custom assertion load not exist plugin', async () => {
@@ -163,7 +163,7 @@ describe('resolveStyleguideConfig', () => {
       );
     }
 
-    expect(asserts['test-plugin/checkWordsCount']).toBeDefined();
+    expect(asserts['test-plugin/checkWordsCount' as keyof Asserts]).toBeDefined();
   });
 
   it('should correctly merge assertions from nested config', async () => {
@@ -197,7 +197,7 @@ describe('resolveStyleguideConfig', () => {
     ]);
   });
 
-  it('should resolve extends with url file config witch contains path to nested config', async () => {
+  it('should resolve extends with url file config which contains path to nested config', async () => {
     const styleguideConfig = {
       // This points to ./fixtures/resolve-remote-configs/remote-config.yaml
       extends: [
@@ -464,4 +464,29 @@ describe('resolveConfig', () => {
     delete apis['petstore'].styleguide.pluginPaths;
     expect(apis['petstore'].styleguide).toMatchSnapshot();
   });
+
+  it('should default to the extends from the main config if no extends defined', async () => {
+    const rawConfig: RawConfig = {
+      apis: {
+        petstore: {
+          root: 'some/path',
+          styleguide: {
+            rules: {
+              'operation-4xx-response': 'error',
+            },
+          },
+        },
+      },
+      styleguide: {
+        extends: ['minimal'],
+        rules: {
+          'operation-2xx-response': 'warn',
+        },
+      },
+    };
+
+    const { apis } = await resolveConfig(rawConfig, configPath);
+    expect(apis['petstore'].styleguide.rules).toBeDefined();
+    expect(apis['petstore'].styleguide.rules?.['operation-2xx-response']).toEqual('warn'); // from minimal ruleset
+  });
 });

package/src/config/__tests__/fixtures/load-redocly.yaml

@@ -0,0 +1,4 @@
+lint:
+  rules:
+    info-contact: warn
+  extends: []