feat(cli): api v2 configuration supports global header overrides (#4691)

fern-api · Sep 18, 2024 · 6df5775 · 6df5775
1 parent c5be6ea
commit 6df5775
Show file tree

Hide file tree

Showing 11 changed files with 441 additions and 9 deletions.
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,21 @@
+- changelogEntry: 
+    - summary: | 
+        The API V2 configuration (in beta) now supports global header 
+        overrides. To specify global headers that are not in your 
+        OpenAPI spec, simply add the following block in your `generators.yml`: 
+
+        ```yml generators.yml
+        api: 
+          headers: 
+            X-API-VERSION: string
+          specs: 
+            - openapi: /path/to/openapi
+              overrides: /path/to/overrides
+        ```
+      type: feat
+  irVersion: 53
+  version: 0.42.3
+
 - changelogEntry:
     - summary: Removes extraneous conditional error within namespacing configuration
       type: fix

diff --git a/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts
@@ -21,12 +21,18 @@ export interface GeneratorsConfiguration {
 
 export type APIDefinition = SingleNamespaceAPIDefinition | MultiNamespaceAPIDefinition;
 
-export interface SingleNamespaceAPIDefinition extends RawSchemas.WithEnvironmentsSchema, RawSchemas.WithAuthSchema {
+export interface SingleNamespaceAPIDefinition
+    extends RawSchemas.WithEnvironmentsSchema,
+        RawSchemas.WithAuthSchema,
+        RawSchemas.WithHeadersSchema {
     type: "singleNamespace";
     definitions: APIDefinitionLocation[];
 }
 
-export interface MultiNamespaceAPIDefinition extends RawSchemas.WithEnvironmentsSchema, RawSchemas.WithAuthSchema {
+export interface MultiNamespaceAPIDefinition
+    extends RawSchemas.WithEnvironmentsSchema,
+        RawSchemas.WithAuthSchema,
+        RawSchemas.WithHeadersSchema {
     type: "multiNamespace";
     rootDefinitions: APIDefinitionLocation[] | undefined;
     definitions: Record<string, APIDefinitionLocation[]>;

diff --git a/packages/cli/configuration/src/generators-yml/schemas/APIConfigurationV2Schema.ts b/packages/cli/configuration/src/generators-yml/schemas/APIConfigurationV2Schema.ts
@@ -39,7 +39,10 @@ export const SpecSchema = z.union([OpenAPISpecSchema, AsyncAPISchema]);
 
 export type SpecSchema = z.infer<typeof SpecSchema>;
 
-export const APIConfigurationV2Schema = RawSchemas.WithEnvironmentsSchema.extend({
-    auth: z.optional(RawSchemas.ApiAuthSchema),
-    specs: z.array(SpecSchema)
-});
+export const APIConfigurationV2Schema = z
+    .object({
+        auth: z.optional(RawSchemas.ApiAuthSchema),
+        specs: z.array(SpecSchema)
+    })
+    .extend(RawSchemas.WithHeadersSchema.shape)
+    .extend(RawSchemas.WithEnvironmentsSchema.shape);
diff --git a/packages/cli/fern-definition/schema/src/schemas/file-schemas/RootApiFileSchema.ts b/packages/cli/fern-definition/schema/src/schemas/file-schemas/RootApiFileSchema.ts
@@ -25,11 +25,16 @@ export const WithAuthSchema = z.strictObject({
 
 export type WithAuthSchema = z.infer<typeof WithAuthSchema>;
 
+export const WithHeadersSchema = z.strictObject({
+    headers: z.optional(z.record(z.string(), HttpHeaderSchema))
+});
+
+export type WithHeadersSchema = z.infer<typeof WithHeadersSchema>;
+
 export const RootApiFileSchema = z
     .strictObject({
         name: z.string(), // TODO: should this be migrated to id?
         imports: z.optional(z.record(z.string())),
-        headers: z.optional(z.record(z.string(), HttpHeaderSchema)),
         "error-discrimination": z.optional(ErrorDiscriminationSchema),
         audiences: z.optional(z.array(z.string())),
         docs: z.optional(z.string()),
@@ -43,6 +48,7 @@ export const RootApiFileSchema = z
     })
     .extend(WithEnvironmentsSchema.shape)
     .extend(WithAuthSchema.shape)
-    .extend(WithDisplayNameSchema.shape);
+    .extend(WithDisplayNameSchema.shape)
+    .extend(WithHeadersSchema.shape);
 
 export type RootApiFileSchema = z.infer<typeof RootApiFileSchema>;
diff --git a/packages/cli/fern-definition/schema/src/schemas/file-schemas/index.ts b/packages/cli/fern-definition/schema/src/schemas/file-schemas/index.ts
@@ -1,3 +1,3 @@
 export { DefinitionFileSchema } from "./DefinitionFileSchema";
 export { PackageMarkerFileSchema } from "./PackageMarkerFileSchema";
-export { RootApiFileSchema, WithEnvironmentsSchema, WithAuthSchema } from "./RootApiFileSchema";
+export { RootApiFileSchema, WithEnvironmentsSchema, WithAuthSchema, WithHeadersSchema } from "./RootApiFileSchema";
diff --git a/packages/cli/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts b/packages/cli/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts
@@ -23,6 +23,8 @@ export interface OpenApiIrConverterContextOpts {
     authOverrides?: RawSchemas.WithAuthSchema;
 
     environmentOverrides?: RawSchemas.WithEnvironmentsSchema;
+
+    globalHeaderOverrides?: RawSchemas.WithHeadersSchema;
 }
 
 export class OpenApiIrConverterContext {
@@ -32,6 +34,7 @@ export class OpenApiIrConverterContext {
     public builder: FernDefinitionBuilder;
     public environmentOverrides: RawSchemas.WithEnvironmentsSchema | undefined;
     public authOverrides: RawSchemas.WithAuthSchema | undefined;
+    public globalHeaderOverrides: RawSchemas.WithHeadersSchema | undefined;
     public detectGlobalHeaders: boolean;
     private defaultServerName: string | undefined = undefined;
 
@@ -41,6 +44,7 @@ export class OpenApiIrConverterContext {
         enableUniqueErrorsPerEndpoint,
         detectGlobalHeaders,
         environmentOverrides,
+        globalHeaderOverrides,
         authOverrides
     }: OpenApiIrConverterContextOpts) {
         this.logger = taskContext.logger;
@@ -50,6 +54,7 @@ export class OpenApiIrConverterContext {
         this.detectGlobalHeaders = detectGlobalHeaders;
         this.environmentOverrides = environmentOverrides;
         this.authOverrides = authOverrides;
+        this.globalHeaderOverrides = globalHeaderOverrides;
     }
 
     public getSchema(id: SchemaId, namespace: string | undefined): Schema | undefined {