@redocly/openapi-core 1.27.2 → 1.28.0

package/src/typings/openapi.ts

@@ -1,19 +1,26 @@
-export interface Oas3Definition {
+// common fields for OAS descriptions v3.x
+interface Oas3DefinitionBase<T extends Oas3Schema | Oas3_1Schema> {
   openapi: string;
   info?: Oas3Info;
   servers?: Oas3Server[];
-  paths?: Oas3Paths;
-  components?: Oas3Components;
+  paths?: Oas3Paths<T>;
+  components?: T extends Oas3_1Schema ? Oas3_1Components : Oas3Components;
   security?: Oas3SecurityRequirement[];
   tags?: Oas3Tag[];
   externalDocs?: Oas3ExternalDocs;
-  'x-webhooks'?: Oas3_1Webhooks;
+}
+
+export interface Oas3Definition extends Oas3DefinitionBase<Oas3Schema> {
+  'x-webhooks'?: Oas3Webhooks<Oas3Schema>;
+}
+
+export interface Oas3_1Definition extends Oas3DefinitionBase<Oas3_1Schema> {
+  webhooks?: Oas3Webhooks<Oas3_1Schema>;
 }
 
 export interface Oas3Info {
   title: string;
   version: string;
-
   description?: string;
   termsOfService?: string;
   contact?: Oas3Contact;
@@ -32,8 +39,8 @@ export interface Oas3ServerVariable {
   description?: string;
 }
 
-export interface Oas3Paths {
-  [path: string]: Referenced<Oas3PathItem>;
+export interface Oas3Paths<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
+  [path: string]: Referenced<Oas3PathItem<T>>;
 }
 export interface OasRef {
   $ref: string;
@@ -41,19 +48,19 @@ export interface OasRef {
 
 export type Referenced<T> = OasRef | T;
 
-export interface Oas3PathItem {
+export interface Oas3PathItem<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
   summary?: string;
   description?: string;
-  get?: Oas3Operation;
-  put?: Oas3Operation;
-  post?: Oas3Operation;
-  delete?: Oas3Operation;
-  options?: Oas3Operation;
-  head?: Oas3Operation;
-  patch?: Oas3Operation;
-  trace?: Oas3Operation;
+  get?: Oas3Operation<T>;
+  put?: Oas3Operation<T>;
+  post?: Oas3Operation<T>;
+  delete?: Oas3Operation<T>;
+  options?: Oas3Operation<T>;
+  head?: Oas3Operation<T>;
+  patch?: Oas3Operation<T>;
+  trace?: Oas3Operation<T>;
   servers?: Oas3Server[];
-  parameters?: Array<Referenced<Oas3Parameter>>;
+  parameters?: Array<Referenced<Oas3Parameter<T>>>;
 }
 
 export interface Oas3XCodeSample {
@@ -62,16 +69,16 @@ export interface Oas3XCodeSample {
   source: string;
 }
 
-export interface Oas3Operation {
+export interface Oas3Operation<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
   tags?: string[];
   summary?: string;
   description?: string;
   externalDocs?: Oas3ExternalDocs;
   operationId?: string;
-  parameters?: Array<Referenced<Oas3Parameter>>;
-  requestBody?: Referenced<Oas3RequestBody>;
-  responses: Oas3Responses;
-  callbacks?: { [name: string]: Referenced<Oas3Callback> };
+  parameters?: Array<Referenced<Oas3Parameter<T>>>;
+  requestBody?: Referenced<Oas3RequestBody<T>>;
+  responses: Oas3Responses<T>;
+  callbacks?: { [name: string]: Referenced<Oas3Callback<T>> };
   deprecated?: boolean;
   security?: Oas3SecurityRequirement[];
   servers?: Oas3Server[];
@@ -80,7 +87,7 @@ export interface Oas3Operation {
   'x-hideTryItPanel'?: boolean;
 }
 
-export interface Oas3Parameter {
+export interface Oas3Parameter<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
   name: string;
   in?: Oas3ParameterLocation;
   description?: string;
@@ -90,14 +97,14 @@ export interface Oas3Parameter {
   style?: Oas3ParameterStyle;
   explode?: boolean;
   allowReserved?: boolean;
-  schema?: Referenced<Oas3Schema>;
-  example?: any;
+  schema?: Referenced<T>;
+  example?: unknown;
   examples?: { [media: string]: Referenced<Oas3Example> };
-  content?: { [media: string]: Oas3MediaType };
+  content?: { [media: string]: Oas3MediaType<T> };
 }
 
 export interface Oas3Example {
-  value: any;
+  value: unknown;
   summary?: string;
   description?: string;
   externalValue?: string;
@@ -112,13 +119,12 @@ export interface Oas3Xml {
 }
 
 // common fields for OpenAPI Schema v3.x
-interface Oas3XSchemaBase<T> {
+interface Oas3XSchemaBase<T extends Oas3Schema | Oas3_1Schema> {
   $ref?: string;
-  properties?: { [name: string]: T };
+  properties?: { [name: string]: Referenced<T> };
   additionalProperties?: boolean | T;
   description?: string;
-  default?: any;
-  items?: T;
+  default?: unknown;
   required?: string[];
   readOnly?: boolean;
   writeOnly?: boolean;
@@ -126,28 +132,25 @@ interface Oas3XSchemaBase<T> {
   format?: string;
   externalDocs?: Oas3ExternalDocs;
   discriminator?: Oas3Discriminator;
-  nullable?: boolean;
   oneOf?: T[];
   anyOf?: T[];
   allOf?: T[];
   not?: T;
-
   title?: string;
   multipleOf?: number;
   maximum?: number;
-  exclusiveMaximum?: boolean;
   minimum?: number;
-  exclusiveMinimum?: boolean;
   maxLength?: number;
   minLength?: number;
   pattern?: string;
+  items?: boolean | T;
   maxItems?: number;
   minItems?: number;
   uniqueItems?: boolean;
   maxProperties?: number;
   minProperties?: number;
-  enum?: any[];
-  example?: any;
+  enum?: unknown[];
+  example?: unknown;
 
   xml?: Oas3Xml;
   'x-tags'?: string[];
@@ -155,20 +158,45 @@ interface Oas3XSchemaBase<T> {
 
 export interface Oas3Schema extends Oas3XSchemaBase<Oas3Schema> {
   type?: string;
+  exclusiveMaximum?: boolean;
+  exclusiveMinimum?: boolean;
+  nullable?: boolean;
 }
 
 export interface Oas3_1Schema extends Oas3XSchemaBase<Oas3_1Schema> {
+  $id?: string;
+  $schema?: string;
+  $anchor?: string;
+  $dynamicAnchor?: string;
+  $dynamicRef?: string;
+  $defs?: { [name: string]: Referenced<Oas3_1Schema> };
+  $vocabulary?: { [uri: string]: boolean };
+  $comment?: string;
   type?: string | string[];
-  examples?: any[];
+  examples?: unknown[];
   prefixItems?: Oas3_1Schema[];
-}
-
-export interface Oas3_1Definition extends Oas3Definition {
-  webhooks?: Oas3_1Webhooks;
-}
-
-export interface Oas3_1Webhooks {
-  [webhook: string]: Referenced<Oas3PathItem>;
+  exclusiveMaximum?: number;
+  exclusiveMinimum?: number;
+  const?: unknown;
+  contains?: Oas3_1Schema;
+  minContains?: number;
+  maxContains?: number;
+  propertyNames?: Oas3_1Schema;
+  if?: Oas3_1Schema;
+  then?: Oas3_1Schema;
+  else?: Oas3_1Schema;
+  dependentRequired?: { [name: string]: string[] };
+  dependentSchemas?: { [name: string]: Referenced<Oas3_1Schema> };
+  patternProperties?: { [name: string]: Referenced<Oas3_1Schema> };
+  unevaluatedItems?: boolean | Oas3_1Schema;
+  unevaluatedProperties?: boolean | Oas3_1Schema;
+  contentSchema?: Oas3_1Schema;
+  contentMediaType?: string;
+  contentEncoding?: string;
+}
+
+export interface Oas3Webhooks<T extends Oas3Schema | Oas3_1Schema> {
+  [webhook: string]: Referenced<Oas3PathItem<T>>;
 }
 
 export interface Oas3Discriminator {
@@ -177,16 +205,16 @@ export interface Oas3Discriminator {
   'x-explicitMappingOnly'?: boolean;
 }
 
-export interface Oas3MediaType {
-  schema?: Referenced<Oas3Schema>;
-  example?: any;
+export interface Oas3MediaType<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
+  schema?: Referenced<T>;
+  example?: unknown;
   examples?: { [name: string]: Referenced<Oas3Example> };
-  encoding?: { [field: string]: Oas3Encoding };
+  encoding?: { [field: string]: Oas3Encoding<T> };
 }
 
-export interface Oas3Encoding {
+export interface Oas3Encoding<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
   contentType: string;
-  headers?: { [name: string]: Referenced<Oas3Header> };
+  headers?: { [name: string]: Referenced<Oas3Header<T>> };
   style: Oas3ParameterStyle;
   explode: boolean;
   allowReserved: boolean;
@@ -202,46 +230,62 @@ export type Oas3ParameterStyle =
   | 'pipeDelimited'
   | 'deepObject';
 
-export interface Oas3RequestBody {
+export interface Oas3RequestBody<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
   description?: string;
   required?: boolean;
-  content: { [mime: string]: Oas3MediaType };
+  content: { [mime: string]: Oas3MediaType<T> };
 }
 
-export interface Oas3Responses {
-  [code: string]: Oas3Response;
+export interface Oas3Responses<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
+  [code: string]: Oas3Response<T>;
 }
 
-export interface Oas3Response {
+export interface Oas3Response<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
   description?: string;
-  headers?: { [name: string]: Referenced<Oas3Header> };
-  content?: { [mime: string]: Oas3MediaType };
+  headers?: { [name: string]: Referenced<Oas3Header<T>> };
+  content?: { [mime: string]: Oas3MediaType<T> };
   links?: { [name: string]: Referenced<Oas3Link> };
 }
 
 export interface Oas3Link {
-  $ref?: string;
+  operationRef?: string;
+  operationId?: string;
+  parameters?: { [name: string]: unknown };
+  requestBody?: unknown;
+  description?: string;
+  server?: Oas3Server;
 }
 
-export type Oas3Header = Omit<Oas3Parameter, 'in' | 'name'>;
+export type Oas3Header<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> = Omit<
+  Oas3Parameter<T>,
+  'in' | 'name'
+>;
 
-export interface Oas3Callback {
-  [name: string]: Oas3PathItem;
+export interface Oas3Callback<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> {
+  [name: string]: Oas3PathItem<T>;
 }
 
-export interface Oas3Components {
-  schemas?: { [name: string]: Referenced<Oas3Schema> };
-  responses?: { [name: string]: Referenced<Oas3Response> };
-  parameters?: { [name: string]: Referenced<Oas3Parameter> };
+// common fields for OAS components v3.x
+export interface Oas3ComponentsBase<T extends Oas3Schema | Oas3_1Schema> {
+  schemas?: { [name: string]: Referenced<T> };
+  responses?: { [name: string]: Referenced<Oas3Response<T>> };
+  parameters?: { [name: string]: Referenced<Oas3Parameter<T>> };
   examples?: { [name: string]: Referenced<Oas3Example> };
-  requestBodies?: { [name: string]: Referenced<Oas3RequestBody> };
-  headers?: { [name: string]: Referenced<Oas3Header> };
+  requestBodies?: { [name: string]: Referenced<Oas3RequestBody<T>> };
+  headers?: { [name: string]: Referenced<Oas3Header<T>> };
   securitySchemes?: { [name: string]: Referenced<Oas3SecurityScheme> };
   links?: { [name: string]: Referenced<Oas3Link> };
-  callbacks?: { [name: string]: Referenced<Oas3Callback> };
+  callbacks?: { [name: string]: Referenced<Oas3Callback<T>> };
 }
 
-export type Oas3ComponentName = keyof Oas3Components;
+export interface Oas3_1Components extends Oas3ComponentsBase<Oas3_1Schema> {
+  pathItems?: { [name: string]: Referenced<Oas3PathItem<Oas3_1Schema>> };
+}
+
+export interface Oas3Components extends Oas3ComponentsBase<Oas3Schema> {}
+
+export type Oas3ComponentName<T extends Oas3Schema | Oas3_1Schema = Oas3Schema | Oas3_1Schema> =
+  keyof Oas3ComponentsBase<T>;
 
 export interface Oas3SecurityRequirement {
   [name: string]: string[];

package/src/utils.ts

@@ -1,7 +1,6 @@
 import * as fs from 'fs';
 import { extname } from 'path';
 import * as minimatch from 'minimatch';
-import fetch from 'node-fetch';
 import { parseYaml } from './js-yaml';
 import { env } from './env';
 import { logger, colorize } from './logger';
@@ -354,3 +353,5 @@ export function dequal(foo: any, bar: any): boolean {
 }
 
 export type CollectFn = (value: unknown) => void;
+
+export type StrictObject<T extends object> = T & { [key: string]: undefined };

package/src/visitors.ts

@@ -6,12 +6,15 @@ import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
 import type {
   Oas3Definition,
+  Oas3_1Definition,
   Oas3ExternalDocs,
   Oas3Info,
   Oas3Contact,
   Oas3Components,
+  Oas3_1Components,
   Oas3License,
   Oas3Schema,
+  Oas3_1Schema,
   Oas3Header,
   Oas3Parameter,
   Oas3Operation,
@@ -152,7 +155,7 @@ export type BaseVisitor = {
 };
 
 type Oas3FlatVisitor = {
-  Root?: VisitFunctionOrObject<Oas3Definition>;
+  Root?: VisitFunctionOrObject<Oas3Definition | Oas3_1Definition>;
   Tag?: VisitFunctionOrObject<Oas3Tag>;
   ExternalDocs?: VisitFunctionOrObject<Oas3ExternalDocs>;
   Server?: VisitFunctionOrObject<Oas3Server>;
@@ -161,36 +164,38 @@ type Oas3FlatVisitor = {
   Info?: VisitFunctionOrObject<Oas3Info>;
   Contact?: VisitFunctionOrObject<Oas3Contact>;
   License?: VisitFunctionOrObject<Oas3License>;
-  Paths?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
-  PathItem?: VisitFunctionOrObject<Oas3PathItem>;
-  Callback?: VisitFunctionOrObject<Oas3Callback>;
-  CallbacksMap?: VisitFunctionOrObject<Record<string, Oas3Callback>>;
-  Parameter?: VisitFunctionOrObject<Oas3Parameter>;
-  Operation?: VisitFunctionOrObject<Oas3Operation>;
-  RequestBody?: VisitFunctionOrObject<Oas3RequestBody>;
-  MediaTypesMap?: VisitFunctionOrObject<Record<string, Oas3MediaType>>;
-  MediaType?: VisitFunctionOrObject<Oas3MediaType>;
+  Paths?: VisitFunctionOrObject<Record<string, Oas3PathItem<Oas3Schema | Oas3_1Schema>>>;
+  PathItem?: VisitFunctionOrObject<Oas3PathItem<Oas3Schema | Oas3_1Schema>>;
+  Callback?: VisitFunctionOrObject<Oas3Callback<Oas3Schema | Oas3_1Schema>>;
+  CallbacksMap?: VisitFunctionOrObject<Record<string, Oas3Callback<Oas3Schema | Oas3_1Schema>>>;
+  Parameter?: VisitFunctionOrObject<Oas3Parameter<Oas3Schema | Oas3_1Schema>>;
+  Operation?: VisitFunctionOrObject<Oas3Operation<Oas3Schema | Oas3_1Schema>>;
+  RequestBody?: VisitFunctionOrObject<Oas3RequestBody<Oas3Schema | Oas3_1Schema>>;
+  MediaTypesMap?: VisitFunctionOrObject<Record<string, Oas3MediaType<Oas3Schema | Oas3_1Schema>>>;
+  MediaType?: VisitFunctionOrObject<Oas3MediaType<Oas3Schema | Oas3_1Schema>>;
   Example?: VisitFunctionOrObject<Oas3Example>;
-  Encoding?: VisitFunctionOrObject<Oas3Encoding>;
-  Header?: VisitFunctionOrObject<Oas3Header>;
-  Responses?: VisitFunctionOrObject<Record<string, Oas3Response>>;
-  Response?: VisitFunctionOrObject<Oas3Response>;
+  Encoding?: VisitFunctionOrObject<Oas3Encoding<Oas3Schema | Oas3_1Schema>>;
+  Header?: VisitFunctionOrObject<Oas3Header<Oas3Schema | Oas3_1Schema>>;
+  Responses?: VisitFunctionOrObject<Record<string, Oas3Response<Oas3Schema | Oas3_1Schema>>>;
+  Response?: VisitFunctionOrObject<Oas3Response<Oas3Schema | Oas3_1Schema>>;
   Link?: VisitFunctionOrObject<Oas3Link>;
-  Schema?: VisitFunctionOrObject<Oas3Schema>;
+  Schema?: VisitFunctionOrObject<Oas3Schema | Oas3_1Schema>;
   Xml?: VisitFunctionOrObject<Oas3Xml>;
   SchemaProperties?: VisitFunctionOrObject<Record<string, Oas3Schema>>;
   DiscriminatorMapping?: VisitFunctionOrObject<Record<string, string>>;
   Discriminator?: VisitFunctionOrObject<Oas3Discriminator>;
-  Components?: VisitFunctionOrObject<Oas3Components>;
+  Components?: VisitFunctionOrObject<Oas3Components | Oas3_1Components>;
   NamedSchemas?: VisitFunctionOrObject<Record<string, Oas3Schema>>;
-  NamedResponses?: VisitFunctionOrObject<Record<string, Oas3Response>>;
-  NamedParameters?: VisitFunctionOrObject<Record<string, Oas3Parameter>>;
+  NamedResponses?: VisitFunctionOrObject<Record<string, Oas3Response<Oas3Schema | Oas3_1Schema>>>;
+  NamedParameters?: VisitFunctionOrObject<Record<string, Oas3Parameter<Oas3Schema | Oas3_1Schema>>>;
   NamedExamples?: VisitFunctionOrObject<Record<string, Oas3Example>>;
-  NamedRequestBodies?: VisitFunctionOrObject<Record<string, Oas3RequestBody>>;
-  NamedHeaders?: VisitFunctionOrObject<Record<string, Oas3Header>>;
+  NamedRequestBodies?: VisitFunctionOrObject<
+    Record<string, Oas3RequestBody<Oas3Schema | Oas3_1Schema>>
+  >;
+  NamedHeaders?: VisitFunctionOrObject<Record<string, Oas3Header<Oas3Schema | Oas3_1Schema>>>;
   NamedSecuritySchemes?: VisitFunctionOrObject<Record<string, Oas3SecurityScheme>>;
   NamedLinks?: VisitFunctionOrObject<Record<string, Oas3Link>>;
-  NamedCallbacks?: VisitFunctionOrObject<Record<string, Oas3Callback>>;
+  NamedCallbacks?: VisitFunctionOrObject<Record<string, Oas3Callback<Oas3Schema | Oas3_1Schema>>>;
   ImplicitFlow?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['implicit']>;
   PasswordFlow?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['password']>;
   ClientCredentials?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['clientCredentials']>;