@redocly/openapi-core 1.25.14 → 1.26.0

package/lib/types/redocly-yaml.js

@@ -7,8 +7,7 @@ const _1 = require(".");
 const utils_1 = require("../utils");
 const json_schema_adapter_1 = require("./json-schema-adapter");
 const oas_types_1 = require("../oas-types");
-const builtInCommonOASRules = [
-    'spec',
+const builtInOAS2Rules = [
     'info-contact',
     'operation-operationId',
     'tag-description',
@@ -48,14 +47,51 @@ const builtInCommonOASRules = [
     'spec-strict-refs',
     'no-unresolved-refs',
     'no-required-schema-properties-undefined',
-];
-const builtInOAS2Rules = [
     'boolean-parameter-prefixes',
     'request-mime-type',
     'response-contains-property',
     'response-mime-type',
 ];
 const builtInOAS3Rules = [
+    'info-contact',
+    'operation-operationId',
+    'tag-description',
+    'tags-alphabetical',
+    'info-license-url',
+    'info-license-strict',
+    'info-license',
+    'no-ambiguous-paths',
+    'no-enum-type-mismatch',
+    'no-http-verbs-in-paths',
+    'no-identical-paths',
+    'no-invalid-parameter-examples',
+    'no-invalid-schema-examples',
+    'no-path-trailing-slash',
+    'operation-2xx-response',
+    'operation-4xx-response',
+    'operation-description',
+    'operation-operationId-unique',
+    'operation-operationId-url-safe',
+    'operation-parameters-unique',
+    'operation-singular-tag',
+    'operation-summary',
+    'operation-tag-defined',
+    'parameter-description',
+    'path-declaration-must-exist',
+    'path-excludes-patterns',
+    'path-http-verbs-order',
+    'path-not-include-query',
+    'path-params-defined',
+    'path-parameters-defined',
+    'path-segment-plural',
+    'paths-kebab-case',
+    'required-string-property-missing-min-length',
+    'response-contains-header',
+    'scalar-property-missing-example',
+    'security-defined',
+    'spec-strict-refs',
+    'no-unresolved-refs',
+    'no-required-schema-properties-undefined',
     'boolean-parameter-prefixes',
     'component-name-unique',
     'no-empty-servers',
@@ -74,7 +110,6 @@ const builtInOAS3Rules = [
     'array-parameter-serialization',
 ];
 const builtInAsync2Rules = [
-    'spec',
     'info-contact',
     'info-license-strict',
     'operation-operationId',
@@ -84,7 +119,6 @@ const builtInAsync2Rules = [
     'no-channel-trailing-slash',
 ];
 const builtInAsync3Rules = [
-    'spec',
     'info-contact',
     'info-license-strict',
     'operation-operationId',
@@ -93,14 +127,14 @@ const builtInAsync3Rules = [
     'channels-kebab-case',
     'no-channel-trailing-slash',
 ];
-const builtInArazzoRules = [
-    'spec',
+const builtInArazzo1Rules = [
     'parameters-not-in-body',
     'sourceDescription-type',
     'version-enum',
     'workflowId-unique',
     'stepId-unique',
     'sourceDescription-name-unique',
+    'sourceDescriptions-not-empty',
     'workflow-dependsOn',
     'parameters-unique',
     'step-onSuccess-unique',
@@ -111,12 +145,13 @@ const builtInArazzoRules = [
     'criteria-unique',
 ];
 const builtInRules = [
-    ...builtInCommonOASRules,
     ...builtInOAS2Rules,
     ...builtInOAS3Rules,
     ...builtInAsync2Rules,
     ...builtInAsync3Rules,
-    ...builtInArazzoRules,
+    ...builtInArazzo1Rules,
+    'spec', // TODO: depricated in favor of struct
+    'struct',
 ];
 const oas2NodeTypesList = [
     'Root',
@@ -247,7 +282,7 @@ const ConfigStyleguide = {
         oas3_0Rules: 'Rules',
         oas3_1Rules: 'Rules',
         async2Rules: 'Rules',
-        arazzoRules: 'Rules',
+        arazzo1Rules: 'Rules',
         preprocessors: { type: 'object' },
         oas2Preprocessors: { type: 'object' },
         oas3_0Preprocessors: { type: 'object' },
@@ -259,7 +294,7 @@ const ConfigStyleguide = {
         oas3_0Decorators: { type: 'object' },
         oas3_1Decorators: { type: 'object' },
         async2Decorators: { type: 'object' },
-        arazzoDecorators: { type: 'object' },
+        arazzo1Decorators: { type: 'object' },
     },
 };
 const createConfigRoot = (nodeTypes) => ({

package/lib/typings/arazzo.d.ts

@@ -10,17 +10,12 @@ export interface OpenAPISourceDescription {
     url: string;
     'x-serverUrl'?: string;
 }
-export interface NoneSourceDescription {
-    name: string;
-    type: 'none';
-    'x-serverUrl': string;
-}
 export interface ArazzoSourceDescription {
     name: string;
     type: 'arazzo';
     url: string;
 }
-export type SourceDescription = OpenAPISourceDescription | NoneSourceDescription | ArazzoSourceDescription;
+export type SourceDescription = OpenAPISourceDescription | ArazzoSourceDescription;
 export interface Parameter {
     in?: 'header' | 'query' | 'path' | 'cookie' | 'body';
     name: string;
@@ -31,14 +26,6 @@ export interface ExtendedOperation {
     url: string;
     method: 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace' | 'connect' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT';
 }
-export interface ExpectSchema {
-    statusCode?: number;
-    mimeType?: string;
-    body?: any;
-    schema?: {
-        [key: string]: any;
-    };
-}
 export interface Replacement {
     target: string;
     value: string | object | any[];
@@ -89,7 +76,6 @@ export interface Step {
     outputs?: {
         [key: string]: string | object | any[] | boolean | number;
     };
-    'x-expect'?: ExpectSchema;
     'x-operation'?: ExtendedOperation;
     requestBody?: RequestBody;
 }

package/lib/utils.d.ts

@@ -49,7 +49,7 @@ export declare function assignOnlyExistingConfig<T extends string | {
 export declare function getMatchingStatusCodeRange(code: number | string): string;
 export declare function isCustomRuleId(id: string): boolean;
 export declare function doesYamlFileExist(filePath: string): boolean;
-export declare function showWarningForDeprecatedField(deprecatedField: string, updatedField?: string, updatedObject?: string): void;
+export declare function showWarningForDeprecatedField(deprecatedField: string, updatedField?: string, updatedObject?: string, link?: string): void;
 export declare function showErrorForDeprecatedField(deprecatedField: string, updatedField?: string, updatedObject?: string): void;
 export type Falsy = undefined | null | false | '' | 0;
 export declare function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy;

package/lib/utils.js

@@ -218,10 +218,11 @@ function doesYamlFileExist(filePath) {
         fs?.hasOwnProperty?.('existsSync') &&
         fs.existsSync(filePath));
 }
-function showWarningForDeprecatedField(deprecatedField, updatedField, updatedObject) {
+function showWarningForDeprecatedField(deprecatedField, updatedField, updatedObject, link) {
+    const readMoreText = link ? `Read more about this change: ${link}` : '';
     logger_1.logger.warn(`The '${logger_1.colorize.red(deprecatedField)}' field is deprecated. ${updatedField
         ? `Use ${logger_1.colorize.green(getUpdatedFieldName(updatedField, updatedObject))} instead. `
-        : ''}Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+        : ''}${readMoreText}\n`);
 }
 function showErrorForDeprecatedField(deprecatedField, updatedField, updatedObject) {
     throw new Error(`Do not use '${deprecatedField}' field. ${updatedField ? `Use '${getUpdatedFieldName(updatedField, updatedObject)}' instead. ` : ''}\n`);

package/lib/visitors.d.ts

@@ -6,7 +6,7 @@ import type { Oas3Definition, Oas3ExternalDocs, Oas3Info, Oas3Contact, Oas3Compo
 import type { Oas2Definition, Oas2Tag, Oas2ExternalDocs, Oas2SecurityRequirement, Oas2Info, Oas2Contact, Oas2License, Oas2PathItem, Oas2Operation, Oas2Header, Oas2Response, Oas2Schema, Oas2Xml, Oas2Parameter, Oas2SecurityScheme } from './typings/swagger';
 import type { Async2Definition } from './typings/asyncapi';
 import type { Async3Definition } from './typings/asyncapi3';
-import type { ArazzoDefinition, ArazzoSourceDescription, CriteriaObject, ExpectSchema, ExtendedOperation, InfoObject, NoneSourceDescription, OnFailureObject, OnSuccessObject, OpenAPISourceDescription, Parameter, Replacement, RequestBody, SourceDescription, Step, Workflow } from './typings/arazzo';
+import type { ArazzoDefinition, ArazzoSourceDescription, CriteriaObject, ExtendedOperation, InfoObject, OnFailureObject, OnSuccessObject, OpenAPISourceDescription, Parameter, Replacement, RequestBody, SourceDescription, Step, Workflow } from './typings/arazzo';
 export type SkipFunctionContext = Pick<UserContext, 'location' | 'rawNode' | 'resolve' | 'rawLocation'>;
 export type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
@@ -149,11 +149,9 @@ type ArazzoFlatVisitor = {
     ParameterObject?: VisitFunctionOrObject<Parameter>;
     InfoObject?: VisitFunctionOrObject<InfoObject>;
     OpenAPISourceDescription?: VisitFunctionOrObject<OpenAPISourceDescription>;
-    NoneSourceDescription?: VisitFunctionOrObject<NoneSourceDescription>;
     ArazzoSourceDescription?: VisitFunctionOrObject<ArazzoSourceDescription>;
     SourceDescription?: VisitFunctionOrObject<SourceDescription>;
     ExtendedOperation?: VisitFunctionOrObject<ExtendedOperation>;
-    ExpectSchema?: VisitFunctionOrObject<ExpectSchema>;
     Replacement?: VisitFunctionOrObject<Replacement>;
     RequestBody?: VisitFunctionOrObject<RequestBody>;
     CriteriaObject?: VisitFunctionOrObject<CriteriaObject>;
@@ -183,7 +181,7 @@ export type Oas3Visitor = BaseVisitor & Oas3NestedVisitor & Record<string, Visit
 export type Oas2Visitor = BaseVisitor & Oas2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas2NestedVisitor>>;
 export type Async2Visitor = BaseVisitor & Async2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async2NestedVisitor>>;
 export type Async3Visitor = BaseVisitor & Async3NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async3NestedVisitor>>;
-export type ArazzoVisitor = BaseVisitor & ArazzoNestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, ArazzoNestedVisitor>>;
+export type Arazzo1Visitor = BaseVisitor & ArazzoNestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, ArazzoNestedVisitor>>;
 export type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 export type NormalizedOasVisitors<T extends BaseVisitor> = {
     [V in keyof T]-?: {
@@ -204,17 +202,17 @@ export type Oas3Rule = (options: Record<string, any>) => Oas3Visitor | Oas3Visit
 export type Oas2Rule = (options: Record<string, any>) => Oas2Visitor | Oas2Visitor[];
 export type Async2Rule = (options: Record<string, any>) => Async2Visitor | Async2Visitor[];
 export type Async3Rule = (options: Record<string, any>) => Async3Visitor | Async3Visitor[];
-export type ArazzoRule = (options: Record<string, any>) => ArazzoVisitor | ArazzoVisitor[];
+export type Arazzo1Rule = (options: Record<string, any>) => Arazzo1Visitor | Arazzo1Visitor[];
 export type Oas3Preprocessor = (options: Record<string, any>) => Oas3Visitor;
 export type Oas2Preprocessor = (options: Record<string, any>) => Oas2Visitor;
 export type Async2Preprocessor = (options: Record<string, any>) => Async2Visitor;
 export type Async3Preprocessor = (options: Record<string, any>) => Async3Visitor;
-export type ArazzoPreprocessor = (options: Record<string, any>) => ArazzoVisitor;
+export type Arazzo1Preprocessor = (options: Record<string, any>) => Arazzo1Visitor;
 export type Oas3Decorator = (options: Record<string, any>) => Oas3Visitor;
 export type Oas2Decorator = (options: Record<string, any>) => Oas2Visitor;
 export type Async2Decorator = (options: Record<string, any>) => Async2Visitor;
 export type Async3Decorator = (options: Record<string, any>) => Async3Visitor;
-export type ArazzoDecorator = (options: Record<string, any>) => ArazzoVisitor;
+export type Arazzo1Decorator = (options: Record<string, any>) => Arazzo1Visitor;
 export type OasRule = Oas3Rule;
 export type OasPreprocessor = Oas3Preprocessor;
 export type OasDecorator = Oas3Decorator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.25.14",
+  "version": "1.26.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "@redocly/ajv": "^8.11.2",
-    "@redocly/config": "^0.16.0",
+    "@redocly/config": "^0.17.0",
     "colorette": "^1.2.0",
     "https-proxy-agent": "^7.0.4",
     "js-levenshtein": "^1.1.6",

package/src/__tests__/lint.test.ts

@@ -295,7 +295,7 @@ describe('lint', () => {
             },
           ],
           "message": "Expected type \`License\` (object) but got \`string\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -324,7 +324,7 @@ describe('lint', () => {
             },
           ],
           "message": "Expected type \`License\` (object) but got \`string\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -1611,7 +1611,7 @@ describe('lint', () => {
             },
           ],
           "message": "Property \`dependentRequired\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },

package/src/bundle.ts

@@ -163,7 +163,7 @@ export async function bundleDocument(opts: {
   } = opts;
   const specVersion = detectSpec(document.parsed);
   const specMajorVersion = getMajorSpecVersion(specVersion);
-  const rules = config.getRulesForOasVersion(specMajorVersion);
+  const rules = config.getRulesForSpecVersion(specMajorVersion);
   const types = normalizeTypes(
     config.extendTypes(customTypes ?? getTypes(specVersion), specVersion),
     config
@@ -303,7 +303,7 @@ export function mapTypeToComponent(typeName: string, version: SpecMajorVersion)
         default:
           return null;
       }
-    case SpecMajorVersion.Arazzo:
+    case SpecMajorVersion.Arazzo1:
       switch (typeName) {
         case 'Root.workflows_items.parameters_items':
         case 'Root.workflows_items.steps_items.parameters_items':
@@ -408,7 +408,7 @@ function makeBundleVisitor(
           components = root.components = root.components || {};
         } else if (version === SpecMajorVersion.Async3) {
           components = root.components = root.components || {};
-        } else if (version === SpecMajorVersion.Arazzo) {
+        } else if (version === SpecMajorVersion.Arazzo1) {
           components = root.components = root.components || {};
         }
       },