@redocly/openapi-core 1.0.0-beta.116 → 1.0.0-beta.118

package/lib/bundle.d.ts

@@ -44,4 +44,4 @@ export declare function bundleDocument(opts: {
     refTypes: Map<string, NormalizedNodeType> | undefined;
     visitorsData: Record<string, Record<string, unknown>>;
 }>;
-export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "links" | "callbacks" | "securitySchemes" | null;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;

package/lib/config/config-resolvers.js

@@ -64,14 +64,19 @@ function resolvePlugins(plugins, configPath = '') {
             return undefined;
         }
         if (utils_3.isString(plugin)) {
-            const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            return typeof __webpack_require__ === 'function'
-                ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                    // @ts-ignore
-                    __non_webpack_require__(absoltePluginPath)
-                : require(absoltePluginPath);
+            try {
+                const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                return typeof __webpack_require__ === 'function'
+                    ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        // @ts-ignore
+                        __non_webpack_require__(absoltePluginPath)
+                    : require(absoltePluginPath);
+            }
+            catch (e) {
+                throw new Error(`Failed to load plugin "${plugin}". Please provide a valid path`);
+            }
         }
         return plugin;
     };

package/lib/decorators/common/media-type-examples-override.d.ts

@@ -0,0 +1,2 @@
+import { Oas3Decorator } from '../../visitors';
+export declare const MediaTypeExamplesOverride: Oas3Decorator;

package/lib/decorators/common/media-type-examples-override.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaTypeExamplesOverride = void 0;
+const utils_1 = require("../../utils");
+const ref_utils_1 = require("../../ref-utils");
+const MediaTypeExamplesOverride = ({ operationIds }) => {
+    return {
+        Operation: {
+            enter(operation, ctx) {
+                const operationId = operation.operationId;
+                if (!operationId) {
+                    return;
+                }
+                const properties = operationIds[operationId];
+                if (!properties) {
+                    return;
+                }
+                if (properties.responses && operation.responses) {
+                    for (const responseCode of Object.keys(properties.responses)) {
+                        const resolvedResponse = checkAndResolveRef(operation.responses[responseCode], ctx.resolve);
+                        if (!resolvedResponse) {
+                            continue;
+                        }
+                        resolvedResponse.content = resolvedResponse.content ? resolvedResponse.content : {};
+                        Object.keys(properties.responses[responseCode]).forEach((mimeType) => {
+                            resolvedResponse.content[mimeType] = Object.assign(Object.assign({}, resolvedResponse.content[mimeType]), { examples: utils_1.yamlAndJsonSyncReader(properties.responses[responseCode][mimeType]) });
+                        });
+                        operation.responses[responseCode] = resolvedResponse;
+                    }
+                }
+                if (properties.request && operation.requestBody) {
+                    const resolvedRequest = checkAndResolveRef(operation.requestBody, ctx.resolve);
+                    if (!resolvedRequest) {
+                        return;
+                    }
+                    resolvedRequest.content = resolvedRequest.content ? resolvedRequest.content : {};
+                    Object.keys(properties.request).forEach((mimeType) => {
+                        resolvedRequest.content[mimeType] = Object.assign(Object.assign({}, resolvedRequest.content[mimeType]), { examples: utils_1.yamlAndJsonSyncReader(properties.request[mimeType]) });
+                    });
+                    operation.requestBody = resolvedRequest;
+                }
+            },
+        },
+    };
+};
+exports.MediaTypeExamplesOverride = MediaTypeExamplesOverride;
+function checkAndResolveRef(node, resolver) {
+    if (!ref_utils_1.isRef(node)) {
+        return node;
+    }
+    const resolved = resolver(node);
+    return resolved.error ? undefined : JSON.parse(JSON.stringify(resolved.node));
+}

package/lib/decorators/oas3/index.d.ts

@@ -7,4 +7,5 @@ export declare const decorators: {
     'remove-x-internal': Oas3Decorator;
     'filter-in': Oas3Decorator;
     'filter-out': Oas3Decorator;
+    'media-type-examples-override': Oas3Decorator;
 };

package/lib/decorators/oas3/index.js

