@redocly/openapi-core 1.0.0-beta.77 → 1.0.0-beta.81

package/lib/rules/oas3/no-invalid-media-type-examples.js

@@ -13,22 +13,23 @@ const ValidContentExamples = (opts) => {
                 if (!mediaType.schema)
                     return;
                 if (mediaType.example) {
-                    utils_1.validateExample(mediaType.example, mediaType.schema, location.child('example'), ctx, disallowAdditionalProperties);
+                    resolveAndValidateExample(mediaType.example, location.child('example'));
                 }
                 else if (mediaType.examples) {
                     for (const exampleName of Object.keys(mediaType.examples)) {
-                        let example = mediaType.examples[exampleName];
-                        let dataLoc = location.child(['examples', exampleName, 'value']);
-                        if (ref_utils_1.isRef(example)) {
-                            const resolved = resolve(example);
-                            if (!resolved.location)
-                                continue;
-                            dataLoc = resolved.location.child('value');
-                            example = resolved.node;
-                        }
-                        utils_1.validateExample(example.value, mediaType.schema, dataLoc, ctx, disallowAdditionalProperties);
+                        resolveAndValidateExample(mediaType.examples[exampleName], location.child(['examples', exampleName, 'value']), true);
                     }
                 }
+                function resolveAndValidateExample(example, location, isMultiple) {
+                    if (ref_utils_1.isRef(example)) {
+                        const resolved = resolve(example);
+                        if (!resolved.location)
+                            return;
+                        location = isMultiple ? resolved.location.child('value') : resolved.location;
+                        example = resolved.node;
+                    }
+                    utils_1.validateExample(isMultiple ? example.value : example, mediaType.schema, location, ctx, disallowAdditionalProperties);
+                }
             },
         },
     };

package/lib/rules/oas3/remove-unused-components.d.ts

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

