@redocly/openapi-core 1.0.0-beta.96 → 1.0.0-beta.99

package/lib/types/oas3.js

@@ -149,7 +149,8 @@ const Operation = {
         deprecated: { type: 'boolean' },
         callbacks: _1.mapOf('Callback'),
         'x-codeSamples': _1.listOf('XCodeSample'),
-        'x-code-samples': _1.listOf('XCodeSample'), // deprecated
+        'x-code-samples': _1.listOf('XCodeSample'),
+        'x-hideTryItPanel': { type: 'boolean' },
     },
     required: ['responses'],
 };
@@ -249,14 +250,14 @@ const Schema = {
         minimum: { type: 'number' },
         exclusiveMaximum: { type: 'boolean' },
         exclusiveMinimum: { type: 'boolean' },
-        maxLength: { type: 'number', minimum: 0 },
-        minLength: { type: 'number', minimum: 0 },
+        maxLength: { type: 'integer', minimum: 0 },
+        minLength: { type: 'integer', minimum: 0 },
         pattern: { type: 'string' },
-        maxItems: { type: 'number', minimum: 0 },
-        minItems: { type: 'number', minimum: 0 },
+        maxItems: { type: 'integer', minimum: 0 },
+        minItems: { type: 'integer', minimum: 0 },
         uniqueItems: { type: 'boolean' },
-        maxProperties: { type: 'number', minimum: 0 },
-        minProperties: { type: 'number', minimum: 0 },
+        maxProperties: { type: 'integer', minimum: 0 },
+        minProperties: { type: 'integer', minimum: 0 },
         required: { type: 'array', items: { type: 'string' } },
         enum: { type: 'array' },
         type: {
@@ -275,6 +276,17 @@ const Schema = {
                 return 'Schema';
             }
         },
+        additionalItems: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else if (Array.isArray(value)) {
+                return _1.listOf('Schema');
+            }
+            else {
+                return 'Schema';
+            }
+        },
         additionalProperties: (value) => {
             if (typeof value === 'boolean') {
                 return { type: 'boolean' };
@@ -292,6 +304,7 @@ const Schema = {
         xml: 'Xml',
         example: { isExample: true },
         deprecated: { type: 'boolean' },
+        'x-tags': { type: 'array', items: { type: 'string' } },
     },
 };
 const Xml = {
@@ -344,7 +357,7 @@ const ImplicitFlow = {
         scopes: { type: 'object', additionalProperties: { type: 'string' } },
         authorizationUrl: { type: 'string' },
     },
-    required: ['authorizationUrl', 'scopes']
+    required: ['authorizationUrl', 'scopes'],
 };
 const PasswordFlow = {
     properties: {

package/lib/types/oas3_1.js

@@ -71,7 +71,8 @@ const Operation = {
         deprecated: { type: 'boolean' },
         callbacks: _1.mapOf('Callback'),
         'x-codeSamples': _1.listOf('XCodeSample'),
-        'x-code-samples': _1.listOf('XCodeSample'), // deprecated
+        'x-code-samples': _1.listOf('XCodeSample'),
+        'x-hideTryItPanel': { type: 'boolean' },
     },
 };
 const Schema = {
@@ -86,19 +87,19 @@ const Schema = {
         discriminator: 'Discriminator',
         myArbitraryKeyword: { type: 'boolean' },
         title: { type: 'string' },
-        multipleOf: { type: 'number' },
+        multipleOf: { type: 'number', minimum: 0 },
         maximum: { type: 'number' },
         minimum: { type: 'number' },
         exclusiveMaximum: { type: 'number' },
         exclusiveMinimum: { type: 'number' },
-        maxLength: { type: 'number' },
-        minLength: { type: 'number' },
+        maxLength: { type: 'integer', minimum: 0 },
+        minLength: { type: 'integer', minimum: 0 },
         pattern: { type: 'string' },
-        maxItems: { type: 'number' },
-        minItems: { type: 'number' },
+        maxItems: { type: 'integer', minimum: 0 },
+        minItems: { type: 'integer', minimum: 0 },
         uniqueItems: { type: 'boolean' },
-        maxProperties: { type: 'number' },
-        minProperties: { type: 'number' },
+        maxProperties: { type: 'integer', minimum: 0 },
+        minProperties: { type: 'integer', minimum: 0 },
         required: { type: 'array', items: { type: 'string' } },
         enum: { type: 'array' },
         type: (value) => {
@@ -124,6 +125,8 @@ const Schema = {
         dependentSchemas: _1.listOf('Schema'),
         prefixItems: _1.listOf('Schema'),
         contains: 'Schema',
+        minContains: { type: 'integer', minimum: 0 },
+        maxContains: { type: 'integer', minimum: 0 },
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
         unevaluatedItems: 'Schema',
@@ -164,6 +167,7 @@ const Schema = {
         deprecated: { type: 'boolean' },
         const: null,
         $comment: { type: 'string' },
+        'x-tags': { type: 'array', items: { type: 'string' } },
     },
 };
 const SecurityScheme = {

package/lib/types/redocly-yaml.js

@@ -311,6 +311,7 @@ const LinksConfig = {
         color: { type: 'string' },
         hover: { type: 'string' },
         textDecoration: { type: 'string' },
+        hoverTextDecoration: { type: 'string' },
         visited: { type: 'string' },
     },
 };
@@ -401,6 +402,9 @@ const ConfigReferenceDocs = {
         disableSidebar: { type: 'boolean' },
         downloadDefinitionUrl: { type: 'string' },
         expandDefaultServerVariables: { type: 'boolean' },
+        enumSkipQuotes: { type: 'boolean' },
+        expandDefaultRequest: { type: 'boolean' },
+        expandDefaultResponse: { type: 'boolean' },
         expandResponses: { type: 'string' },
         expandSingleSchemaField: { type: 'boolean' },
         generateCodeSamples: 'GenerateCodeSamples',
@@ -414,6 +418,9 @@ const ConfigReferenceDocs = {
         hideSchemaPattern: { type: 'boolean' },
         hideSchemaTitles: { type: 'boolean' },
         hideSingleRequestSampleTab: { type: 'boolean' },
+        hideTryItPanel: { type: 'boolean' },
+        hideFab: { type: 'boolean' },
+        hideOneOfDescription: { type: 'boolean' },
         htmlTemplate: { type: 'string' },
         jsonSampleExpandLevel: { type: 'string' },
         labels: 'ConfigLabels',
@@ -433,6 +440,9 @@ const ConfigReferenceDocs = {
         routingBasePath: { type: 'string' },
         samplesTabsMaxCount: { type: 'number' },
         schemaExpansionLevel: { type: 'string' },
+        schemaDefinitionsTagName: { type: 'string' },
+        minCharacterLengthToInitSearch: { type: 'number' },
+        maxResponseHeadersToShowInTryIt: { type: 'number' },
         scrollYOffset: { type: 'string' },
         searchAutoExpand: { type: 'boolean' },
         searchFieldLevelBoost: { type: 'number' },
@@ -444,6 +454,8 @@ const ConfigReferenceDocs = {
         showExtensions: { type: 'boolean' },
         showNextButton: { type: 'boolean' },
         showRightPanelToggle: { type: 'boolean' },
+        showWebhookVerb: { type: 'boolean' },
+        showObjectSchemaExamples: { type: 'boolean' },
         sidebarLinks: 'ConfigSidebarLinks',
         sideNavStyle: { type: 'string' },
         simpleOneOfTypeLabel: { type: 'boolean' },

package/lib/typings/openapi.d.ts

@@ -72,6 +72,7 @@ export interface Oas3Operation {
     servers?: Oas3Server[];
     'x-codeSamples'?: Oas3XCodeSample[];
     'x-code-samples'?: Oas3XCodeSample[];
+    'x-hideTryItPanel'?: boolean;
 }
 export interface Oas3Parameter {
     name: string;
@@ -144,10 +145,12 @@ export interface Oas3Schema {
     enum?: any[];
     example?: any;
     xml?: Oas3Xml;
+    'x-tags'?: string[];
 }
-export interface Oas3_1Schema extends Oas3Schema {
+export declare type Oas3_1Schema = Oas3Schema & {
+    type?: string | string[];
     examples?: any[];
-}
+};
 export interface Oas3_1Definition extends Oas3Definition {
     webhooks?: Oas3_1Webhooks;
 }

package/lib/typings/swagger.d.ts

@@ -71,6 +71,7 @@ export interface Oas2Operation {
     security?: Oas2SecurityRequirement[];
     'x-codeSamples'?: Oas2XCodeSample[];
     'x-code-samples'?: Oas2XCodeSample[];
+    'x-hideTryItPanel'?: boolean;
 }
 export declare type Oas2Parameter = Oas2BodyParameter | Oas2SimpleParameter;
 export interface Oas2BodyParameter {
@@ -166,6 +167,7 @@ export interface Oas2Schema {
     enum?: any[];
     example?: any;
     xml?: Oas2Xml;
+    'x-tags'?: string[];
 }
 export declare type Oas2ParameterLocation = 'query' | 'header' | 'path' | 'formData';
 export interface Oas2Responses {

package/lib/utils.d.ts

@@ -22,7 +22,6 @@ export declare function readFileFromUrl(url: string, config: HttpResolveConfig):
     body: any;
     mimeType: any;
 }>;
-export declare function match(url: string, pattern: string): boolean;
 export declare function pickObjectProps<T extends Record<string, unknown>>(object: T, keys: Array<string>): T;
 export declare function omitObjectProps<T extends Record<string, unknown>>(object: T, keys: Array<string>): T;
 export declare function splitCamelCaseIntoWords(str: string): Set<string>;
@@ -39,3 +38,4 @@ export declare function isNotEmptyObject(obj: any): boolean;
 export declare function isString(value: unknown): value is string;
 export declare function isNotString<T>(value: string | T): value is T;
 export declare function assignExisting<T>(target: Record<string, T>, obj: Record<string, T>): void;
+export declare const getMatchingStatusCodeRange: (code: number | string) => string;

package/lib/utils.js

@@ -9,12 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.match = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+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.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
 const pluralize = require("pluralize");
 const js_yaml_1 = require("./js-yaml");
+const config_1 = require("./config");
 var js_yaml_2 = require("./js-yaml");
 Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
 Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
@@ -56,7 +57,7 @@ function readFileFromUrl(url, config) {
         for (const header of config.headers) {
             if (match(url, header.matches)) {
                 headers[header.name] =
-                    header.envVariable !== undefined ? process.env[header.envVariable] || '' : header.value;
+                    header.envVariable !== undefined ? config_1.env[header.envVariable] || '' : header.value;
             }
         }
         const req = yield (config.customFetch || node_fetch_1.default)(url, {
@@ -76,7 +77,6 @@ function match(url, pattern) {
     }
     return minimatch(url, pattern);
 }
-exports.match = match;
 function pickObjectProps(object, keys) {
     return Object.fromEntries(keys.filter((key) => key in object).map((key) => [key, object[key]]));
 }
@@ -173,3 +173,5 @@ function assignExisting(target, obj) {
     }
 }
 exports.assignExisting = assignExisting;
+const getMatchingStatusCodeRange = (code) => `${code}`.replace(/^(\d)\d\d$/, (_, firstDigit) => `${firstDigit}XX`);
+exports.getMatchingStatusCodeRange = getMatchingStatusCodeRange;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.96",
+  "version": "1.0.0-beta.99",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -39,7 +39,7 @@
     "js-levenshtein": "^1.1.6",
     "js-yaml": "^4.1.0",
     "lodash.isequal": "^4.5.0",
-    "minimatch": "^3.0.4",
+    "minimatch": "^5.0.1",
     "node-fetch": "^2.6.1",
     "pluralize": "^8.0.0",
     "yaml-ast-parser": "0.0.43"
@@ -48,7 +48,7 @@
     "@types/js-levenshtein": "^1.1.0",
     "@types/js-yaml": "^4.0.3",
     "@types/lodash.isequal": "^4.5.5",
-    "@types/minimatch": "^3.0.3",
+    "@types/minimatch": "^3.0.5",
     "@types/node-fetch": "^2.5.7",
     "@types/pluralize": "^0.0.29",
     "typescript": "^4.0.5"

package/{__tests__ → src/__tests__}/__snapshots__/bundle.test.ts.snap

@@ -100,6 +100,32 @@ components:
 
 `;
 
+exports[`bundle should not bundle url refs if used with keepUrlRefs 1`] = `
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: https://someexternal.schema
+        - $ref: '#/components/parameters/param-b'
+        - name: test
+    get:
+      parameters:
+        - $ref: http://someexternal.schema
+        - $ref: '#/components/parameters/param-c'
+components:
+  parameters:
+    path-param:
+      name: path_param
+    param-c:
+      name: param_c
+    param-b:
+      name: param_b
+
+`;
+
 exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
 openapi: 3.0.0
 paths:

package/{__tests__ → src/__tests__}/bundle.test.ts

@@ -1,11 +1,10 @@
 import outdent from 'outdent';
 import * as path from 'path';
 
-import { bundleDocument, bundle } from '../src/bundle';
-
-import { parseYamlToDocument, yamlSerializer } from './utils';
-import { LintConfig, Config, ResolvedConfig } from '../src/config';
-import { BaseResolver } from '../src/resolve';
+import { bundleDocument, bundle } from '../bundle';
+import { parseYamlToDocument, yamlSerializer } from '../../__tests__/utils';
+import { LintConfig, Config, ResolvedConfig } from '../config';
+import { BaseResolver } from '../resolve';
 
 describe('bundle', () => {
   expect.addSnapshotSerializer(yamlSerializer);
@@ -128,5 +127,30 @@ describe('bundle', () => {
       }
     );
     expect(res.parsed).toMatchSnapshot();
-  })
+  });
+
+  it('should not bundle url refs if used with keepUrlRefs', async () => {
+    const fetchMock = jest.fn(() =>
+        Promise.resolve({
+          ok: true,
+          text: () => 'External schema content',
+          headers: {
+            get: () => '',
+          },
+        }),
+    );
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: [],
+        },
+      }),
+      ref: path.join(__dirname, 'fixtures/refs/openapi-with-url-refs.yaml'),
+      keepUrlRefs: true,
+    });
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
 });

package/{__tests__ → src/__tests__}/codeframes.test.ts

@@ -1,8 +1,8 @@
 import { outdent } from 'outdent';
 
-import { getLineColLocation, getCodeframe } from '../src/format/codeframes';
-import { LocationObject } from '../src/walk';
-import { Source } from '../src/resolve';
+import { getLineColLocation, getCodeframe } from '../format/codeframes';
+import { LocationObject } from '../walk';
+import { Source } from '../resolve';
 
 describe('Location', () => {
   it('should correctly calculate location for key', () => {

package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml

@@ -0,0 +1,18 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: 'https://someexternal.schema'
+        - $ref: ./param-b.yaml
+        - name: test
+    get:
+      parameters:
+        - $ref: 'http://someexternal.schema'
+        - $ref: ./param-c.yaml
+components:
+  parameters:
+    path-param:
+      name: path_param

package/src/__tests__/lint.test.ts

@@ -4,6 +4,7 @@ import { lintFromString, lintConfig, lintDocument } from '../lint';
 import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
+import { detectOpenAPI } from '../oas-types';
 
 describe('lint', () => {
   it('lintFromString should work', async () => {
@@ -179,4 +180,16 @@ describe('lint', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
+
+  it('detect OpenAPI should throw an error when version is not string', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0
+    `,
+      '',
+    );
+    expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
+      `Invalid OpenAPI version: should be a string but got "number"`,
+    );
+  });
 });

package/{__tests__ → src/__tests__}/login.test.ts

@@ -1,4 +1,4 @@
-import { RedoclyClient } from '../src/redocly';
+import { RedoclyClient } from '../redocly';
 
 describe.skip('login', () => {
   it('should call login with setAccessTokens function', async () => {

package/{__tests__ → src/__tests__}/normalizeVisitors.test.ts

@@ -1,7 +1,7 @@
-import { normalizeVisitors, VisitorLevelContext } from '../src/visitors';
-import { Oas3RuleSet } from '../src/oas-types';
-import { Oas3Types } from '../src/types/oas3';
-import { normalizeTypes } from '../src/types';
+import { normalizeVisitors, VisitorLevelContext } from '../visitors';
+import { Oas3RuleSet } from '../oas-types';
+import { Oas3Types } from '../types/oas3';
+import { normalizeTypes } from '../types';
 
 describe('Normalize visitors', () => {
   it('should work correctly for single rule', () => {

package/{__tests__ → src/__tests__}/ref-utils.test.ts

@@ -1,9 +1,9 @@
 import outdent from 'outdent';
-import { parseYamlToDocument } from './utils';
-import { parseRef, refBaseName } from '../src/ref-utils';
-import { lintDocument } from '../src/lint';
-import { LintConfig } from '../src/config';
-import { BaseResolver } from '../src/resolve';
+import { parseYamlToDocument } from '../../__tests__/utils';
+import { parseRef, refBaseName } from '../ref-utils';
+import { lintDocument } from '../lint';
+import { LintConfig } from '../config';
+import { BaseResolver } from '../resolve';
 
 describe('ref-utils', () => {
   it(`should unescape refs with '/'`, () => {

package/{__tests__ → src/__tests__}/resolve-http.test.ts

@@ -1,9 +1,9 @@
 import { outdent } from 'outdent';
 
-import { resolveDocument, BaseResolver } from '../src/resolve';
-import { parseYamlToDocument } from './utils';
-import { Oas3Types } from '../src/types/oas3';
-import { normalizeTypes } from '../src/types';
+import { resolveDocument, BaseResolver } from '../resolve';
+import { parseYamlToDocument } from '../../__tests__/utils';
+import { Oas3Types } from '../types/oas3';
+import { normalizeTypes } from '../types';
 
 describe('Resolve http-headers', () => {
   it('should use matching http-headers', async () => {

package/{__tests__ → src/__tests__}/resolve.test.ts

@@ -1,10 +1,10 @@
 import { outdent } from 'outdent';
 import * as path from 'path';
 
-import { resolveDocument, BaseResolver, Document } from '../src/resolve';
-import { parseYamlToDocument } from './utils';
-import { Oas3Types } from '../src/types/oas3';
-import { normalizeTypes } from '../src/types';
+import { resolveDocument, BaseResolver, Document } from '../resolve';
+import { parseYamlToDocument } from '../../__tests__/utils';
+import { Oas3Types } from '../types/oas3';
+import { normalizeTypes } from '../types';
 
 describe('collect refs', () => {
   it('should resolve local refs', async () => {

package/src/__tests__/utils.test.ts

@@ -1,4 +1,4 @@
-import { pickObjectProps, omitObjectProps, slash } from '../utils';
+import { pickObjectProps, omitObjectProps, slash, getMatchingStatusCodeRange } from '../utils';
 
 describe('utils', () => {
   const testObject = {
@@ -71,4 +71,15 @@ describe('utils', () => {
       expect(slash(extended)).toBe(extended);
     });
   });
+
+  describe('getMatchingStatusCodeRange', () => {
+    it('should get the generalized form of status codes', () => {
+      expect(getMatchingStatusCodeRange('202')).toEqual('2XX');
+      expect(getMatchingStatusCodeRange(400)).toEqual('4XX');
+    });
+    it('should fail on a wrong input', () => {
+      expect(getMatchingStatusCodeRange('2002')).toEqual('2002');
+      expect(getMatchingStatusCodeRange(4000)).toEqual('4000');
+    });
+  });
 });

package/{__tests__ → src/__tests__}/walk.test.ts

@@ -2,12 +2,12 @@ import outdent from 'outdent';
 import each from 'jest-each';
 import * as path from 'path';
 
-import { lintDocument } from '../src/lint';
+import { lintDocument } from '../lint';
 
-import { parseYamlToDocument, replaceSourceWithRef, makeConfigForRuleset } from './utils';
-import { BaseResolver, Document } from '../src/resolve';
-import { listOf } from '../src/types';
-import { Oas3RuleSet } from '../src/oas-types';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfigForRuleset } from '../../__tests__/utils';
+import { BaseResolver, Document } from '../resolve';
+import { listOf } from '../types';
+import { Oas3RuleSet } from '../oas-types';
 
 describe('walk order', () => {
   it('should run visitors', async () => {