@redocly/openapi-core 1.0.0-beta.99 → 1.0.0-rc.1

package/lib/types/index.d.ts

@@ -22,7 +22,7 @@ export declare type NodeType = {
     items?: string;
     required?: string[] | ((value: any, key: string | number | undefined) => string[]);
     requiredOneOf?: string[];
-    allowed?: ((value: any) => string[] | undefined);
+    allowed?: (value: any) => string[] | undefined;
     extensionsPrefix?: string;
 };
 declare type PropType = string | NodeType | ScalarSchema | undefined | null;
@@ -34,7 +34,7 @@ export declare type NormalizedNodeType = {
     items?: NormalizedNodeType;
     required?: string[] | ((value: any, key: string | number | undefined) => string[]);
     requiredOneOf?: string[];
-    allowed?: ((value: any) => string[] | undefined);
+    allowed?: (value: any) => string[] | undefined;
     extensionsPrefix?: string;
 };
 declare type NormalizedPropType = NormalizedNodeType | NormalizedScalarSchema | undefined | null;
@@ -49,6 +49,7 @@ export declare function mapOf(typeName: string): {
     properties: {};
     additionalProperties: () => string;
 };
+export declare const SpecExtension: NormalizedNodeType;
 export declare function normalizeTypes(types: Record<string, NodeType>, options?: {
     doNotResolveExamples?: boolean;
 }): Record<string, NormalizedNodeType>;

