feat: output is now always openapi 3.1

Author: maxholman

lib/api.ts

@@ -1,5 +1,5 @@
 import { Construct, type IConstruct } from 'constructs';
-import type { JSONSchema4, JSONSchema7 } from 'json-schema';
+import type { JSONSchema7 } from 'json-schema';
 import type { OpenAPIV3_1 } from 'openapi-types';
 import { Parameter } from './parameter.js';
 import { Path } from './path.js';
@@ -9,7 +9,7 @@ import { SecurityRequirement } from './security-requirement.js';
 import { SecurityScheme } from './security-scheme.js';
 
 export enum OpenApiVersion {
-  V2 = '2.0',
+  // V2 = '2.0',
   V3 = '3.0',
   V3_1 = '3.1.0',
 }
@@ -40,7 +40,7 @@ export class Api extends Construct {
     return Api.of(scope);
   }
 
-  public synth(): OpenAPIV3_1.Document {
+  public synth() {
     return {
       openapi: this.options.openapi,
       info: this.options.info,
@@ -78,17 +78,17 @@ export class Api extends Construct {
             child instanceof SecurityRequirement,
         )
         .map((child) => child.synth()),
-    };
+    } satisfies OpenAPIV3_1.Document;
   }
 
-  public synthJsonSchema(): JSONSchema4 | JSONSchema7 {
+  public synthJsonSchema() {
     return {
       $schema: 'http://json-schema.org/draft-07/schema#',
       definitions: Object.fromEntries(
         this.node.children
           .filter((child): child is Schema => child instanceof Schema)
           .map((child) => [child.schemaKey, child.synth()]),
       ),
-    };
+    } satisfies JSONSchema7;
   }
 }

lib/media-type.ts

@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import { Reference } from './reference.js';
 import type { Schema } from './schema.js';
 
@@ -24,7 +24,7 @@ export class MediaType extends Construct {
     this.options = options;
   }
 
-  public synth(): OpenAPIV3.MediaTypeObject {
+  public synth(): OpenAPIV3_1.MediaTypeObject {
     return {
       schema:
         this.options.schema instanceof Reference

lib/operation.ts

@@ -66,7 +66,7 @@ export class Operation<TPath extends string = '/'> extends Construct {
     return [];
   }
 
-  public synth(): OpenAPIV3_1.OperationObject {
+  public synth() {
     return {
       ...(this.options.operationId && {
         operationId: this.options.operationId,
@@ -91,6 +91,6 @@ export class Operation<TPath extends string = '/'> extends Construct {
           ]),
         ),
       }),
-    };
+    } satisfies OpenAPIV3_1.OperationObject;
   }
 }

lib/parameter.ts

@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { Api } from './api.js';
 import type { Schema } from './schema.js';
 
@@ -34,7 +34,7 @@ export class Parameter<
     this.options = options;
   }
 
-  public referenceObject(): OpenAPIV3.ReferenceObject {
+  public referenceObject(): OpenAPIV3_1.ReferenceObject {
     return {
       $ref: this.jsonPointer(),
     };
@@ -48,7 +48,7 @@ export class Parameter<
     return `#/components/parameters/${this.schemaKey}`;
   }
 
-  public synth(): OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject {
+  public synth() {
     return {
       name: this.options.name.toString(),
       in: this.options.in,
@@ -66,6 +66,6 @@ export class Parameter<
       ...(this.options.schema && {
         schema: this.options.schema.referenceObject(),
       }),
-    };
+    } satisfies OpenAPIV3_1.ParameterObject | OpenAPIV3_1.ReferenceObject;
   }
 }

lib/path.ts

@@ -62,6 +62,6 @@ export class Path<TPath extends string = '/'> extends Construct {
         ),
       }),
       ...(this.options.summary && { summary: this.options.summary }),
-    };
+    } satisfies OpenAPIV3_1.PathItemObject;
   }
 }

lib/response.ts

@@ -26,14 +26,14 @@ export class Response extends Construct {
     }
   }
 
-  public synth(): OpenAPIV3_1.ResponseObject {
+  public synth() {
     return {
       description: this.options.description || '',
       content: {
         ...(this.content && {
           [this.content.contentType]: this.content.synth(),
         }),
       },
-    };
+    } satisfies OpenAPIV3_1.ResponseObject;
   }
 }

lib/schema.ts

@@ -1,12 +1,12 @@
 import { Construct } from 'constructs';
-import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 
-interface SchemaOptions<T extends OpenAPIV3.SchemaObject> {
+interface SchemaOptions<T extends OpenAPIV3_1.SchemaObject> {
   schema: T;
 }
 
 export class Schema<
-  T extends OpenAPIV3.SchemaObject = OpenAPIV3.SchemaObject,
+  T extends OpenAPIV3_1.SchemaObject = OpenAPIV3_1.SchemaObject,
 > extends Construct {
   private options: SchemaOptions<T>;
 
@@ -24,22 +24,22 @@ export class Schema<
     return this.node.id;
   }
 
-  public jsonPointer(): string {
+  public jsonPointer() {
     return `#/components/schemas/${this.schemaKey}`;
   }
 
-  public referenceObject(): OpenAPIV3.ReferenceObject {
+  public referenceObject() {
     return {
       $ref: this.jsonPointer(),
-    };
+    } satisfies OpenAPIV3_1.ReferenceObject;
   }
 
   // eslint-disable-next-line class-methods-use-this
   public validate() {
     return [];
   }
 
-  public synth(): T {
+  public synth() {
     return this.options.schema;
   }
 }