@redocly/openapi-core 1.0.0-beta.111 → 1.0.0-beta.113

package/src/rules/utils.ts

@@ -118,6 +118,10 @@ export function validateExample(
       }
     }
   } catch (e) {
+    if (e.message === 'discriminator: requires oneOf or anyOf composite keyword') {
+      return;
+    }
+
     report({
       message: `Example validation errored: ${e.message}.`,
       location: location.child('schema'),

package/src/types/oas2.ts

@@ -16,8 +16,8 @@ const Root: NodeType = {
     parameters: 'NamedParameters',
     responses: 'NamedResponses',
     securityDefinitions: 'NamedSecuritySchemes',
-    security: listOf('SecurityRequirement'),
-    tags: listOf('Tag'),
+    security: 'SecurityRequirementList',
+    tags: 'TagList',
     externalDocs: 'ExternalDocs',
   },
   required: ['swagger', 'paths', 'info'],
@@ -60,7 +60,7 @@ const Paths: NodeType = {
 const PathItem: NodeType = {
   properties: {
     $ref: { type: 'string' }, // TODO: verify special $ref handling for Path Item
-    parameters: listOf('Parameter'),
+    parameters: 'ParameterList',
 
     get: 'Operation',
     put: 'Operation',
@@ -81,13 +81,13 @@ const Operation: NodeType = {
     operationId: { type: 'string' },
     consumes: { type: 'array', items: { type: 'string' } },
     produces: { type: 'array', items: { type: 'string' } },
-    parameters: listOf('Parameter'),
+    parameters: 'ParameterList',
     responses: 'Responses',
     schemes: { type: 'array', items: { type: 'string' } },
     deprecated: { type: 'boolean' },
-    security: listOf('SecurityRequirement'),
-    'x-codeSamples': listOf('XCodeSample'),
-    'x-code-samples': listOf('XCodeSample'), // deprecated
+    security: 'SecurityRequirementList',
+    'x-codeSamples': 'XCodeSampleList',
+    'x-code-samples': 'XCodeSampleList', // deprecated
     'x-hideTryItPanel': { type: 'boolean' },
   },
   required: ['responses'],
@@ -371,8 +371,10 @@ const SecurityRequirement: NodeType = {
 export const Oas2Types: Record<string, NodeType> = {
   Root,
   Tag,
+  TagList: listOf('Tag'),
   ExternalDocs,
   SecurityRequirement,
+  SecurityRequirementList: listOf('SecurityRequirement'),
   Info,
   Contact,
   License,
@@ -380,6 +382,7 @@ export const Oas2Types: Record<string, NodeType> = {
   PathItem,
   Parameter,
   ParameterItems,
+  ParameterList: listOf('Parameter'),
   Operation,
   Examples,
   Header,
@@ -394,4 +397,5 @@ export const Oas2Types: Record<string, NodeType> = {
   NamedSecuritySchemes: mapOf('SecurityScheme'),
   SecurityScheme,
   XCodeSample,
+  XCodeSampleList: listOf('XCodeSample'),
 };

package/src/types/oas3.ts

@@ -6,9 +6,9 @@ const Root: NodeType = {
   properties: {
     openapi: null,
     info: 'Info',
-    servers: listOf('Server'),
-    security: listOf('SecurityRequirement'),
-    tags: listOf('Tag'),
+    servers: 'ServerList',
+    security: 'SecurityRequirementList',
+    tags: 'TagList',
     externalDocs: 'ExternalDocs',
     paths: 'Paths',
     components: 'Components',
@@ -102,8 +102,8 @@ const WebhooksMap: NodeType = {
 const PathItem: NodeType = {
   properties: {
     $ref: { type: 'string' }, // TODO: verify special $ref handling for Path Item
-    servers: listOf('Server'),
-    parameters: listOf('Parameter'),
+    servers: 'ServerList',
+    parameters: 'ParameterList',
     summary: { type: 'string' },
     description: { type: 'string' },
     get: 'Operation',
@@ -149,15 +149,15 @@ const Operation: NodeType = {
     description: { type: 'string' },
     externalDocs: 'ExternalDocs',
     operationId: { type: 'string' },
-    parameters: listOf('Parameter'),
-    security: listOf('SecurityRequirement'),
-    servers: listOf('Server'),
+    parameters: 'ParameterList',
+    security: 'SecurityRequirementList',
+    servers: 'ServerList',
     requestBody: 'RequestBody',
     responses: 'Responses',
     deprecated: { type: 'boolean' },
     callbacks: 'CallbacksMap',
-    'x-codeSamples': listOf('XCodeSample'),
-    'x-code-samples': listOf('XCodeSample'), // deprecated
+    'x-codeSamples': 'XCodeSampleList',
+    'x-code-samples': 'XCodeSampleList', // deprecated
     'x-hideTryItPanel': { type: 'boolean' },
   },
   required: ['responses'],
@@ -462,17 +462,21 @@ const SecurityScheme: NodeType = {
 export const Oas3Types: Record<string, NodeType> = {
   Root,
   Tag,
+  TagList: listOf('Tag'),
   ExternalDocs,
   Server,
+  ServerList: listOf('Server'),
   ServerVariable,
   ServerVariablesMap: mapOf('ServerVariable'),
   SecurityRequirement,
+  SecurityRequirementList: listOf('SecurityRequirement'),
   Info,
   Contact,
   License,
   Paths,
   PathItem,
   Parameter,
+  ParameterList: listOf('Parameter'),
   Operation,
   Callback: mapOf('PathItem'),
   CallbacksMap: mapOf('Callback'),
@@ -511,5 +515,6 @@ export const Oas3Types: Record<string, NodeType> = {
   OAuth2Flows,
   SecurityScheme,
   XCodeSample,
+  XCodeSampleList: listOf('XCodeSample'),
   WebhooksMap,
 };

package/src/types/oas3_1.ts

@@ -81,6 +81,7 @@ const Operation: NodeType = {
 const Schema: NodeType = {
   properties: {
     $id: { type: 'string' },
+    $anchor: { type: 'string' },
     id: { type: 'string' },
     $schema: { type: 'string' },
     definitions: 'NamedSchemas',

package/src/types/redocly-yaml.ts

@@ -3,7 +3,6 @@ import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
 
 const builtInRulesList = [
   'spec',
-  'info-description',
   'info-contact',
   'info-license',
   'info-license-url',
@@ -58,17 +57,21 @@ const builtInRulesList = [
 const nodeTypesList = [
   'Root',
   'Tag',
+  'TagList',
   'ExternalDocs',
   'Server',
+  'ServerList',
   'ServerVariable',
   'ServerVariablesMap',
   'SecurityRequirement',
+  'SecurityRequirementList',
   'Info',
   'Contact',
   'License',
   'Paths',
   'PathItem',
   'Parameter',
+  'ParameterList',
   'Operation',
   'Callback',
   'CallbacksMap',
@@ -107,6 +110,7 @@ const nodeTypesList = [
   'OAuth2Flows',
   'SecurityScheme',
   'XCodeSample',
+  'XCodeSampleList',
   'WebhooksMap',
 ];
 
@@ -147,16 +151,8 @@ const ConfigRoot: NodeType = {
   properties: {
     organization: { type: 'string' },
     apis: 'ConfigApis',
-    apiDefinitions: {
-      type: 'object',
-      properties: {},
-      additionalProperties: { properties: { type: 'string' } },
-    }, // deprecated
     ...RootConfigStyleguide.properties,
-    styleguide: 'RootConfigStyleguide', // deprecated
-    lint: 'RootConfigStyleguide', // deprecated
     'features.openapi': 'ConfigReferenceDocs',
-    referenceDocs: 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer',
     region: { enum: ['us', 'eu'] },
     resolve: {
@@ -239,15 +235,9 @@ const ObjectRule: NodeType = {
   required: ['severity'],
 };
 
-const Assert: NodeType = {
+const AssertionDefinitionSubject: NodeType = {
   properties: {
-    subject: (value: unknown) => {
-      if (Array.isArray(value)) {
-        return { type: 'array', items: { enum: nodeTypesList } };
-      } else {
-        return { enum: nodeTypesList };
-      }
-    },
+    type: { enum: nodeTypesList },
     property: (value: unknown) => {
       if (Array.isArray(value)) {
         return { type: 'array', items: { type: 'string' } };
@@ -257,10 +247,15 @@ const Assert: NodeType = {
         return { type: 'string' };
       }
     },
-    context: listOf('Context'),
-    message: { type: 'string' },
-    suggest: { type: 'array', items: { type: 'string' } },
-    severity: { enum: ['error', 'warn', 'off'] },
+    filterInParentKeys: { type: 'array', items: { type: 'string' } },
+    filterOutParentKeys: { type: 'array', items: { type: 'string' } },
+    matchParentKeys: { type: 'string' },
+  },
+  required: ['type'],
+};
+
+const AssertionDefinitionAssertions: NodeType = {
+  properties: {
     enum: { type: 'array', items: { type: 'string' } },
     pattern: { type: 'string' },
     casing: {
@@ -280,27 +275,50 @@ const Assert: NodeType = {
     requireAny: { type: 'array', items: { type: 'string' } },
     disallowed: { type: 'array', items: { type: 'string' } },
     defined: { type: 'boolean' },
-    undefined: { type: 'boolean' },
+    // undefined: { type: 'boolean' }, // TODO: Remove `undefined` assertion from codebase overall
     nonEmpty: { type: 'boolean' },
     minLength: { type: 'integer' },
     maxLength: { type: 'integer' },
     ref: (value: string | boolean) =>
       typeof value === 'string' ? { type: 'string' } : { type: 'boolean' },
+    const: (value: string | boolean | number) => {
+      if (typeof value === 'string') {
+        return { type: 'string' };
+      }
+      if (typeof value === 'number') {
+        return { type: 'number' };
+      }
+      if (typeof value === 'boolean') {
+        return { type: 'boolean' };
+      } else {
+        return;
+      }
+    },
   },
   additionalProperties: (_value: unknown, key: string) => {
     if (/^\w+\/\w+$/.test(key)) return { type: 'object' };
     return;
   },
-  required: ['subject'],
 };
 
-const Context: NodeType = {
+const AssertDefinition: NodeType = {
   properties: {
-    type: { enum: nodeTypesList },
-    matchParentKeys: { type: 'array', items: { type: 'string' } },
-    excludeParentKeys: { type: 'array', items: { type: 'string' } },
+    subject: 'AssertionDefinitionSubject',
+    assertions: 'AssertionDefinitionAssertions',
   },
-  required: ['type'],
+  required: ['subject', 'assertions'],
+};
+
+const Assert: NodeType = {
+  properties: {
+    subject: 'AssertionDefinitionSubject',
+    assertions: 'AssertionDefinitionAssertions',
+    where: listOf('AssertDefinition'),
+    message: { type: 'string' },
+    suggest: { type: 'array', items: { type: 'string' } },
+    severity: { enum: ['error', 'warn', 'off'] },
+  },
+  required: ['subject', 'assertions'],
 };
 
 const ConfigLanguage: NodeType = {
@@ -926,7 +944,7 @@ export const ConfigTypes: Record<string, NodeType> = {
   ConfigSidebarLinks,
   CommonConfigSidebarLinks,
   ConfigTheme,
-  Context,
+  AssertDefinition,
   ThemeColors,
   CommonThemeColors,
   BorderThemeColors,
@@ -973,4 +991,6 @@ export const ConfigTypes: Record<string, NodeType> = {
   Sidebar,
   Heading,
   Typography,
+  AssertionDefinitionAssertions,
+  AssertionDefinitionSubject,
 };

package/src/utils.ts

@@ -232,6 +232,11 @@ export function identity<T>(value: T): T {
   return value;
 }
 
+export function keysOf<T>(obj: T) {
+  if (!obj) return [];
+  return Object.keys(obj) as (keyof T)[];
+}
+
 export function pickDefined<T extends Record<string, unknown>>(
   obj?: T
 ): Record<string, unknown> | undefined {
@@ -244,3 +249,9 @@ export function pickDefined<T extends Record<string, unknown>>(
   }
   return res;
 }
+
+export function nextTick() {
+  new Promise((resolve) => {
+    setTimeout(resolve);
+  });
+}

package/src/visitors.ts

@@ -50,6 +50,11 @@ import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
 
+export type SkipFunctionContext = Pick<
+  UserContext,
+  'location' | 'rawNode' | 'resolve' | 'rawLocation'
+>;
+
 export type VisitFunction<T> = (
   node: T,
   ctx: UserContext & { ignoreNextVisitorsOnNode: () => void },
@@ -59,7 +64,7 @@ export type VisitFunction<T> = (
 
 type VisitRefFunction = (node: OasRef, ctx: UserContext, resolved: ResolveResult<any>) => void;
 
-type SkipFunction<T> = (node: T, key: string | number) => boolean;
+type SkipFunction<T> = (node: T, key: string | number, ctx: SkipFunctionContext) => boolean;
 
 type VisitObject<T> = {
   enter?: VisitFunction<T>;
@@ -210,6 +215,7 @@ const legacyTypesMap = {
   HeadersMap: 'HeaderMap',
   LinksMap: 'LinkMap',
   OAuth2Flows: 'SecuritySchemeFlows',
+  Responses: 'ResponsesMap',
 };
 
 type Oas3NestedVisitor = {

package/src/walk.ts

@@ -226,7 +226,14 @@ export function walkDocument<T>(opts: {
               nextLevelTypeActivated: null,
               withParentNode: context.parent?.activatedOn?.value.node,
               skipped:
-                (context.parent?.activatedOn?.value.skipped || skip?.(resolvedNode, key)) ?? false,
+                (context.parent?.activatedOn?.value.skipped ||
+                  skip?.(resolvedNode, key, {
+                    location,
+                    rawLocation,
+                    resolve,
+                    rawNode: node,
+                  })) ??
+                false,
             };
 
             context.activatedOn = pushStack<any>(context.activatedOn, activatedOn);