@redocly/openapi-core 1.0.0-beta.64 → 1.0.0-beta.68

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

@@ -99,3 +99,129 @@ components:
       name: shared-a
 
 `;
+
+exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
+openapi: 3.0.0
+paths:
+  /pet:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/requestBody'
+components:
+  schemas:
+    requestBody:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              a:
+                type: string
+              b:
+                type: number
+
+`;
+
+exports[`bundle should place referenced schema inline when referenced schema name resolves to original schema name 1`] = `
+openapi: 3.1.0
+info:
+  title: My API
+  description: It ain't so wonderful, but at least it's mine.
+  version: '1.0'
+  contact:
+    email: me@theintenet.com
+    name: me
+paths:
+  /test:
+    get:
+      summary: test
+      responses:
+        '200':
+          description: test
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/vendor'
+components:
+  schemas:
+    vendor:
+      title: vendor
+      type: object
+      description: Vendors
+      properties:
+        key:
+          type: string
+          description: System-assigned key for the vendor.
+          readOnly: true
+        id:
+          type: string
+          description: >
+            Unique identifier of the vendor.
+
+            You must specify a unique vendor ID when creating a vendor unless
+            document sequencing is configured, in which case the ID is
+            auto-generated.
+        name:
+          type: string
+          description: Name of the vendor.
+        isOneTimeUse:
+          type: boolean
+          description: One-time use
+          default: false
+    myvendor:
+      $ref: '#/components/schemas/vendor'
+    simple:
+      type: string
+    A:
+      type: string
+    test:
+      $ref: '#/components/schemas/rename-2'
+    rename:
+      type: string
+    rename-2:
+      type: number
+
+`;
+
+exports[`bundle should pull hosted schema 1`] = `
+openapi: 3.0.3
+info:
+  title: bugtest
+  version: '1.0'
+  description: Demo
+  license:
+    name: DEMO
+    url: https://demo.com
+servers:
+  - url: http://demo.com/api
+paths:
+  /customer:
+    summary: Customer scope
+    get:
+      summary: Get demo no refs
+      operationId: GetCustomer
+      description: Returns Demo No Refs
+      responses:
+        '200':
+          description: Demo No Refs
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+components:
+  schemas:
+    Customer:
+      type: object
+      properties:
+        customerName:
+          type: string
+        accounts:
+          type: array
+          items:
+            $ref: '#/components/schemas/someexternal'
+    someexternal: External schema content
+
+`;

package/__tests__/bundle.test.ts

