@redocly/openapi-core 1.25.15 → 1.26.0

package/src/rules/async3/index.ts

@@ -1,5 +1,5 @@
 import { Assertions } from '../common/assertions';
-import { Spec } from '../common/spec';
+import { Struct } from '../common/struct';
 import { InfoContact } from '../common/info-contact';
 import { InfoLicenseStrict } from '../common/info-license-strict';
 import { OperationOperationId } from '../common/operation-operationId';
@@ -12,7 +12,10 @@ import type { Async3Rule } from '../../visitors';
 import type { Async3RuleSet } from '../../oas-types';
 
 export const rules: Async3RuleSet<'built-in'> = {
-  spec: Spec as Async3Rule,
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  //@ts-ignore TODO: This is depricated property `spec` and should be removed in the future
+  spec: Struct as Async3Rule,
+  struct: Struct as Async3Rule,
   assertions: Assertions as Async3Rule,
   'info-contact': InfoContact as Async3Rule,
   'info-license-strict': InfoLicenseStrict as Async3Rule,

package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts

@@ -200,7 +200,7 @@ describe('Oas3 typed enum', () => {
             },
           ],
           "message": "Expected type \`Schema\` (object) but got \`null\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },

package/src/rules/common/__tests__/{spec.test.ts → struct.test.ts}

@@ -3,7 +3,7 @@ import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
-describe('Oas3 spec', () => {
+describe('Oas3 struct', () => {
   it('should report missing schema property', async () => {
     const document = parseYamlToDocument(
       outdent`
@@ -25,7 +25,7 @@ describe('Oas3 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -40,7 +40,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`info\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -54,7 +54,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "Must contain at least one of the following fields: schema, content.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -85,7 +85,7 @@ describe('Oas3 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -100,7 +100,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`paths\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -114,7 +114,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`info\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -131,7 +131,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "Property \`content\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -157,7 +157,7 @@ describe('Oas3 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -172,7 +172,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`paths\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -186,7 +186,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`info\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -199,7 +199,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The \`type\` field must be defined when the \`nullable\` field is used.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -231,7 +231,7 @@ describe('Oas3 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -246,7 +246,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`paths\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -260,7 +260,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`info\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -273,7 +273,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The \`type\` field must be defined when the \`nullable\` field is used.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -287,7 +287,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`content\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -301,7 +301,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "Property \`TestSchema\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -322,7 +322,7 @@ describe('Oas3 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -337,7 +337,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`paths\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -351,7 +351,7 @@ describe('Oas3 spec', () => {
             },
           ],
           "message": "The field \`info\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -360,7 +360,7 @@ describe('Oas3 spec', () => {
   });
 });
 
-describe('Oas3.1 spec', () => {
+describe('Oas3.1 struct', () => {
   it('should report with "type can be one of the following only"', async () => {
     const document = parseYamlToDocument(
       outdent`
@@ -384,7 +384,7 @@ describe('Oas3.1 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -399,7 +399,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "\`type\` can be one of the following only: "object", "array", "string", "number", "integer", "boolean", "null".",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -432,7 +432,7 @@ describe('Oas3.1 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -447,7 +447,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "\`type\` can be one of the following only: "object", "array", "string", "number", "integer", "boolean", "null".",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -486,7 +486,7 @@ describe('Oas3.1 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -501,7 +501,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "\`type\` can be one of the following only: "object", "array", "string", "number", "integer", "boolean", "null".",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [
             "object",
@@ -523,7 +523,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "\`type\` can be one of the following only: "object", "array", "string", "number", "integer", "boolean", "null".",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [
             "object",
@@ -557,7 +557,7 @@ describe('Oas3.1 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -572,7 +572,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "Must contain at least one of the following fields: paths, components, webhooks.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -586,7 +586,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "The field \`title\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -600,7 +600,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "The field \`version\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -632,7 +632,7 @@ describe('Oas3.1 spec', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ rules: { spec: 'error' } }),
+      config: await makeConfig({ rules: { struct: 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -647,7 +647,7 @@ describe('Oas3.1 spec', () => {
             },
           ],
           "message": "Expected type \`SchemaMap\` (object) but got \`array\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },

package/src/rules/common/assertions/index.ts

@@ -3,7 +3,7 @@ import { isString } from '../../../utils';
 
 import type { asserts, AssertionFn } from './asserts';
 import type {
-  ArazzoVisitor,
+  Arazzo1Visitor,
   Async2Visitor,
   Async3Visitor,
   Oas2Visitor,
@@ -35,7 +35,7 @@ export type RawAssertion = AssertionDefinition & {
 export type Assertion = RawAssertion & { assertionId: string };
 
 export const Assertions = (opts: Record<string, Assertion>) => {
-  const visitors: (Oas2Visitor | Oas3Visitor | Async2Visitor | Async3Visitor | ArazzoVisitor)[] =
+  const visitors: (Oas2Visitor | Oas3Visitor | Async2Visitor | Async3Visitor | Arazzo1Visitor)[] =
     [];
 
   // As 'Assertions' has an array of asserts,

package/src/rules/common/{spec.ts → struct.ts}

@@ -4,9 +4,9 @@ import { isRef } from '../../ref-utils';
 import { isPlainObject } from '../../utils';
 
 import type { UserContext } from '../../walk';
-import type { Oas3Rule, Oas2Rule, Async2Rule, Async3Rule, ArazzoRule } from '../../visitors';
+import type { Oas3Rule, Oas2Rule, Async2Rule, Async3Rule, Arazzo1Rule } from '../../visitors';
 
-export const Spec: Oas3Rule | Oas2Rule | Async2Rule | Async3Rule | ArazzoRule = () => {
+export const Struct: Oas3Rule | Oas2Rule | Async2Rule | Async3Rule | Arazzo1Rule = () => {
   return {
     any(
       node: any,

package/src/rules/oas2/index.ts

@@ -1,4 +1,4 @@
-import { Spec } from '../common/spec';
+import { Struct } from '../common/struct';
 import { NoInvalidSchemaExamples } from '../common/no-invalid-schema-examples';
 import { NoInvalidParameterExamples } from '../common/no-invalid-parameter-examples';
 import { InfoContact } from '../common/info-contact';
@@ -47,7 +47,10 @@ import type { Oas2Rule } from '../../visitors';
 import type { Oas2RuleSet } from '../../oas-types';
 
 export const rules: Oas2RuleSet<'built-in'> = {
-  spec: Spec as Oas2Rule,
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  //@ts-ignore TODO: This is depricated property `spec` and should be removed in the future
+  spec: Struct as Oas2Rule,
+  struct: Struct as Oas2Rule,
   'no-invalid-schema-examples': NoInvalidSchemaExamples,
   'no-invalid-parameter-examples': NoInvalidParameterExamples,
   'info-contact': InfoContact as Oas2Rule,

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -65,7 +65,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Expected type \`string\` but got \`array\`.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -79,7 +79,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Expected type \`string\` but got \`boolean\`.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -93,7 +93,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Expected type \`License\` (object) but got \`string\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -124,7 +124,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Expected type \`string\` but got \`integer\`.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -138,7 +138,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Expected type \`Tag\` (object) but got \`number\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -152,7 +152,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Expected type \`Tag\` (object) but got \`string\`",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -199,7 +199,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Property \`components1\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [
             "components",
@@ -228,7 +228,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "Property \`test\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -270,7 +270,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "The field \`paths\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },
@@ -297,7 +297,7 @@ describe('Oas3 Structural visitor basic', () => {
             },
           ],
           "message": "The field \`title\` must be present on this level.",
-          "ruleId": "spec",
+          "ruleId": "struct",
           "severity": "error",
           "suggest": [],
         },

package/src/rules/oas3/index.ts

@@ -1,4 +1,4 @@
-import { Spec } from '../common/spec';
+import { Struct } from '../common/struct';
 import { Operation2xxResponse } from '../common/operation-2xx-response';
 import { Operation4xxResponse } from '../common/operation-4xx-response';
 import { Assertions } from '../common/assertions';
@@ -59,7 +59,10 @@ import type { Oas3RuleSet } from '../../oas-types';
 import type { Oas3Rule } from '../../visitors';
 
 export const rules: Oas3RuleSet<'built-in'> = {
-  spec: Spec as Oas3Rule,
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  //@ts-ignore TODO: This is depricated property `spec` and should be removed in the future
+  spec: Struct as Oas3Rule,
+  struct: Struct as Oas3Rule,
   'info-contact': InfoContact as Oas3Rule,
   'info-license': InfoLicense as Oas3Rule,
   'info-license-url': InfoLicenseUrl as Oas3Rule,

package/src/rules/spot/no-actions-type-end.ts

@@ -1,7 +1,7 @@
-import type { ArazzoRule } from '../../visitors';
+import type { Arazzo1Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 
-export const NoActionsTypeEnd: ArazzoRule = () => {
+export const NoActionsTypeEnd: Arazzo1Rule = () => {
   return {
     FailureActionObject: {
       enter(action, { report, location }: UserContext) {

package/src/rules/spot/no-criteria-xpath.ts

@@ -1,7 +1,7 @@
-import type { ArazzoRule } from '../../visitors';
+import type { Arazzo1Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 
-export const NoCriteriaXpath: ArazzoRule = () => {
+export const NoCriteriaXpath: Arazzo1Rule = () => {
   return {
     CriterionObject: {
       enter(criteria, { report, location }: UserContext) {

package/src/rules/spot/parameters-not-in-body.ts

@@ -1,7 +1,7 @@
-import type { ArazzoRule } from '../../visitors';
+import type { Arazzo1Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 
-export const ParametersNotInBody: ArazzoRule = () => {
+export const ParametersNotInBody: Arazzo1Rule = () => {
   return {
     Parameter: {
       enter(parameter, { report, location }: UserContext) {

package/src/rules/spot/version-enum.ts

@@ -1,10 +1,10 @@
 import { ARAZZO_VERSIONS_SUPPORTED_BY_SPOT } from '../../typings/arazzo';
 import { pluralize } from '../../utils';
 
-import type { ArazzoRule } from '../../visitors';
+import type { Arazzo1Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
 
-export const VersionEnum: ArazzoRule = () => {
+export const VersionEnum: Arazzo1Rule = () => {
   const supportedVersions = ARAZZO_VERSIONS_SUPPORTED_BY_SPOT.join(', ');
   return {
     Root: {

package/src/types/arazzo.ts

@@ -50,10 +50,8 @@ const SourceDescriptions: NodeType = {
   items: (value: any) => {
     if (value?.type === 'openapi') {
       return 'OpenAPISourceDescription';
-    } else if (value?.type === 'arazzo') {
-      return 'ArazzoSourceDescription';
     } else {
-      return 'NoneSourceDescription';
+      return 'ArazzoSourceDescription';
     }
   },
 };
@@ -67,15 +65,6 @@ const OpenAPISourceDescription: NodeType = {
   required: ['name', 'type', 'url'],
   extensionsPrefix: 'x-',
 };
-const NoneSourceDescription: NodeType = {
-  properties: {
-    name: { type: 'string' },
-    type: { type: 'string', enum: ['none'] },
-    'x-serverUrl': { type: 'string' },
-  },
-  required: ['name', 'type', 'x-serverUrl'],
-  extensionsPrefix: 'x-',
-};
 const ArazzoSourceDescription: NodeType = {
   properties: {
     name: { type: 'string' },
@@ -273,12 +262,11 @@ const OnFailureActionList: NodeType = {
   },
 };
 
-export const ArazzoTypes: Record<string, NodeType> = {
+export const Arazzo1Types: Record<string, NodeType> = {
   Root,
   Info,
   SourceDescriptions,
   OpenAPISourceDescription,
-  NoneSourceDescription,
   ArazzoSourceDescription,
   Parameters,
   Parameter,