@@ -8,6 +8,7 @@ const info_description_override_1 = require("../common/info-description-override
 const remove_x_internal_1 = require("../common/remove-x-internal");
 const filter_in_1 = require("../common/filters/filter-in");
 const filter_out_1 = require("../common/filters/filter-out");
+const media_type_examples_override_1 = require("../common/media-type-examples-override");
 exports.decorators = {
     'registry-dependencies': registry_dependencies_1.RegistryDependencies,
     'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
@@ -16,4 +17,5 @@ exports.decorators = {
     'remove-x-internal': remove_x_internal_1.RemoveXInternal,
     'filter-in': filter_in_1.FilterIn,
     'filter-out': filter_out_1.FilterOut,
+    'media-type-examples-override': media_type_examples_override_1.MediaTypeExamplesOverride,
 };

package/lib/index.d.ts

@@ -8,11 +8,11 @@ export type { Oas2Definition } from './typings/swagger';
 export type { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
-export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, } from './config';
+export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
 export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
 export { parseYaml, stringifyYaml } from './js-yaml';
-export { unescapePointer, isRef } from './ref-utils';
+export { unescapePointer, isRef, isAbsoluteUrl } from './ref-utils';
 export { detectOpenAPI, OasMajorVersion, openAPIMajor, OasVersion } from './oas-types';
 export { normalizeVisitors } from './visitors';
 export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject, Loc, } from './walk';

package/lib/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.mapTypeToComponent = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
@@ -45,6 +46,7 @@ Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: functio
 var ref_utils_1 = require("./ref-utils");
 Object.defineProperty(exports, "unescapePointer", { enumerable: true, get: function () { return ref_utils_1.unescapePointer; } });
 Object.defineProperty(exports, "isRef", { enumerable: true, get: function () { return ref_utils_1.isRef; } });
+Object.defineProperty(exports, "isAbsoluteUrl", { enumerable: true, get: function () { return ref_utils_1.isAbsoluteUrl; } });
 var oas_types_1 = require("./oas-types");
 Object.defineProperty(exports, "detectOpenAPI", { enumerable: true, get: function () { return oas_types_1.detectOpenAPI; } });
 Object.defineProperty(exports, "OasMajorVersion", { enumerable: true, get: function () { return oas_types_1.OasMajorVersion; } });

package/lib/resolve.js

@@ -221,6 +221,9 @@ function resolveDocument(opts) {
                         propType = propType(propValue, propName);
                     if (propType === undefined)
                         propType = unknownType;
+                    if (type.extensionsPrefix && propName.startsWith(type.extensionsPrefix)) {
+                        propType = types_1.SpecExtension;
+                    }
                     if (!types_1.isNamedType(propType) && (propType === null || propType === void 0 ? void 0 : propType.directResolveAs)) {
                         propType = propType.directResolveAs;
                         propValue = { $ref: propValue };

package/lib/rules/common/assertions/asserts.js

@@ -178,10 +178,18 @@ exports.asserts = {
             .filter(utils_1.isTruthy);
     },
     sortOrder: (value, condition, baseLocation) => {
-        if (typeof value === 'undefined' || utils_2.isOrdered(value, condition))
-            return [];
         const direction = condition.direction || condition;
         const property = condition.property;
+        if (Array.isArray(value) && value.length > 0 && typeof value[0] === 'object' && !property) {
+            return [
+                {
+                    message: `Please define a property to sort objects by`,
+                    location: baseLocation,
+                },
+            ];
+        }
+        if (typeof value === 'undefined' || utils_2.isOrdered(value, condition))
+            return [];
         return [
             {
                 message: `Should be sorted in ${direction === 'asc' ? 'an ascending' : 'a descending'} order${property ? ` by property ${property}` : ''}`,

package/lib/rules/common/assertions/utils.js

@@ -62,10 +62,10 @@ function applyAssertions(assertionDefinition, asserts, { rawLocation, rawNode, r
             }
         }
         else {
-            const value = assert.name === 'ref' ? rawNode : Object.keys(node);
+            const value = Array.isArray(node) ? node : Object.keys(node);
             assertResults.push(runAssertion({
-                values: Object.keys(node),
-                rawValues: value,
+                values: value,
+                rawValues: rawNode,
                 assert,
                 location: currentLocation,
             }));
@@ -187,11 +187,17 @@ function isOrdered(value, options) {
         let currValue = value[i];
         let prevVal = value[i - 1];
         if (property) {
-            if (!value[i][property] || !value[i - 1][property]) {
+            const currPropValue = value[i][property];
+            const prevPropValue = value[i - 1][property];
+            if (!currPropValue || !prevPropValue) {
                 return false; // property doesn't exist, so collection is not ordered
             }
-            currValue = value[i][property];
-            prevVal = value[i - 1][property];
+            currValue = currPropValue;
+            prevVal = prevPropValue;
+        }
+        if (typeof currValue === 'string' && typeof prevVal === 'string') {
+            currValue = currValue.toLowerCase();
+            prevVal = prevVal.toLowerCase();
         }
         const result = direction === 'asc' ? currValue >= prevVal : currValue <= prevVal;
         if (!result) {

package/lib/rules/common/spec.js

@@ -22,10 +22,13 @@ const OasSpec = () => {
                 return;
             }
             else if (nodeType !== 'object') {
-                report({
-                    message: `Expected type \`${type.name}\` (object) but got \`${nodeType}\``,
-                    from: refLocation,
-                });
+                if (type !== types_1.SpecExtension) {
+                    // do not validate unknown extensions structure
+                    report({
+                        message: `Expected type \`${type.name}\` (object) but got \`${nodeType}\``,
+                        from: refLocation,
+                    });
+                }
                 ignoreNextVisitorsOnNode();
                 return;
             }

package/lib/rules/oas3/spec-components-invalid-map-name.js

@@ -12,35 +12,56 @@ const SpecComponentsInvalidMapName = () => {
         }
     }
     return {
-        Components: {
+        NamedSchemas: {
+            Schema(_node, { key, report, location }) {
+                validateKey(key, report, location, 'schemas');
+            },
+        },
+        NamedParameters: {
             Parameter(_node, { key, report, location }) {
                 validateKey(key, report, location, 'parameters');
             },
+        },
+        NamedResponses: {
             Response(_node, { key, report, location }) {
                 validateKey(key, report, location, 'responses');
             },
-            Schema(_node, { key, report, location }) {
-                validateKey(key, report, location, 'schemas');
-            },
+        },
+        NamedExamples: {
             Example(_node, { key, report, location }) {
                 validateKey(key, report, location, 'examples');
             },
+        },
+        NamedRequestBodies: {
             RequestBody(_node, { key, report, location }) {
                 validateKey(key, report, location, 'requestBodies');
             },
+        },
+        NamedHeaders: {
             Header(_node, { key, report, location }) {
                 validateKey(key, report, location, 'headers');
             },
+        },
+        NamedSecuritySchemes: {
             SecurityScheme(_node, { key, report, location }) {
-                validateKey(key, report, location, 'securitySchemas');
+                validateKey(key, report, location, 'securitySchemes');
             },
+        },
+        NamedLinks: {
             Link(_node, { key, report, location }) {
                 validateKey(key, report, location, 'links');
             },
+        },
+        NamedCallbacks: {
             Callback(_node, { key, report, location }) {
                 validateKey(key, report, location, 'callbacks');
             },
         },
+        ExampleMap: {
+            Example(_node, { key, report, location }) {
+                validateKey(key, report, location, 'examples');
+            },
+        },
     };
 };
 exports.SpecComponentsInvalidMapName = SpecComponentsInvalidMapName;

package/lib/types/index.d.ts

@@ -49,6 +49,7 @@ export declare function mapOf(typeName: string): {
     properties: {};
     additionalProperties: () => string;
 };
+export declare const SpecExtension: NormalizedNodeType;
 export declare function normalizeTypes(types: Record<string, NodeType>, options?: {
     doNotResolveExamples?: boolean;
 }): Record<string, NormalizedNodeType>;

package/lib/types/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNamedType = exports.normalizeTypes = exports.mapOf = exports.listOf = void 0;
+exports.isNamedType = exports.normalizeTypes = exports.SpecExtension = exports.mapOf = exports.listOf = void 0;
 function listOf(typeName) {
     return {
         name: `${typeName}List`,
@@ -17,6 +17,10 @@ function mapOf(typeName) {
     };
 }
 exports.mapOf = mapOf;
+exports.SpecExtension = {
+    name: 'SpecExtension',
+    properties: {},
+};
 function normalizeTypes(types, options = {}) {
     const normalizedTypes = {};
     for (const typeName of Object.keys(types)) {
@@ -25,6 +29,8 @@ function normalizeTypes(types, options = {}) {
     for (const type of Object.values(normalizedTypes)) {
         normalizeType(type);
     }
+    // all type trees have a SpecExtension type by default
+    normalizedTypes['SpecExtension'] = exports.SpecExtension;
     return normalizedTypes;
     function normalizeType(type) {
         if (type.additionalProperties) {

package/lib/types/oas2.js

@@ -25,6 +25,7 @@ const Root = {
         'x-ignoredHeaderParameters': { type: 'array', items: { type: 'string' } },
     },
     required: ['swagger', 'paths', 'info'],
+    extensionsPrefix: 'x-',
 };
 const Info = {
     properties: {
@@ -37,6 +38,7 @@ const Info = {
         'x-logo': 'Logo',
     },
     required: ['title', 'version'],
+    extensionsPrefix: 'x-',
 };
 const Logo = {
     properties: {
@@ -45,6 +47,7 @@ const Logo = {
         backgroundColor: { type: 'string' },
         href: { type: 'string' },
     },
+    extensionsPrefix: 'x-',
 };
 const Contact = {
     properties: {
@@ -52,6 +55,7 @@ const Contact = {
         url: { type: 'string' },
         email: { type: 'string' },
     },
+    extensionsPrefix: 'x-',
 };
 const License = {
     properties: {
@@ -59,6 +63,7 @@ const License = {
         url: { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
 };
 const Paths = {
     properties: {},
@@ -76,6 +81,7 @@ const PathItem = {
         head: 'Operation',
         patch: 'Operation',
     },
+    extensionsPrefix: 'x-',
 };
 const Operation = {
     properties: {
@@ -94,9 +100,9 @@ const Operation = {
         'x-codeSamples': 'XCodeSampleList',
         'x-code-samples': 'XCodeSampleList',
         'x-hideTryItPanel': { type: 'boolean' },
-        'x-meta': 'XMetaList',
     },
     required: ['responses'],
+    extensionsPrefix: 'x-',
 };
 const XCodeSample = {
     properties: {
@@ -118,6 +124,7 @@ const ExternalDocs = {
         url: { type: 'string' },
     },
     required: ['url'],
+    extensionsPrefix: 'x-',
 };
 const Parameter = {
     properties: {
@@ -163,6 +170,7 @@ const Parameter = {
             }
         }
     },
+    extensionsPrefix: 'x-',
 };
 const ParameterItems = {
     properties: {
@@ -192,6 +200,7 @@ const ParameterItems = {
             return ['type'];
         }
     },
+    extensionsPrefix: 'x-',
 };
 const Responses = {
     properties: {
@@ -208,6 +217,7 @@ const Response = {
         'x-summary': { type: 'string' },
     },
     required: ['description'],
+    extensionsPrefix: 'x-',
 };
 const Examples = {
     properties: {},
@@ -242,6 +252,7 @@ const Header = {
             return ['type'];
         }
     },
+    extensionsPrefix: 'x-',
 };
 const Tag = {
     properties: {
@@ -252,6 +263,7 @@ const Tag = {
         'x-displayName': { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
 };
 const TagGroup = {
     properties: {
@@ -314,6 +326,7 @@ const Schema = {
         'x-explicitMappingOnly': { type: 'boolean' },
         'x-enumDescriptions': 'EnumDescriptions',
     },
+    extensionsPrefix: 'x-',
 };
 const EnumDescriptions = {
     properties: {},
@@ -331,6 +344,7 @@ const Xml = {
         attribute: { type: 'boolean' },
         wrapped: { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
 };
 const SecurityScheme = {
     properties: {
@@ -399,14 +413,7 @@ const Example = {
         description: { type: 'string' },
         externalValue: { type: 'string' },
     },
-};
-const XMeta = {
-    properties: {
-        title: { type: 'string' },
-        description: { type: 'string' },
-        keywords: { type: 'string' },
-        image: { type: 'string' },
-    },
+    extensionsPrefix: 'x-',
 };
 exports.Oas2Types = {
     Root,
@@ -444,8 +451,6 @@ exports.Oas2Types = {
     SecurityScheme,
     XCodeSample,
     XCodeSampleList: _1.listOf('XCodeSample'),
-    XMeta,
-    XMetaList: _1.listOf('XMeta'),
     XServerList: _1.listOf('XServer'),
     XServer,
 };