@@ -10,7 +10,7 @@ import { BaseResolver } from '../src/resolve';
 describe('bundle', () => {
   expect.addSnapshotSerializer(yamlSerializer);
 
-  const testDocument =  parseYamlToDocument(
+  const testDocument = parseYamlToDocument(
     outdent`
       openapi: 3.0.0
       paths:
@@ -77,4 +77,56 @@ describe('bundle', () => {
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
+
+  it('should place referenced schema inline when referenced schema name resolves to original schema name', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({}),
+      ref: path.join(__dirname, 'fixtures/refs/externalref.yaml'),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({}),
+      ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should pull hosted schema', async () => {
+    const fetchMock = jest.fn(
+      () => Promise.resolve({
+        ok: true,
+        text: () => 'External schema content',
+        headers: {
+          get: () => ''
+        }
+      })
+    );
+
+    const { bundle: res, problems } = await bundle({
+      config: new Config({}),
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: []
+        }
+      }),
+      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml')
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(fetchMock).toHaveBeenCalledWith(
+      "https://someexternal.schema",
+      {
+        headers: {}
+      }
+    );
+    expect(res.parsed).toMatchSnapshot();
+  })
 });

package/__tests__/fixtures/refs/definitions.yaml

@@ -0,0 +1,3 @@
+$defs:
+  A:
+    type: string

package/__tests__/fixtures/refs/external-request-body.yaml

@@ -0,0 +1,13 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: ./requestBody.yaml
+components:
+  schemas:
+    requestBody:
+      $ref: ./requestBody.yaml

package/__tests__/fixtures/refs/externalref.yaml

@@ -0,0 +1,35 @@
+openapi: 3.1.0
+info:
+  title: My API
+  description: It ain't so wonderful, but at least it's mine.
+  version: '1.0'
+  contact:
+    email: me@theintenet.com
+    name: me
+paths:
+  /test:
+    get:
+      summary: 'test'
+      responses:
+        200:
+          description: test
+          content:
+            application/json:
+              schema:
+                $ref: ./vendor.schema.yaml
+components:
+  schemas:
+    vendor:
+      $ref: ./vendor.schema.yaml
+    myvendor:
+      $ref: ./vendor.schema.yaml
+    simple:
+      $ref: ./simple.yaml
+    A:
+      $ref: ./definitions.yaml#/$defs/A
+    test:
+      $ref: ./rename.yaml
+    rename:
+      type: string
+    rename-2:
+      $ref: ./rename.yaml

package/__tests__/fixtures/refs/hosted.yaml

@@ -0,0 +1,35 @@
+openapi: "3.0.3"
+info:
+  title: bugtest
+  version: "1.0"
+  description: Demo
+  license:
+    name: DEMO
+    url: https://demo.com
+servers:
+  - url: http://demo.com/api
+paths:
+  /customer:
+    summary: "Customer scope"
+    get:
+      summary: "Get demo no refs"
+      operationId: GetCustomer
+      description: "Returns Demo No Refs"
+      responses:
+        200:
+          description: Demo No Refs
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Customer"  
+components:
+  schemas: 
+    Customer:
+      type: object
+      properties:
+        customerName:
+          type: string
+        accounts:
+          type: array
+          items:
+            $ref: "https://someexternal.schema"

package/__tests__/fixtures/refs/rename.yaml

@@ -0,0 +1 @@
+type: number

package/__tests__/fixtures/refs/requestBody.yaml

@@ -0,0 +1,9 @@
+content: 
+  application/json: 
+    schema: 
+      type: object
+      properties: 
+        a:
+          type: string
+        b:
+          type: number

package/__tests__/fixtures/refs/simple.yaml

@@ -0,0 +1 @@
+type: string

package/__tests__/fixtures/refs/vendor.schema.yaml

@@ -0,0 +1,20 @@
+title: vendor
+type: object
+description: Vendors
+properties:
+  key:
+    type: string
+    description: System-assigned key for the vendor.
+    readOnly: true
+  id:
+    type: string
+    description: |
+      Unique identifier of the vendor.
+      You must specify a unique vendor ID when creating a vendor unless document sequencing is configured, in which case the ID is auto-generated.
+  name:
+    type: string
+    description: Name of the vendor.
+  isOneTimeUse:
+    type: boolean
+    description: One-time use
+    default: false

package/lib/bundle.js

@@ -49,7 +49,11 @@ function bundleDocument(opts) {
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
-        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3) ? (oasVersion === OasVersion.Version3_1 ? oas3_1_1.Oas3_1Types : oas3_1.Oas3Types) : oas2_1.Oas2Types, oasVersion), config);
+        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3)
+            ? oasVersion === OasVersion.Version3_1
+                ? oas3_1_1.Oas3_1Types
+                : oas3_1.Oas3Types
+            : oas2_1.Oas2Types, oasVersion), config);
         const preprocessors = rules_1.initRules(rules, config, 'preprocessors', oasVersion);
         const decorators = rules_1.initRules(rules, config, 'decorators', oasVersion);
         const ctx = {
@@ -210,6 +214,14 @@ function makeBundleVisitor(version, dereference, rootDocument) {
             return `#/${componentType}/${name}`;
         }
     }
+    function isEqualOrEqualRef(node, target, ctx) {
+        var _a;
+        if (ref_utils_1.isRef(node) &&
+            ((_a = ctx.resolve(node).location) === null || _a === void 0 ? void 0 : _a.absolutePointer) === target.location.absolutePointer) {
+            return true;
+        }
+        return isEqual(node, target.node);
+    }
     function getComponentName(target, componentType, ctx) {
         const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
         const componentsGroup = components[componentType];
@@ -219,17 +231,17 @@ function makeBundleVisitor(version, dereference, rootDocument) {
             name = refParts.pop() + (name ? `-${name}` : '');
             if (!componentsGroup ||
                 !componentsGroup[name] ||
-                isEqual(componentsGroup[name], target.node)) {
+                isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
                 return name;
             }
         }
         name = ref_utils_1.refBaseName(fileRef) + (name ? `_${name}` : '');
-        if (!componentsGroup[name] || isEqual(componentsGroup[name], target.node)) {
+        if (!componentsGroup[name] || isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
             return name;
         }
         const prevName = name;
         let serialId = 2;
-        while (componentsGroup[name] && !isEqual(componentsGroup[name], target.node)) {
+        while (componentsGroup[name] && !isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
             name = `${prevName}-${serialId}`;
             serialId++;
         }

package/lib/config/all.js

@@ -12,11 +12,13 @@ exports.default = {
         'no-identical-paths': 'error',
         'no-ambiguous-paths': 'error',
         'no-path-trailing-slash': 'error',
+        'path-segment-plural': 'error',
         'path-declaration-must-exist': 'error',
         'path-not-include-query': 'error',
         'path-parameters-defined': 'error',
         'operation-description': 'error',
         'operation-2xx-response': 'error',
+        'operation-4xx-response': 'error',
         'operation-operationId': 'error',
         'operation-summary': 'error',
         'operation-operationId-unique': 'error',
@@ -29,6 +31,12 @@ exports.default = {
         'no-enum-type-mismatch': 'error',
         'boolean-parameter-prefixes': 'error',
         'paths-kebab-case': 'error',
+        'no-http-verbs-in-paths': 'error',
+        'path-excludes-patterns': {
+            severity: 'error',
+            patterns: [],
+        },
+        'request-mime-type': 'error',
         spec: 'error',
     },
     oas3_0Rules: {
@@ -49,5 +57,5 @@ exports.default = {
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
         'no-servers-empty-enum': 'error',
-    }
+    },
 };

package/lib/config/config.js

@@ -73,7 +73,7 @@ class LintConfig {
         const ignoreFile = path.join(dir, exports.IGNORE_FILE);
         const mapped = {};
         for (const absFileName of Object.keys(this.ignore)) {
-            const ignoredRules = (mapped[path.relative(dir, absFileName)] = this.ignore[absFileName]);
+            const ignoredRules = (mapped[utils_1.slash(path.relative(dir, absFileName))] = this.ignore[absFileName]);
             for (const ruleId of Object.keys(ignoredRules)) {
                 ignoredRules[ruleId] = Array.from(ignoredRules[ruleId]);
             }

package/lib/config/minimal.js

@@ -17,6 +17,7 @@ exports.default = {
         'path-parameters-defined': 'warn',
         'operation-description': 'off',
         'operation-2xx-response': 'warn',
+        'operation-4xx-response': 'off',
         'operation-operationId': 'warn',
         'operation-summary': 'warn',
         'operation-operationId-unique': 'warn',

package/lib/config/recommended.js

@@ -17,6 +17,7 @@ exports.default = {
         'path-parameters-defined': 'error',
         'operation-description': 'off',
         'operation-2xx-response': 'warn',
+        'operation-4xx-response': 'warn',
         'operation-operationId': 'warn',
         'operation-summary': 'error',
         'operation-operationId-unique': 'error',

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export { BundleOutputFormat, readFileFromUrl } from './utils';
+export { BundleOutputFormat, readFileFromUrl, slash } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';

package/lib/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.loadConfig = exports.IGNORE_FILE = exports.LintConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = 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.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.loadConfig = exports.IGNORE_FILE = exports.LintConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.slash = exports.readFileFromUrl = 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; } });
 var oas3_1_1 = require("./types/oas3_1");
 Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
 var oas3_1 = require("./types/oas3");

package/lib/ref-utils.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isMappingRef = exports.isAbsoluteUrl = exports.refBaseName = exports.pointerBaseName = exports.parsePointer = exports.parseRef = exports.escapePointer = exports.unescapePointer = exports.Location = exports.isRef = exports.joinPointer = void 0;
-const path_1 = require("path");
 function joinPointer(base, key) {
     if (base === '')
         base = '#/';
@@ -56,7 +55,7 @@ function pointerBaseName(pointer) {
 }
 exports.pointerBaseName = pointerBaseName;
 function refBaseName(ref) {
-    const parts = ref.split(path_1.sep);
+    const parts = ref.split(/[\/\\]/); // split by '\' and '/'
     return parts[parts.length - 1].split('.')[0];
 }
 exports.refBaseName = refBaseName;

package/lib/rules/builtin.d.ts

@@ -7,8 +7,14 @@ export declare const preprocessors: {
 export declare const decorators: {
     oas3: {
         'registry-dependencies': import("../visitors").Oas3Decorator;
+        'operation-description-override': import("../visitors").Oas3Decorator;
+        'tag-description-override': import("../visitors").Oas3Decorator;
+        'info-description-override': import("../visitors").Oas3Decorator;
     };
     oas2: {
         'registry-dependencies': import("../visitors").Oas2Decorator;
+        'operation-description-override': import("../visitors").Oas2Decorator;
+        'tag-description-override': import("../visitors").Oas2Decorator;
+        'info-description-override': import("../visitors").Oas2Decorator;
     };
 };

package/lib/rules/common/info-description-override.d.ts

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

package/lib/rules/common/info-description-override.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoDescriptionOverride = void 0;
+const utils_1 = require("../../utils");
+const InfoDescriptionOverride = ({ filePath }) => {
+    return {
+        Info: {
+            leave(info, { report, location }) {
+                if (!filePath)
+                    throw new Error(`Parameter "filePath" is not provided for "info-description-override" rule`);
+                try {
+                    info.description = utils_1.readFileAsStringSync(filePath);
+                }
+                catch (e) {
+                    report({
+                        message: `Failed to read markdown override file for "info.description".\n${e.message}`,
+                        location: location.child('description'),
+                    });
+                }
+            },
+        },
+    };
+};
+exports.InfoDescriptionOverride = InfoDescriptionOverride;

package/lib/rules/common/info-license-url.js

@@ -8,6 +8,7 @@ const InfoLicense = () => {
             if (!info.license) {
                 report({
                     message: utils_1.missingRequiredField('Info', 'license'),
+                    location: { reportOnKey: true }
                 });
             }
         },

package/lib/rules/common/no-http-verbs-in-paths.d.ts

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

package/lib/rules/common/no-http-verbs-in-paths.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoHttpVerbsInPaths = void 0;
+const utils_1 = require("../../utils");
+const httpMethods = ['get', 'head', 'post', 'put', 'patch', 'delete', 'options', 'trace'];
+const NoHttpVerbsInPaths = ({ splitIntoWords }) => {
+    return {
+        PathItem(_path, { key, report, location }) {
+            const pathKey = key.toString();
+            if (!pathKey.startsWith('/'))
+                return;
+            const pathSegments = pathKey.split('/');
+            for (const pathSegment of pathSegments) {
+                if (!pathSegment || utils_1.isPathParameter(pathSegment))
+                    continue;
+                const isHttpMethodIncluded = (method) => {
+                    return splitIntoWords
+                        ? utils_1.splitCamelCaseIntoWords(pathSegment).has(method)
+                        : pathSegment.toLocaleLowerCase().includes(method);
+                };
+                for (const method of httpMethods) {
+                    if (isHttpMethodIncluded(method)) {
+                        report({
+                            message: `path \`${pathKey}\` should not contain http verb ${method}`,
+                            location: location.key(),
+                        });
+                    }
+                }
+            }
+        },
+    };
+};
+exports.NoHttpVerbsInPaths = NoHttpVerbsInPaths;

package/lib/rules/common/operation-4xx-response.d.ts

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

package/lib/rules/common/operation-4xx-response.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operation4xxResponse = void 0;
+const Operation4xxResponse = () => {
+    return {
+        ResponsesMap(responses, { report }) {
+            const codes = Object.keys(responses);
+            if (!codes.some((code) => /4[Xx0-9]{2}/.test(code))) {
+                report({
+                    message: 'Operation must have at least one `4xx` response.',
+                    location: { reportOnKey: true },
+                });
+            }
+        },
+    };
+};
+exports.Operation4xxResponse = Operation4xxResponse;

package/lib/rules/common/operation-description-override.d.ts

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

package/lib/rules/common/operation-description-override.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationDescriptionOverride = void 0;
+const utils_1 = require("../../utils");
+const OperationDescriptionOverride = ({ operationIds }) => {
+    return {
+        Operation: {
+            leave(operation, { report, location }) {
+                if (!operation.operationId)
+                    return;
+                if (!operationIds)
+                    throw new Error(`Parameter "operationIds" is not provided for "operation-description-override" rule`);
+                const operationId = operation.operationId;
+                if (operationIds[operationId]) {
+                    try {
+                        operation.description = utils_1.readFileAsStringSync(operationIds[operationId]);
+                    }
+                    catch (e) {
+                        report({
+                            message: `Failed to read markdown override file for operation "${operationId}".\n${e.message}`,
+                            location: location.child('operationId').key(),
+                        });
+                    }
+                }
+            },
+        },
+    };
+};
+exports.OperationDescriptionOverride = OperationDescriptionOverride;

package/lib/rules/common/path-excludes-patterns.d.ts

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

package/lib/rules/common/path-excludes-patterns.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathExcludesPatterns = void 0;
+const PathExcludesPatterns = ({ patterns }) => {
+    return {
+        PathItem(_path, { report, key, location }) {
+            if (!patterns)
+                throw new Error(`Parameter "patterns" is not provided for "path-excludes-patterns" rule`);
+            const pathKey = key.toString();
+            if (pathKey.startsWith('/')) {
+                const matches = patterns.filter((pattern) => pathKey.match(pattern));
+                for (const match of matches) {
+                    report({
+                        message: `path \`${pathKey}\` should not match regex pattern: \`${match}\``,
+                        location: location.key(),
+                    });
+                }
+            }
+        },
+    };
+};
+exports.PathExcludesPatterns = PathExcludesPatterns;

package/lib/rules/common/path-segment-plural.d.ts

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