package/lib/rules/oas3/remove-unused-components.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveUnusedComponents = void 0;
+const utils_1 = require("../../utils");
+const RemoveUnusedComponents = () => {
+    let components = new Map();
+    function registerComponent(location, componentType, name) {
+        var _a;
+        components.set(location.absolutePointer, {
+            used: ((_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.used) || false,
+            componentType,
+            name,
+        });
+    }
+    return {
+        ref: {
+            leave(ref, { type, resolve, key }) {
+                if (['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(type.name)) {
+                    const resolvedRef = resolve(ref);
+                    if (!resolvedRef.location)
+                        return;
+                    components.set(resolvedRef.location.absolutePointer, {
+                        used: true,
+                        name: key.toString(),
+                    });
+                }
+            }
+        },
+        DefinitionRoot: {
+            leave(root, ctx) {
+                const data = ctx.getVisitorData();
+                data.removedCount = 0;
+                components.forEach(usageInfo => {
+                    const { used, componentType, name } = usageInfo;
+                    if (!used && componentType) {
+                        let componentChild = root.components[componentType];
+                        delete componentChild[name];
+                        data.removedCount++;
+                        if (utils_1.isEmptyObject(componentChild)) {
+                            delete root.components[componentType];
+                        }
+                    }
+                });
+                if (utils_1.isEmptyObject(root.components)) {
+                    delete root.components;
+                }
+            },
+        },
+        NamedSchemas: {
+            Schema(schema, { location, key }) {
+                if (!schema.allOf) {
+                    registerComponent(location, 'schemas', key.toString());
+                }
+            },
+        },
+        NamedParameters: {
+            Parameter(_parameter, { location, key }) {
+                registerComponent(location, 'parameters', key.toString());
+            },
+        },
+        NamedResponses: {
+            Response(_response, { location, key }) {
+                registerComponent(location, 'responses', key.toString());
+            },
+        },
+        NamedExamples: {
+            Example(_example, { location, key }) {
+                registerComponent(location, 'examples', key.toString());
+            },
+        },
+        NamedRequestBodies: {
+            RequestBody(_requestBody, { location, key }) {
+                registerComponent(location, 'requestBodies', key.toString());
+            },
+        },
+        NamedHeaders: {
+            Header(_header, { location, key }) {
+                registerComponent(location, 'headers', key.toString());
+            },
+        },
+    };
+};
+exports.RemoveUnusedComponents = RemoveUnusedComponents;

package/lib/types/index.d.ts

@@ -22,6 +22,8 @@ export declare type NodeType = {
     items?: string;
     required?: string[] | ((value: any, key: string | number | undefined) => string[]);
     requiredOneOf?: string[];
+    allowed?: ((value: any) => string[] | undefined);
+    extensionsPrefix?: string;
 };
 declare type PropType = string | NodeType | ScalarSchema | undefined | null;
 declare type ResolveTypeFn = (value: any, key: string) => string | PropType;
@@ -32,6 +34,8 @@ export declare type NormalizedNodeType = {
     items?: NormalizedNodeType;
     required?: string[] | ((value: any, key: string | number | undefined) => string[]);
     requiredOneOf?: string[];
+    allowed?: ((value: any) => string[] | undefined);
+    extensionsPrefix?: string;
 };
 declare type NormalizedPropType = NormalizedNodeType | NormalizedScalarSchema | undefined | null;
 declare type NormalizedResolveTypeFn = (value: any, key: string) => NormalizedNodeType | NormalizedScalarSchema | undefined | null;

package/lib/types/oas2.js

@@ -68,9 +68,7 @@ const PathItem = {
 const Operation = {
     properties: {
         tags: { type: 'array', items: { type: 'string' } },
-        summary: {
-            type: 'string',
-        },
+        summary: { type: 'string' },
         description: { type: 'string' },
         externalDocs: 'ExternalDocs',
         operationId: { type: 'string' },
@@ -180,9 +178,7 @@ const ResponsesMap = {
 };
 const Response = {
     properties: {
-        description: {
-            type: 'string',
-        },
+        description: { type: 'string' },
         schema: 'Schema',
         headers: _1.mapOf('Header'),
         examples: 'Examples',
@@ -299,44 +295,55 @@ const SecurityScheme = {
         type: { enum: ['basic', 'apiKey', 'oauth2'] },
         description: { type: 'string' },
         name: { type: 'string' },
-        in: { type: 'string', enum: ['query', 'header', 'cookie'] },
+        in: { type: 'string', enum: ['query', 'header'] },
         flow: { enum: ['implicit', 'password', 'application', 'accessCode'] },
         authorizationUrl: { type: 'string' },
         tokenUrl: { type: 'string' },
         scopes: { type: 'object', additionalProperties: { type: 'string' } },
     },
     required(value) {
-        if (!(value === null || value === void 0 ? void 0 : value.type)) {
-            return ['type'];
-        }
-        if (value.type === 'apiKey') {
-            return ['type', 'name', 'in'];
-        }
-        else if (value.type === 'http') {
-            return ['type', 'scheme'];
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in'];
+            case 'oauth2':
+                switch (value === null || value === void 0 ? void 0 : value.flow) {
+                    case 'implicit':
+                        return ['type', 'flow', 'authorizationUrl', 'scopes'];
+                    case 'accessCode':
+                        return ['type', 'flow', 'authorizationUrl', 'tokenUrl', 'scopes'];
+                    case 'application':
+                    case 'password':
+                        return ['type', 'flow', 'tokenUrl', 'scopes'];
+                    default:
+                        return ['type', 'flow', 'scopes'];
+                }
+            default:
+                return ['type'];
         }
-        else if (value.type === 'oauth2') {
-            if (!(value === null || value === void 0 ? void 0 : value.flow)) {
-                return ['type', 'flow'];
-            }
-            else if (value.flow === 'implicit') {
-                return ['type', 'flow', 'authorizationUrl'];
-            }
-            else if (value.flow === 'accessCode') {
-                return ['type', 'flow', 'authorizationUrl', 'tokenUrl'];
-            }
-            else if (value.flow === 'application') {
-                return ['type', 'flow', 'tokenUrl'];
-            }
-            else if (value.flow === 'password') {
-                return ['type', 'flow', 'tokenUrl'];
-            }
-            else {
-                return ['type', 'flow'];
-            }
+    },
+    allowed(value) {
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'basic':
+                return ['type', 'description'];
+            case 'apiKey':
+                return ['type', 'name', 'in', 'description'];
+            case 'oauth2':
+                switch (value === null || value === void 0 ? void 0 : value.flow) {
+                    case 'implicit':
+                        return ['type', 'flow', 'authorizationUrl', 'description', 'scopes'];
+                    case 'accessCode':
+                        return ['type', 'flow', 'authorizationUrl', 'tokenUrl', 'description', 'scopes'];
+                    case 'application':
+                    case 'password':
+                        return ['type', 'flow', 'tokenUrl', 'description', 'scopes'];
+                    default:
+                        return ['type', 'flow', 'tokenUrl', 'authorizationUrl', 'description', 'scopes'];
+                }
+            default:
+                return ['type', 'description'];
         }
-        return ['type'];
     },
+    extensionsPrefix: 'x-',
 };
 const SecurityRequirement = {
     properties: {},

package/lib/types/oas3.js

@@ -28,23 +28,15 @@ const Tag = {
 };
 const ExternalDocs = {
     properties: {
-        description: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
+        description: { type: 'string' },
+        url: { type: 'string' },
     },
     required: ['url'],
 };
 const Server = {
     properties: {
-        url: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
+        url: { type: 'string' },
+        description: { type: 'string' },
         variables: _1.mapOf('ServerVariable'),
     },
     required: ['url'],
@@ -55,9 +47,7 @@ const ServerVariable = {
             type: 'array',
             items: { type: 'string' },
         },
-        default: {
-            type: 'string',
-        },
+        default: { type: 'string' },
         description: null,
     },
     required: ['default'],
@@ -68,18 +58,10 @@ const SecurityRequirement = {
 };
 const Info = {
     properties: {
-        title: {
-            type: 'string',
-        },
-        version: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
-        termsOfService: {
-            type: 'string',
-        },
+        title: { type: 'string' },
+        version: { type: 'string' },
+        description: { type: 'string' },
+        termsOfService: { type: 'string' },
         contact: 'Contact',
         license: 'License',
     },
@@ -87,25 +69,15 @@ const Info = {
 };
 const Contact = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
-        email: {
-            type: 'string',
-        },
+        name: { type: 'string' },
+        url: { type: 'string' },
+        email: { type: 'string' },
     },
 };
 const License = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
+        name: { type: 'string' },
+        url: { type: 'string' },
     },
     required: ['name'],
 };
@@ -122,12 +94,8 @@ const PathItem = {
         $ref: { type: 'string' },
         servers: _1.listOf('Server'),
         parameters: _1.listOf('Parameter'),
-        summary: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
+        summary: { type: 'string' },
+        description: { type: 'string' },
         get: 'Operation',
         put: 'Operation',
         post: 'Operation',
@@ -140,33 +108,17 @@ const PathItem = {
 };
 const Parameter = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        in: {
-            enum: ['query', 'header', 'path', 'cookie'],
-        },
-        description: {
-            type: 'string',
-        },
-        required: {
-            type: 'boolean',
-        },
-        deprecated: {
-            type: 'boolean',
-        },
-        allowEmptyValue: {
-            type: 'boolean',
-        },
+        name: { type: 'string' },
+        in: { enum: ['query', 'header', 'path', 'cookie'] },
+        description: { type: 'string' },
+        required: { type: 'boolean' },
+        deprecated: { type: 'boolean' },
+        allowEmptyValue: { type: 'boolean' },
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
-        explode: {
-            type: 'boolean',
-        },
-        allowReserved: {
-            type: 'boolean',
-        },
+        explode: { type: 'boolean' },
+        allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
         examples: _1.mapOf('Example'),
@@ -193,9 +145,7 @@ const Operation = {
         servers: _1.listOf('Server'),
         requestBody: 'RequestBody',
         responses: 'ResponsesMap',
-        deprecated: {
-            type: 'boolean',
-        },
+        deprecated: { type: 'boolean' },
         callbacks: _1.mapOf('Callback'),
         'x-codeSamples': _1.listOf('XCodeSample'),
         'x-code-samples': _1.listOf('XCodeSample'), // deprecated
@@ -211,12 +161,8 @@ const XCodeSample = {
 };
 const RequestBody = {
     properties: {
-        description: {
-            type: 'string',
-        },
-        required: {
-            type: 'boolean',
-        },
+        description: { type: 'string' },
+        required: { type: 'boolean' },
         content: 'MediaTypeMap',
     },
     required: ['content'],
@@ -236,57 +182,33 @@ const MediaType = {
 const Example = {
     properties: {
         value: { isExample: true },
-        summary: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
-        externalValue: {
-            type: 'string',
-        },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        externalValue: { type: 'string' },
     },
 };
 const Encoding = {
     properties: {
-        contentType: {
-            type: 'string',
-        },
+        contentType: { type: 'string' },
         headers: _1.mapOf('Header'),
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
-        explode: {
-            type: 'boolean',
-        },
-        allowReserved: {
-            type: 'boolean',
-        },
+        explode: { type: 'boolean' },
+        allowReserved: { type: 'boolean' },
     },
 };
 const Header = {
     properties: {
-        description: {
-            type: 'string',
-        },
-        required: {
-            type: 'boolean',
-        },
-        deprecated: {
-            type: 'boolean',
-        },
-        allowEmptyValue: {
-            type: 'boolean',
-        },
+        description: { type: 'string' },
+        required: { type: 'boolean' },
+        deprecated: { type: 'boolean' },
+        allowEmptyValue: { type: 'boolean' },
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
-        explode: {
-            type: 'boolean',
-        },
-        allowReserved: {
-            type: 'boolean',
-        },
+        explode: { type: 'boolean' },
+        allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
         examples: _1.mapOf('Example'),
@@ -294,16 +216,12 @@ const Header = {
     },
 };
 const ResponsesMap = {
-    properties: {
-        default: 'Response',
-    },
+    properties: { default: 'Response' },
     additionalProperties: (_v, key) => responseCodeRegexp.test(key) ? 'Response' : undefined,
 };
 const Response = {
     properties: {
-        description: {
-            type: 'string',
-        },
+        description: { type: 'string' },
         headers: _1.mapOf('Header'),
         content: 'MediaTypeMap',
         links: _1.mapOf('Link'),
@@ -425,7 +343,7 @@ const ImplicitFlow = {
         scopes: { type: 'object', additionalProperties: { type: 'string' } },
         authorizationUrl: { type: 'string' },
     },
-    required: ['authorizationUrl', 'scopes'],
+    required: ['authorizationUrl', 'scopes']
 };
 const PasswordFlow = {
     properties: {
@@ -465,30 +383,41 @@ const SecurityScheme = {
         type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect'] },
         description: { type: 'string' },
         name: { type: 'string' },
-        in: { type: 'string' },
+        in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
         flows: 'SecuritySchemeFlows',
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {
-        if (!(value === null || value === void 0 ? void 0 : value.type)) {
-            return ['type'];
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in'];
+            case 'http':
+                return ['type', 'scheme'];
+            case 'oauth2':
+                return ['type', 'flows'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl'];
+            default:
+                return ['type'];
         }
-        if (value.type === 'apiKey') {
-            return ['type', 'name', 'in'];
-        }
-        else if (value.type === 'http') {
-            return ['type', 'scheme'];
-        }
-        else if (value.type === 'oauth2') {
-            return ['type', 'flows'];
-        }
-        else if (value.type === 'openIdConnect') {
-            return ['type', 'openIdConnectUrl'];
+    },
+    allowed(value) {
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in', 'description'];
+            case 'http':
+                return ['type', 'scheme', 'bearerFormat', 'description'];
+            case 'oauth2':
+                return ['type', 'flows', 'description'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl', 'description'];
+            default:
+                return ['type', 'description'];
         }
-        return ['type'];
     },
+    extensionsPrefix: 'x-',
 };
 exports.Oas3Types = {
     DefinitionRoot,