package/lib/types/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNamedType = exports.normalizeTypes = exports.mapOf = exports.listOf = void 0;
+exports.isNamedType = exports.normalizeTypes = exports.SpecExtension = exports.mapOf = exports.listOf = void 0;
 function listOf(typeName) {
     return {
         name: `${typeName}List`,
@@ -17,6 +17,12 @@ function mapOf(typeName) {
     };
 }
 exports.mapOf = mapOf;
+exports.SpecExtension = {
+    name: 'SpecExtension',
+    properties: {},
+    // skip validation of additional properties for unknown extensions
+    additionalProperties: { resolvable: true },
+};
 function normalizeTypes(types, options = {}) {
     const normalizedTypes = {};
     for (const typeName of Object.keys(types)) {
@@ -25,6 +31,8 @@ function normalizeTypes(types, options = {}) {
     for (const type of Object.values(normalizedTypes)) {
         normalizeType(type);
     }
+    // all type trees have a SpecExtension type by default
+    normalizedTypes['SpecExtension'] = exports.SpecExtension;
     return normalizedTypes;
     function normalizeType(type) {
         if (type.additionalProperties) {

package/lib/types/oas2.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Oas2Types = void 0;
 const _1 = require(".");
 const responseCodeRegexp = /^[0-9][0-9Xx]{2}$/;
-const DefinitionRoot = {
+const Root = {
     properties: {
         swagger: { type: 'string' },
         info: 'Info',
@@ -12,16 +12,20 @@ const DefinitionRoot = {
         schemes: { type: 'array', items: { type: 'string' } },
         consumes: { type: 'array', items: { type: 'string' } },
         produces: { type: 'array', items: { type: 'string' } },
-        paths: 'PathMap',
+        paths: 'Paths',
         definitions: 'NamedSchemas',
         parameters: 'NamedParameters',
         responses: 'NamedResponses',
         securityDefinitions: 'NamedSecuritySchemes',
-        security: _1.listOf('SecurityRequirement'),
-        tags: _1.listOf('Tag'),
+        security: 'SecurityRequirementList',
+        tags: 'TagList',
         externalDocs: 'ExternalDocs',
+        'x-servers': 'XServerList',
+        'x-tagGroups': 'TagGroups',
+        'x-ignoredHeaderParameters': { type: 'array', items: { type: 'string' } },
     },
     required: ['swagger', 'paths', 'info'],
+    extensionsPrefix: 'x-',
 };
 const Info = {
     properties: {
@@ -31,8 +35,19 @@ const Info = {
         contact: 'Contact',
         license: 'License',
         version: { type: 'string' },
+        'x-logo': 'Logo',
     },
     required: ['title', 'version'],
+    extensionsPrefix: 'x-',
+};
+const Logo = {
+    properties: {
+        url: { type: 'string' },
+        altText: { type: 'string' },
+        backgroundColor: { type: 'string' },
+        href: { type: 'string' },
+    },
+    extensionsPrefix: 'x-',
 };
 const Contact = {
     properties: {
@@ -40,6 +55,7 @@ const Contact = {
         url: { type: 'string' },
         email: { type: 'string' },
     },
+    extensionsPrefix: 'x-',
 };
 const License = {
     properties: {
@@ -47,15 +63,16 @@ const License = {
         url: { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
 };
-const PathMap = {
+const Paths = {
     properties: {},
     additionalProperties: (_value, key) => key.startsWith('/') ? 'PathItem' : undefined,
 };
 const PathItem = {
     properties: {
         $ref: { type: 'string' },
-        parameters: _1.listOf('Parameter'),
+        parameters: 'ParameterList',
         get: 'Operation',
         put: 'Operation',
         post: 'Operation',
@@ -64,6 +81,7 @@ const PathItem = {
         head: 'Operation',
         patch: 'Operation',
     },
+    extensionsPrefix: 'x-',
 };
 const Operation = {
     properties: {
@@ -74,16 +92,17 @@ const Operation = {
         operationId: { type: 'string' },
         consumes: { type: 'array', items: { type: 'string' } },
         produces: { type: 'array', items: { type: 'string' } },
-        parameters: _1.listOf('Parameter'),
-        responses: 'ResponsesMap',
+        parameters: 'ParameterList',
+        responses: 'Responses',
         schemes: { type: 'array', items: { type: 'string' } },
         deprecated: { type: 'boolean' },
-        security: _1.listOf('SecurityRequirement'),
-        'x-codeSamples': _1.listOf('XCodeSample'),
-        'x-code-samples': _1.listOf('XCodeSample'),
+        security: 'SecurityRequirementList',
+        'x-codeSamples': 'XCodeSampleList',
+        'x-code-samples': 'XCodeSampleList',
         'x-hideTryItPanel': { type: 'boolean' },
     },
     required: ['responses'],
+    extensionsPrefix: 'x-',
 };
 const XCodeSample = {
     properties: {
@@ -92,12 +111,20 @@ const XCodeSample = {
         source: { type: 'string' },
     },
 };
+const XServer = {
+    properties: {
+        url: { type: 'string' },
+        description: { type: 'string' },
+    },
+    required: ['url'],
+};
 const ExternalDocs = {
     properties: {
         description: { type: 'string' },
         url: { type: 'string' },
     },
     required: ['url'],
+    extensionsPrefix: 'x-',
 };
 const Parameter = {
     properties: {
@@ -124,6 +151,8 @@ const Parameter = {
         uniqueItems: { type: 'boolean' },
         enum: { type: 'array' },
         multipleOf: { type: 'number' },
+        'x-example': 'Example',
+        'x-examples': 'ExamplesMap',
     },
     required(value) {
         if (!value || !value.in) {
@@ -141,6 +170,7 @@ const Parameter = {
             }
         }
     },
+    extensionsPrefix: 'x-',
 };
 const ParameterItems = {
     properties: {
@@ -170,8 +200,9 @@ const ParameterItems = {
             return ['type'];
         }
     },
+    extensionsPrefix: 'x-',
 };
-const ResponsesMap = {
+const Responses = {
     properties: {
         default: 'Response',
     },
@@ -183,8 +214,10 @@ const Response = {
         schema: 'Schema',
         headers: _1.mapOf('Header'),
         examples: 'Examples',
+        'x-summary': { type: 'string' },
     },
     required: ['description'],
+    extensionsPrefix: 'x-',
 };
 const Examples = {
     properties: {},
@@ -219,14 +252,24 @@ const Header = {
             return ['type'];
         }
     },
+    extensionsPrefix: 'x-',
 };
 const Tag = {
     properties: {
         name: { type: 'string' },
         description: { type: 'string' },
         externalDocs: 'ExternalDocs',
+        'x-traitTag': { type: 'boolean' },
+        'x-displayName': { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
+};
+const TagGroup = {
+    properties: {
+        name: { type: 'string' },
+        tags: { type: 'array', items: { type: 'string' } },
+    },
 };
 const Schema = {
     properties: {
@@ -277,7 +320,17 @@ const Schema = {
         externalDocs: 'ExternalDocs',
         example: { isExample: true },
         'x-tags': { type: 'array', items: { type: 'string' } },
+        'x-nullable': { type: 'boolean' },
+        'x-extendedDiscriminator': { type: 'string' },
+        'x-additionalPropertiesName': { type: 'string' },
+        'x-explicitMappingOnly': { type: 'boolean' },
+        'x-enumDescriptions': 'EnumDescriptions',
     },
+    extensionsPrefix: 'x-',
+};
+const EnumDescriptions = {
+    properties: {},
+    additionalProperties: { type: 'string' },
 };
 const SchemaProperties = {
     properties: {},
@@ -291,6 +344,7 @@ const Xml = {
         attribute: { type: 'boolean' },
         wrapped: { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
 };
 const SecurityScheme = {
     properties: {
@@ -302,6 +356,7 @@ const SecurityScheme = {
         authorizationUrl: { type: 'string' },
         tokenUrl: { type: 'string' },
         scopes: { type: 'object', additionalProperties: { type: 'string' } },
+        'x-defaultClientId': { type: 'string' },
     },
     required(value) {
         switch (value === null || value === void 0 ? void 0 : value.type) {
@@ -351,22 +406,40 @@ const SecurityRequirement = {
     properties: {},
     additionalProperties: { type: 'array', items: { type: 'string' } },
 };
+const Example = {
+    properties: {
+        value: { isExample: true },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        externalValue: { type: 'string' },
+    },
+    extensionsPrefix: 'x-',
+};
 exports.Oas2Types = {
-    DefinitionRoot,
+    Root,
     Tag,
+    TagList: _1.listOf('Tag'),
+    TagGroups: _1.listOf('TagGroup'),
+    TagGroup,
     ExternalDocs,
+    Example,
+    ExamplesMap: _1.mapOf('Example'),
+    EnumDescriptions,
     SecurityRequirement,
+    SecurityRequirementList: _1.listOf('SecurityRequirement'),
     Info,
     Contact,
     License,
-    PathMap,
+    Logo,
+    Paths,
     PathItem,
     Parameter,
     ParameterItems,
+    ParameterList: _1.listOf('Parameter'),
     Operation,
     Examples,
     Header,
-    ResponsesMap,
+    Responses,
     Response,
     Schema,
     Xml,
@@ -377,4 +450,7 @@ exports.Oas2Types = {
     NamedSecuritySchemes: _1.mapOf('SecurityScheme'),
     SecurityScheme,
     XCodeSample,
+    XCodeSampleList: _1.listOf('XCodeSample'),
+    XServerList: _1.listOf('XServer'),
+    XServer,
 };