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

package/lib/types/oas3.js

@@ -4,27 +4,40 @@ exports.Oas3Types = void 0;
 const _1 = require(".");
 const ref_utils_1 = require("../ref-utils");
 const responseCodeRegexp = /^[0-9][0-9Xx]{2}$/;
-const DefinitionRoot = {
+const Root = {
     properties: {
         openapi: null,
         info: 'Info',
-        servers: _1.listOf('Server'),
-        security: _1.listOf('SecurityRequirement'),
-        tags: _1.listOf('Tag'),
+        servers: 'ServerList',
+        security: 'SecurityRequirementList',
+        tags: 'TagList',
         externalDocs: 'ExternalDocs',
-        paths: 'PathMap',
+        paths: 'Paths',
         components: 'Components',
         'x-webhooks': 'WebhooksMap',
+        'x-tagGroups': 'TagGroups',
+        'x-ignoredHeaderParameters': { type: 'array', items: { type: 'string' } },
     },
     required: ['openapi', 'paths', 'info'],
+    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' } },
+    },
+    extensionsPrefix: 'x-',
 };
 const ExternalDocs = {
     properties: {
@@ -32,14 +45,16 @@ const ExternalDocs = {
         url: { type: 'string' },
     },
     required: ['url'],
+    extensionsPrefix: 'x-',
 };
 const Server = {
     properties: {
         url: { type: 'string' },
         description: { type: 'string' },
-        variables: _1.mapOf('ServerVariable'),
+        variables: 'ServerVariablesMap',
     },
     required: ['url'],
+    extensionsPrefix: 'x-',
 };
 const ServerVariable = {
     properties: {
@@ -48,9 +63,10 @@ const ServerVariable = {
             items: { type: 'string' },
         },
         default: { type: 'string' },
-        description: null,
+        description: { type: 'string' },
     },
     required: ['default'],
+    extensionsPrefix: 'x-',
 };
 const SecurityRequirement = {
     properties: {},
@@ -64,8 +80,18 @@ const Info = {
         termsOfService: { type: 'string' },
         contact: 'Contact',
         license: 'License',
+        'x-logo': 'Logo',
     },
     required: ['title', 'version'],
+    extensionsPrefix: 'x-',
+};
+const Logo = {
+    properties: {
+        url: { type: 'string' },
+        altText: { type: 'string' },
+        backgroundColor: { type: 'string' },
+        href: { type: 'string' },
+    },
 };
 const Contact = {
     properties: {
@@ -73,6 +99,7 @@ const Contact = {
         url: { type: 'string' },
         email: { type: 'string' },
     },
+    extensionsPrefix: 'x-',
 };
 const License = {
     properties: {
@@ -80,8 +107,9 @@ const License = {
         url: { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
 };
-const PathMap = {
+const Paths = {
     properties: {},
     additionalProperties: (_value, key) => key.startsWith('/') ? 'PathItem' : undefined,
 };
@@ -92,8 +120,8 @@ const WebhooksMap = {
 const PathItem = {
     properties: {
         $ref: { type: 'string' },
-        servers: _1.listOf('Server'),
-        parameters: _1.listOf('Parameter'),
+        servers: 'ServerList',
+        parameters: 'ParameterList',
         summary: { type: 'string' },
         description: { type: 'string' },
         get: 'Operation',
@@ -105,6 +133,7 @@ const PathItem = {
         patch: 'Operation',
         trace: 'Operation',
     },
+    extensionsPrefix: 'x-',
 };
 const Parameter = {
     properties: {
@@ -121,15 +150,12 @@ const Parameter = {
         allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
-        examples: _1.mapOf('Example'),
-        content: 'MediaTypeMap',
+        examples: 'ExamplesMap',
+        content: 'MediaTypesMap',
     },
     required: ['name', 'in'],
     requiredOneOf: ['schema', 'content'],
-};
-const Callback = {
-    properties: {},
-    additionalProperties: 'PathItem',
+    extensionsPrefix: 'x-',
 };
 const Operation = {
     properties: {
@@ -141,18 +167,19 @@ const Operation = {
         description: { type: 'string' },
         externalDocs: 'ExternalDocs',
         operationId: { type: 'string' },
-        parameters: _1.listOf('Parameter'),
-        security: _1.listOf('SecurityRequirement'),
-        servers: _1.listOf('Server'),
+        parameters: 'ParameterList',
+        security: 'SecurityRequirementList',
+        servers: 'ServerList',
         requestBody: 'RequestBody',
-        responses: 'ResponsesMap',
+        responses: 'Responses',
         deprecated: { type: 'boolean' },
-        callbacks: _1.mapOf('Callback'),
-        'x-codeSamples': _1.listOf('XCodeSample'),
-        'x-code-samples': _1.listOf('XCodeSample'),
+        callbacks: 'CallbacksMap',
+        'x-codeSamples': 'XCodeSampleList',
+        'x-code-samples': 'XCodeSampleList',
         'x-hideTryItPanel': { type: 'boolean' },
     },
     required: ['responses'],
+    extensionsPrefix: 'x-',
 };
 const XCodeSample = {
     properties: {
@@ -165,11 +192,12 @@ const RequestBody = {
     properties: {
         description: { type: 'string' },
         required: { type: 'boolean' },
-        content: 'MediaTypeMap',
+        content: 'MediaTypesMap',
     },
     required: ['content'],
+    extensionsPrefix: 'x-',
 };
-const MediaTypeMap = {
+const MediaTypesMap = {
     properties: {},
     additionalProperties: 'MediaType',
 };
@@ -177,9 +205,10 @@ const MediaType = {
     properties: {
         schema: 'Schema',
         example: { isExample: true },
-        examples: _1.mapOf('Example'),
-        encoding: _1.mapOf('Encoding'),
+        examples: 'ExamplesMap',
+        encoding: 'EncodingMap',
     },
+    extensionsPrefix: 'x-',
 };
 const Example = {
     properties: {
@@ -188,17 +217,23 @@ const Example = {
         description: { type: 'string' },
         externalValue: { type: 'string' },
     },
+    extensionsPrefix: 'x-',
 };
 const Encoding = {
     properties: {
         contentType: { type: 'string' },
-        headers: _1.mapOf('Header'),
+        headers: 'HeadersMap',
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
         explode: { type: 'boolean' },
         allowReserved: { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
+};
+const EnumDescriptions = {
+    properties: {},
+    additionalProperties: { type: 'string' },
 };
 const Header = {
     properties: {
@@ -213,22 +248,26 @@ const Header = {
         allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
-        examples: _1.mapOf('Example'),
-        content: 'MediaTypeMap',
+        examples: 'ExamplesMap',
+        content: 'MediaTypesMap',
     },
+    requiredOneOf: ['schema', 'content'],
+    extensionsPrefix: 'x-',
 };
-const ResponsesMap = {
+const Responses = {
     properties: { default: 'Response' },
     additionalProperties: (_v, key) => responseCodeRegexp.test(key) ? 'Response' : undefined,
 };
 const Response = {
     properties: {
         description: { type: 'string' },
-        headers: _1.mapOf('Header'),
-        content: 'MediaTypeMap',
-        links: _1.mapOf('Link'),
+        headers: 'HeadersMap',
+        content: 'MediaTypesMap',
+        links: 'LinksMap',
+        'x-summary': { type: 'string' },
     },
     required: ['description'],
+    extensionsPrefix: 'x-',
 };
 const Link = {
     properties: {
@@ -239,6 +278,7 @@ const Link = {
         description: { type: 'string' },
         server: 'Server',
     },
+    extensionsPrefix: 'x-',
 };
 const Schema = {
     properties: {
@@ -280,9 +320,6 @@ const Schema = {
             if (typeof value === 'boolean') {
                 return { type: 'boolean' };
             }
-            else if (Array.isArray(value)) {
-                return _1.listOf('Schema');
-            }
             else {
                 return 'Schema';
             }
@@ -305,7 +342,10 @@ const Schema = {
         example: { isExample: true },
         deprecated: { type: 'boolean' },
         'x-tags': { type: 'array', items: { type: 'string' } },
+        'x-additionalPropertiesName': { type: 'string' },
+        'x-explicitMappingOnly': { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
 };
 const Xml = {
     properties: {
@@ -315,6 +355,7 @@ const Xml = {
         attribute: { type: 'boolean' },
         wrapped: { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
 };
 const SchemaProperties = {
     properties: {},
@@ -337,6 +378,7 @@ const Discriminator = {
         mapping: 'DiscriminatorMapping',
     },
     required: ['propertyName'],
+    extensionsPrefix: 'x-',
 };
 const Components = {
     properties: {
@@ -350,6 +392,7 @@ const Components = {
         links: 'NamedLinks',
         callbacks: 'NamedCallbacks',
     },
+    extensionsPrefix: 'x-',
 };
 const ImplicitFlow = {
     properties: {
@@ -358,6 +401,7 @@ const ImplicitFlow = {
         authorizationUrl: { type: 'string' },
     },
     required: ['authorizationUrl', 'scopes'],
+    extensionsPrefix: 'x-',
 };
 const PasswordFlow = {
     properties: {
@@ -366,6 +410,7 @@ const PasswordFlow = {
         tokenUrl: { type: 'string' },
     },
     required: ['tokenUrl', 'scopes'],
+    extensionsPrefix: 'x-',
 };
 const ClientCredentials = {
     properties: {
@@ -374,6 +419,7 @@ const ClientCredentials = {
         tokenUrl: { type: 'string' },
     },
     required: ['tokenUrl', 'scopes'],
+    extensionsPrefix: 'x-',
 };
 const AuthorizationCode = {
     properties: {
@@ -381,16 +427,26 @@ const AuthorizationCode = {
         authorizationUrl: { type: 'string' },
         scopes: { type: 'object', additionalProperties: { type: 'string' } },
         tokenUrl: { type: 'string' },
+        'x-usePkce': (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'XUsePkce';
+            }
+        },
     },
     required: ['authorizationUrl', 'tokenUrl', 'scopes'],
+    extensionsPrefix: 'x-',
 };
-const SecuritySchemeFlows = {
+const OAuth2Flows = {
     properties: {
         implicit: 'ImplicitFlow',
         password: 'PasswordFlow',
         clientCredentials: 'ClientCredentials',
         authorizationCode: 'AuthorizationCode',
     },
+    extensionsPrefix: 'x-',
 };
 const SecurityScheme = {
     properties: {
@@ -400,8 +456,9 @@ const SecurityScheme = {
         in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
-        flows: 'SecuritySchemeFlows',
+        flows: 'OAuth2Flows',
         openIdConnectUrl: { type: 'string' },
+        'x-defaultClientId': { type: 'string' },
     },
     required(value) {
         switch (value === null || value === void 0 ? void 0 : value.type) {
@@ -433,36 +490,56 @@ const SecurityScheme = {
     },
     extensionsPrefix: 'x-',
 };
+const XUsePkce = {
+    properties: {
+        disableManualConfiguration: { type: 'boolean' },
+        hideClientSecretInput: { type: 'boolean' },
+    },
+};
 exports.Oas3Types = {
-    DefinitionRoot,
+    Root,
     Tag,
+    TagList: _1.listOf('Tag'),
+    TagGroups: _1.listOf('TagGroup'),
+    TagGroup,
     ExternalDocs,
     Server,
+    ServerList: _1.listOf('Server'),
     ServerVariable,
+    ServerVariablesMap: _1.mapOf('ServerVariable'),
     SecurityRequirement,
+    SecurityRequirementList: _1.listOf('SecurityRequirement'),
     Info,
     Contact,
     License,
-    PathMap,
+    Paths,
     PathItem,
     Parameter,
+    ParameterList: _1.listOf('Parameter'),
     Operation,
-    Callback,
+    Callback: _1.mapOf('PathItem'),
+    CallbacksMap: _1.mapOf('Callback'),
     RequestBody,
-    MediaTypeMap,
+    MediaTypesMap,
     MediaType,
     Example,
+    ExamplesMap: _1.mapOf('Example'),
     Encoding,
+    EncodingMap: _1.mapOf('Encoding'),
+    EnumDescriptions,
     Header,
-    ResponsesMap,
+    HeadersMap: _1.mapOf('Header'),
+    Responses,
     Response,
     Link,
+    Logo,
     Schema,
     Xml,
     SchemaProperties,
     DiscriminatorMapping,
     Discriminator,
     Components,
+    LinksMap: _1.mapOf('Link'),
     NamedSchemas: _1.mapOf('Schema'),
     NamedResponses: _1.mapOf('Response'),
     NamedParameters: _1.mapOf('Parameter'),
@@ -471,13 +548,15 @@ exports.Oas3Types = {
     NamedHeaders: _1.mapOf('Header'),
     NamedSecuritySchemes: _1.mapOf('SecurityScheme'),
     NamedLinks: _1.mapOf('Link'),
-    NamedCallbacks: _1.mapOf('PathItem'),
+    NamedCallbacks: _1.mapOf('Callback'),
     ImplicitFlow,
     PasswordFlow,
     ClientCredentials,
     AuthorizationCode,
-    SecuritySchemeFlows,
+    OAuth2Flows,
     SecurityScheme,
     XCodeSample,
+    XCodeSampleList: _1.listOf('XCodeSample'),
+    XUsePkce,
     WebhooksMap,
 };

package/lib/types/oas3_1.js

@@ -3,21 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Oas3_1Types = void 0;
 const _1 = require(".");
 const oas3_1 = require("./oas3");
-const DefinitionRoot = {
+const Root = {
     properties: {
         openapi: null,
         info: 'Info',
-        servers: _1.listOf('Server'),
-        security: _1.listOf('SecurityRequirement'),
-        tags: _1.listOf('Tag'),
+        servers: 'ServerList',
+        security: 'SecurityRequirementList',
+        tags: 'TagList',
         externalDocs: 'ExternalDocs',
-        paths: 'PathMap',
+        paths: 'Paths',
         webhooks: 'WebhooksMap',
         components: 'Components',
         jsonSchemaDialect: { type: 'string' },
     },
     required: ['openapi', 'info'],
     requiredOneOf: ['paths', 'components', 'webhooks'],
+    extensionsPrefix: 'x-',
 };
 const License = {
     properties: {
@@ -26,6 +27,7 @@ const License = {
         identifier: { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
 };
 const Info = {
     properties: {
@@ -36,8 +38,10 @@ const Info = {
         summary: { type: 'string' },
         contact: 'Contact',
         license: 'License',
+        'x-logo': 'Logo',
     },
     required: ['title', 'version'],
+    extensionsPrefix: 'x-',
 };
 const Components = {
     properties: {
@@ -52,6 +56,7 @@ const Components = {
         callbacks: 'NamedCallbacks',
         pathItems: 'NamedPathItems',
     },
+    extensionsPrefix: 'x-',
 };
 const Operation = {
     properties: {
@@ -63,21 +68,23 @@ const Operation = {
         description: { type: 'string' },
         externalDocs: 'ExternalDocs',
         operationId: { type: 'string' },
-        parameters: _1.listOf('Parameter'),
-        security: _1.listOf('SecurityRequirement'),
-        servers: _1.listOf('Server'),
+        parameters: 'ParameterList',
+        security: 'SecurityRequirementList',
+        servers: 'ServerList',
         requestBody: 'RequestBody',
-        responses: 'ResponsesMap',
+        responses: 'Responses',
         deprecated: { type: 'boolean' },
-        callbacks: _1.mapOf('Callback'),
-        'x-codeSamples': _1.listOf('XCodeSample'),
-        'x-code-samples': _1.listOf('XCodeSample'),
+        callbacks: 'CallbacksMap',
+        'x-codeSamples': 'XCodeSampleList',
+        'x-code-samples': 'XCodeSampleList',
         'x-hideTryItPanel': { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
 };
 const Schema = {
     properties: {
         $id: { type: 'string' },
+        $anchor: { type: 'string' },
         id: { type: 'string' },
         $schema: { type: 'string' },
         definitions: 'NamedSchemas',
@@ -85,7 +92,6 @@ const Schema = {
         $vocabulary: { type: 'string' },
         externalDocs: 'ExternalDocs',
         discriminator: 'Discriminator',
-        myArbitraryKeyword: { type: 'boolean' },
         title: { type: 'string' },
         multipleOf: { type: 'number', minimum: 0 },
         maximum: { type: 'number' },
@@ -141,10 +147,7 @@ const Schema = {
         summary: { type: 'string' },
         properties: 'SchemaProperties',
         items: (value) => {
-            if (Array.isArray(value)) {
-                return _1.listOf('Schema');
-            }
-            else if (typeof value === 'boolean') {
+            if (typeof value === 'boolean') {
                 return { type: 'boolean' };
             }
             else {
@@ -169,6 +172,7 @@ const Schema = {
         $comment: { type: 'string' },
         'x-tags': { type: 'array', items: { type: 'string' } },
     },
+    extensionsPrefix: 'x-',
 };
 const SecurityScheme = {
     properties: {
@@ -178,7 +182,7 @@ const SecurityScheme = {
         in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
-        flows: 'SecuritySchemeFlows',
+        flows: 'OAuth2Flows',
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {
@@ -240,7 +244,7 @@ const SecurityScheme = {
     extensionsPrefix: 'x-',
 };
 exports.Oas3_1Types = Object.assign(Object.assign({}, oas3_1.Oas3Types), { Info,
-    DefinitionRoot,
+    Root,
     Schema,
     License,
     Components, NamedPathItems: _1.mapOf('PathItem'), SecurityScheme,