chore: fix OasSchema types (Redocly#1362)

fosrias · Jan 18, 2024 · 63aba31 · 63aba31
1 parent 4f410b5
commit 63aba31
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 13 deletions.
diff --git a/packages/core/src/rules/utils.ts b/packages/core/src/rules/utils.ts
@@ -2,7 +2,7 @@ import levenshtein = require('js-levenshtein');
 import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { validateJsonSchema } from './ajv';
-import { Oas3Schema, Referenced } from '../typings/openapi';
+import { Oas3Schema, Oas3_1Schema, Referenced } from '../typings/openapi';
 import { showErrorForDeprecatedField, showWarningForDeprecatedField } from '../utils';
 
 export function oasTypeOf(value: unknown) {
@@ -91,7 +91,7 @@ export function getSuggest(given: string, variants: string[]): string[] {
 
 export function validateExample(
   example: any,
-  schema: Referenced<Oas3Schema>,
+  schema: Referenced<Oas3Schema | Oas3_1Schema>,
   dataLoc: Location,
   { resolve, location, report }: UserContext,
   allowAdditionalProperties: boolean

diff --git a/packages/core/src/typings/openapi.ts b/packages/core/src/typings/openapi.ts
@@ -111,14 +111,14 @@ export interface Oas3Xml {
   wrapped?: string;
 }
 
-export interface Oas3Schema {
+// common fields for OpenAPI Schema v3.x
+interface Oas3XSchemaBase<T> {
   $ref?: string;
-  type?: string;
-  properties?: { [name: string]: Oas3Schema };
-  additionalProperties?: boolean | Oas3Schema;
+  properties?: { [name: string]: T };
+  additionalProperties?: boolean | T;
   description?: string;
   default?: any;
-  items?: Oas3Schema;
+  items?: T;
   required?: string[];
   readOnly?: boolean;
   writeOnly?: boolean;
@@ -127,10 +127,10 @@ export interface Oas3Schema {
   externalDocs?: Oas3ExternalDocs;
   discriminator?: Oas3Discriminator;
   nullable?: boolean;
-  oneOf?: Oas3Schema[];
-  anyOf?: Oas3Schema[];
-  allOf?: Oas3Schema[];
-  not?: Oas3Schema;
+  oneOf?: T[];
+  anyOf?: T[];
+  allOf?: T[];
+  not?: T;
 
   title?: string;
   multipleOf?: number;
@@ -153,11 +153,15 @@ export interface Oas3Schema {
   'x-tags'?: string[];
 }
 
-export type Oas3_1Schema = Oas3Schema & {
+export interface Oas3Schema extends Oas3XSchemaBase<Oas3Schema> {
+  type?: string;
+}
+
+export interface Oas3_1Schema extends Oas3XSchemaBase<Oas3_1Schema> {
   type?: string | string[];
   examples?: any[];
   prefixItems?: Oas3_1Schema[];
-};
+}
 
 export interface Oas3_1Definition extends Oas3Definition {
   webhooks?: Oas3_1Webhooks;