@redocly/openapi-core 1.0.0-beta.117 → 1.0.0-beta.119

package/src/types/oas2.ts

@@ -24,6 +24,7 @@ const Root: NodeType = {
     'x-ignoredHeaderParameters': { type: 'array', items: { type: 'string' } },
   },
   required: ['swagger', 'paths', 'info'],
+  extensionsPrefix: 'x-',
 };
 
 const Info: NodeType = {
@@ -37,6 +38,7 @@ const Info: NodeType = {
     'x-logo': 'Logo',
   },
   required: ['title', 'version'],
+  extensionsPrefix: 'x-',
 };
 
 const Logo: NodeType = {
@@ -46,6 +48,7 @@ const Logo: NodeType = {
     backgroundColor: { type: 'string' },
     href: { type: 'string' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const Contact: NodeType = {
@@ -54,6 +57,7 @@ const Contact: NodeType = {
     url: { type: 'string' },
     email: { type: 'string' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const License: NodeType = {
@@ -62,6 +66,7 @@ const License: NodeType = {
     url: { type: 'string' },
   },
   required: ['name'],
+  extensionsPrefix: 'x-',
 };
 
 const Paths: NodeType = {
@@ -83,6 +88,7 @@ const PathItem: NodeType = {
     head: 'Operation',
     patch: 'Operation',
   },
+  extensionsPrefix: 'x-',
 };
 
 const Operation: NodeType = {
@@ -104,6 +110,7 @@ const Operation: NodeType = {
     'x-hideTryItPanel': { type: 'boolean' },
   },
   required: ['responses'],
+  extensionsPrefix: 'x-',
 };
 
 const XCodeSample: NodeType = {
@@ -128,6 +135,7 @@ const ExternalDocs: NodeType = {
     url: { type: 'string' },
   },
   required: ['url'],
+  extensionsPrefix: 'x-',
 };
 
 const Parameter: NodeType = {
@@ -172,6 +180,7 @@ const Parameter: NodeType = {
       }
     }
   },
+  extensionsPrefix: 'x-',
 };
 
 const ParameterItems: NodeType = {
@@ -201,6 +210,7 @@ const ParameterItems: NodeType = {
       return ['type'];
     }
   },
+  extensionsPrefix: 'x-',
 };
 
 const Responses: NodeType = {
@@ -220,6 +230,7 @@ const Response: NodeType = {
     'x-summary': { type: 'string' },
   },
   required: ['description'],
+  extensionsPrefix: 'x-',
 };
 
 const Examples: NodeType = {
@@ -255,6 +266,7 @@ const Header: NodeType = {
       return ['type'];
     }
   },
+  extensionsPrefix: 'x-',
 };
 
 const Tag: NodeType = {
@@ -266,6 +278,7 @@ const Tag: NodeType = {
     'x-displayName': { type: 'string' },
   },
   required: ['name'],
+  extensionsPrefix: 'x-',
 };
 
 const TagGroup: NodeType = {
@@ -328,6 +341,7 @@ const Schema: NodeType = {
     'x-explicitMappingOnly': { type: 'boolean' },
     'x-enumDescriptions': 'EnumDescriptions',
   },
+  extensionsPrefix: 'x-',
 };
 
 const EnumDescriptions: NodeType = {
@@ -348,6 +362,7 @@ const Xml: NodeType = {
     attribute: { type: 'boolean' },
     wrapped: { type: 'boolean' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const SecurityScheme: NodeType = {
@@ -419,6 +434,7 @@ const Example: NodeType = {
     description: { type: 'string' },
     externalValue: { type: 'string' },
   },
+  extensionsPrefix: 'x-',
 };
 
 export const Oas2Types: Record<string, NodeType> = {

package/src/types/oas3.ts

@@ -17,6 +17,7 @@ const Root: NodeType = {
     'x-ignoredHeaderParameters': { type: 'array', items: { type: 'string' } },
   },
   required: ['openapi', 'paths', 'info'],
+  extensionsPrefix: 'x-',
 };
 
 const Tag: NodeType = {
@@ -28,6 +29,7 @@ const Tag: NodeType = {
     'x-displayName': { type: 'string' },
   },
   required: ['name'],
+  extensionsPrefix: 'x-',
 };
 
 const TagGroup: NodeType = {
@@ -35,6 +37,7 @@ const TagGroup: NodeType = {
     name: { type: 'string' },
     tags: { type: 'array', items: { type: 'string' } },
   },
+  extensionsPrefix: 'x-',
 };
 
 const ExternalDocs: NodeType = {
@@ -43,6 +46,7 @@ const ExternalDocs: NodeType = {
     url: { type: 'string' },
   },
   required: ['url'],
+  extensionsPrefix: 'x-',
 };
 
 const Server: NodeType = {
@@ -52,6 +56,7 @@ const Server: NodeType = {
     variables: 'ServerVariablesMap',
   },
   required: ['url'],
+  extensionsPrefix: 'x-',
 };
 
 const ServerVariable: NodeType = {
@@ -64,6 +69,7 @@ const ServerVariable: NodeType = {
     description: null,
   },
   required: ['default'],
+  extensionsPrefix: 'x-',
 };
 
 const SecurityRequirement: NodeType = {
@@ -82,6 +88,7 @@ const Info: NodeType = {
     'x-logo': 'Logo',
   },
   required: ['title', 'version'],
+  extensionsPrefix: 'x-',
 };
 
 const Logo: NodeType = {
@@ -99,6 +106,7 @@ const Contact: NodeType = {
     url: { type: 'string' },
     email: { type: 'string' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const License: NodeType = {
@@ -107,6 +115,7 @@ const License: NodeType = {
     url: { type: 'string' },
   },
   required: ['name'],
+  extensionsPrefix: 'x-',
 };
 
 const Paths: NodeType = {
@@ -136,6 +145,7 @@ const PathItem: NodeType = {
     patch: 'Operation',
     trace: 'Operation',
   },
+  extensionsPrefix: 'x-',
 };
 
 const Parameter: NodeType = {
@@ -158,6 +168,7 @@ const Parameter: NodeType = {
   },
   required: ['name', 'in'],
   requiredOneOf: ['schema', 'content'],
+  extensionsPrefix: 'x-',
 };
 
 const Operation: NodeType = {
@@ -182,6 +193,7 @@ const Operation: NodeType = {
     'x-hideTryItPanel': { type: 'boolean' },
   },
   required: ['responses'],
+  extensionsPrefix: 'x-',
 };
 
 const XCodeSample: NodeType = {
@@ -199,6 +211,7 @@ const RequestBody: NodeType = {
     content: 'MediaTypesMap',
   },
   required: ['content'],
+  extensionsPrefix: 'x-',
 };
 
 const MediaTypesMap: NodeType = {
@@ -213,6 +226,7 @@ const MediaType: NodeType = {
     examples: 'ExamplesMap',
     encoding: 'EncodingMap',
   },
+  extensionsPrefix: 'x-',
 };
 
 const Example: NodeType = {
@@ -222,6 +236,7 @@ const Example: NodeType = {
     description: { type: 'string' },
     externalValue: { type: 'string' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const Encoding: NodeType = {
@@ -234,6 +249,7 @@ const Encoding: NodeType = {
     explode: { type: 'boolean' },
     allowReserved: { type: 'boolean' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const EnumDescriptions: NodeType = {
@@ -258,6 +274,7 @@ const Header: NodeType = {
     content: 'MediaTypesMap',
   },
   requiredOneOf: ['schema', 'content'],
+  extensionsPrefix: 'x-',
 };
 
 const Responses: NodeType = {
@@ -275,6 +292,7 @@ const Response: NodeType = {
     'x-summary': { type: 'string' },
   },
   required: ['description'],
+  extensionsPrefix: 'x-',
 };
 
 const Link: NodeType = {
@@ -286,6 +304,7 @@ const Link: NodeType = {
     description: { type: 'string' },
     server: 'Server',
   },
+  extensionsPrefix: 'x-',
 };
 
 const Schema: NodeType = {
@@ -350,6 +369,7 @@ const Schema: NodeType = {
     'x-additionalPropertiesName': { type: 'string' },
     'x-explicitMappingOnly': { type: 'boolean' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const Xml: NodeType = {
@@ -360,6 +380,7 @@ const Xml: NodeType = {
     attribute: { type: 'boolean' },
     wrapped: { type: 'boolean' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const SchemaProperties: NodeType = {
@@ -384,6 +405,7 @@ const Discriminator: NodeType = {
     mapping: 'DiscriminatorMapping',
   },
   required: ['propertyName'],
+  extensionsPrefix: 'x-',
 };
 
 const Components: NodeType = {
@@ -398,6 +420,7 @@ const Components: NodeType = {
     links: 'NamedLinks',
     callbacks: 'NamedCallbacks',
   },
+  extensionsPrefix: 'x-',
 };
 
 const ImplicitFlow: NodeType = {
@@ -407,6 +430,7 @@ const ImplicitFlow: NodeType = {
     authorizationUrl: { type: 'string' },
   },
   required: ['authorizationUrl', 'scopes'],
+  extensionsPrefix: 'x-',
 };
 
 const PasswordFlow: NodeType = {
@@ -416,6 +440,7 @@ const PasswordFlow: NodeType = {
     tokenUrl: { type: 'string' },
   },
   required: ['tokenUrl', 'scopes'],
+  extensionsPrefix: 'x-',
 };
 
 const ClientCredentials: NodeType = {
@@ -425,6 +450,7 @@ const ClientCredentials: NodeType = {
     tokenUrl: { type: 'string' },
   },
   required: ['tokenUrl', 'scopes'],
+  extensionsPrefix: 'x-',
 };
 
 const AuthorizationCode: NodeType = {
@@ -442,6 +468,7 @@ const AuthorizationCode: NodeType = {
     },
   },
   required: ['authorizationUrl', 'tokenUrl', 'scopes'],
+  extensionsPrefix: 'x-',
 };
 
 const OAuth2Flows: NodeType = {
@@ -451,6 +478,7 @@ const OAuth2Flows: NodeType = {
     clientCredentials: 'ClientCredentials',
     authorizationCode: 'AuthorizationCode',
   },
+  extensionsPrefix: 'x-',
 };
 
 const SecurityScheme: NodeType = {

package/src/types/oas3_1.ts

@@ -16,6 +16,7 @@ const Root: NodeType = {
   },
   required: ['openapi', 'info'],
   requiredOneOf: ['paths', 'components', 'webhooks'],
+  extensionsPrefix: 'x-',
 };
 
 const License: NodeType = {
@@ -25,6 +26,7 @@ const License: NodeType = {
     identifier: { type: 'string' },
   },
   required: ['name'],
+  extensionsPrefix: 'x-',
 };
 
 const Info: NodeType = {
@@ -36,8 +38,10 @@ const Info: NodeType = {
     summary: { type: 'string' },
     contact: 'Contact',
     license: 'License',
+    'x-logo': 'Logo',
   },
   required: ['title', 'version'],
+  extensionsPrefix: 'x-',
 };
 
 const Components: NodeType = {
@@ -53,6 +57,7 @@ const Components: NodeType = {
     callbacks: 'NamedCallbacks',
     pathItems: 'NamedPathItems',
   },
+  extensionsPrefix: 'x-',
 };
 
 const Operation: NodeType = {
@@ -76,6 +81,7 @@ const Operation: NodeType = {
     'x-code-samples': listOf('XCodeSample'), // deprecated
     'x-hideTryItPanel': { type: 'boolean' },
   },
+  extensionsPrefix: 'x-',
 };
 
 const Schema: NodeType = {
@@ -167,6 +173,7 @@ const Schema: NodeType = {
     $comment: { type: 'string' },
     'x-tags': { type: 'array', items: { type: 'string' } },
   },
+  extensionsPrefix: 'x-',
 };
 
 const SecurityScheme: NodeType = {

package/src/types/redocly-yaml.ts

@@ -113,6 +113,7 @@ const nodeTypesList = [
   'XCodeSample',
   'XCodeSampleList',
   'WebhooksMap',
+  'SpecExtension',
 ];
 
 const ConfigStyleguide: NodeType = {

package/src/utils.ts

@@ -153,6 +153,11 @@ export function readFileAsStringSync(filePath: string) {
   return fs.readFileSync(filePath, 'utf-8');
 }
 
+export function yamlAndJsonSyncReader<T>(filePath: string): T {
+  const content = fs.readFileSync(filePath, 'utf-8');
+  return parseYaml(content) as T;
+}
+
 export function isPathParameter(pathSegment: string) {
   return pathSegment.startsWith('{') && pathSegment.endsWith('}');
 }

package/src/visitors.ts

@@ -45,7 +45,7 @@ import type {
   Oas2SecurityScheme,
 } from './typings/swagger';
 
-import type { NormalizedNodeType } from './types';
+import { NormalizedNodeType, SpecExtension } from './types';
 import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
@@ -177,6 +177,7 @@ type Oas3FlatVisitor = {
   AuthorizationCode?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['authorizationCode']>;
   OAuth2Flows?: VisitFunctionOrObject<Oas3SecurityScheme['flows']>;
   SecurityScheme?: VisitFunctionOrObject<Oas3SecurityScheme>;
+  SpecExtension?: VisitFunctionOrObject<unknown>;
 };
 
 type Oas2FlatVisitor = {
@@ -202,6 +203,7 @@ type Oas2FlatVisitor = {
   NamedResponses?: VisitFunctionOrObject<Record<string, Oas2Response>>;
   NamedParameters?: VisitFunctionOrObject<Record<string, Oas2Parameter>>;
   SecurityScheme?: VisitFunctionOrObject<Oas2SecurityScheme>;
+  SpecExtension?: VisitFunctionOrObject<unknown>;
 };
 
 const legacyTypesMap = {
@@ -354,6 +356,10 @@ export function normalizeVisitors<T extends BaseVisitor>(
       }
     }
 
+    if (from.extensionsPrefix) {
+      possibleChildren.add(SpecExtension);
+    }
+
     for (const fromType of Array.from(possibleChildren.values())) {
       addWeakNodes(ruleConf, fromType, to, parentContext, stack);
     }

package/src/walk.ts

@@ -17,7 +17,7 @@ import {
 } from './resolve';
 import { pushStack, popStack } from './utils';
 import { OasVersion } from './oas-types';
-import { NormalizedNodeType, isNamedType } from './types';
+import { NormalizedNodeType, isNamedType, SpecExtension } from './types';
 import type { RuleSeverity } from './config';
 
 type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
@@ -280,6 +280,12 @@ export function walkDocument<T>(opts: {
           const props = Object.keys(type.properties);
           if (type.additionalProperties) {
             props.push(...Object.keys(resolvedNode).filter((k) => !props.includes(k)));
+          } else if (type.extensionsPrefix) {
+            props.push(
+              ...Object.keys(resolvedNode).filter((k) =>
+                k.startsWith(type.extensionsPrefix as string)
+              )
+            );
           }
 
           if (isRef(node)) {
@@ -300,6 +306,14 @@ export function walkDocument<T>(opts: {
             if (propType === undefined) propType = type.additionalProperties;
             if (typeof propType === 'function') propType = propType(value, propName);
 
+            if (
+              propType === undefined &&
+              type.extensionsPrefix &&
+              propName.startsWith(type.extensionsPrefix)
+            ) {
+              propType = SpecExtension;
+            }
+
             if (!isNamedType(propType) && propType?.directResolveAs) {
               propType = propType.directResolveAs;
               value = { $ref: value };