chore: Add snippetsConfiguration to ApiDefinitionLatest (#2167)

fern-api · Feb 14, 2025 · 6a9e227 · 6a9e227
1 parent 697fb16
commit 6a9e227
Show file tree

Hide file tree

Showing 16 changed files with 331 additions and 78 deletions.
diff --git a/fern/apis/fdr/definition/api/latest/__package__.yml b/fern/apis/fdr/definition/api/latest/__package__.yml
@@ -8,7 +8,7 @@ imports:
   commons: commons.yml
   rootCommons: ../../commons.yml
   auth: auth.yml
-
+  v1Register: ../v1/register/__package__.yml
 service:
   base-path: /registry/api/latest
   auth: true
@@ -35,6 +35,7 @@ types:
       subpackages: map<commons.SubpackageId, commons.SubpackageMetadata>
       auths: map<auth.AuthSchemeId, auth.AuthScheme>
       globalHeaders: optional<list<type.ObjectProperty>>
+      snippetsConfiguration: optional<v1Register.SnippetsConfig>
 
 errors:
   ApiDoesNotExistError:

diff --git a/packages/fdr-sdk/src/api-definition/__test__/join.test.ts b/packages/fdr-sdk/src/api-definition/__test__/join.test.ts
@@ -219,6 +219,7 @@ const api1: Latest.ApiDefinition = {
       availability: undefined,
     },
   ],
+  snippetsConfiguration: undefined,
 };
 
 const api2: Latest.ApiDefinition = {
@@ -251,6 +252,7 @@ const api2: Latest.ApiDefinition = {
       availability: undefined,
     },
   ],
+  snippetsConfiguration: undefined,
 };
 
 const api3: Latest.ApiDefinition = {
@@ -281,6 +283,7 @@ const api3: Latest.ApiDefinition = {
       availability: undefined,
     },
   ],
+  snippetsConfiguration: undefined,
 };
 
 describe("join", () => {

diff --git a/packages/fdr-sdk/src/api-definition/__test__/prune.test.ts b/packages/fdr-sdk/src/api-definition/__test__/prune.test.ts
@@ -226,6 +226,7 @@ const api: Latest.ApiDefinition = {
       availability: undefined,
     },
   ],
+  snippetsConfiguration: undefined,
 };
 
 describe("prune", () => {

diff --git a/packages/fdr-sdk/src/api-definition/join.ts b/packages/fdr-sdk/src/api-definition/join.ts
@@ -24,6 +24,9 @@ export function joiner(
       subpackages: { ...first.subpackages },
       auths: { ...first.auths },
       globalHeaders: first.globalHeaders ? [...first.globalHeaders] : undefined,
+      snippetsConfiguration: first.snippetsConfiguration
+        ? { ...first.snippetsConfiguration }
+        : undefined,
     };
 
     let isJoined = false;

diff --git a/packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts b/packages/fdr-sdk/src/api-definition/migrators/v1ToV2.ts
@@ -142,6 +142,7 @@ export class ApiDefinitionV1ToLatest {
       subpackages: this.subpackages,
       auths: this.v1.auth ? { [AUTH_SCHEME_ID]: this.v1.auth } : {},
       globalHeaders: this.migrateParameters(this.v1.globalHeaders),
+      snippetsConfiguration: undefined,
     };
   };
 

diff --git a/packages/fdr-sdk/src/api-definition/transformer.ts b/packages/fdr-sdk/src/api-definition/transformer.ts
@@ -240,6 +240,7 @@ export class Transformer {
       globalHeaders,
       auths: api.auths,
       subpackages: api.subpackages,
+      snippetsConfiguration: api.snippetsConfiguration,
     };
   };
 

diff --git a/...es/fdr-sdk/src/client/generated/api/resources/api/resources/latest/types/ApiDefinition.ts b/...es/fdr-sdk/src/client/generated/api/resources/api/resources/latest/types/ApiDefinition.ts
diff --git a/...k/src/client/generated/api/resources/api/resources/v1/resources/register/client/Client.ts b/...k/src/client/generated/api/resources/api/resources/v1/resources/register/client/Client.ts
diff --git a/...urces/api/resources/v1/resources/register/client/requests/RegisterApiDefinitionRequest.ts b/...urces/api/resources/v1/resources/register/client/requests/RegisterApiDefinitionRequest.ts
diff --git a/packages/fern-docs/cache/src/__test__/ApiDefinitionLoader.test.ts b/packages/fern-docs/cache/src/__test__/ApiDefinitionLoader.test.ts
@@ -96,6 +96,7 @@ describe("curl snippet generation", () => {
     const apiDefinition = await loader
       .withApiDefinition({
         id: ApiDefinitionId("id"),
+        snippetsConfiguration: undefined,
         webhooks: {},
         websockets: {},
         types: {},

diff --git a/...es/parsers/src/client/generated/api/resources/api/resources/latest/types/ApiDefinition.ts b/...es/parsers/src/client/generated/api/resources/api/resources/latest/types/ApiDefinition.ts
diff --git a/packages/parsers/src/openapi/3.1/OpenApiDocumentConverter.node.ts b/packages/parsers/src/openapi/3.1/OpenApiDocumentConverter.node.ts
@@ -154,6 +154,7 @@ export class OpenApiDocumentConverterNode extends BaseOpenApiV3_1ConverterNode<
       subpackages,
       auths: { ...auths, ...(this.auth?.convert() ?? {}) },
       globalHeaders: this.globalHeaders?.convert(),
+      snippetsConfiguration: undefined,
     };
   }
 }
diff --git a/packages/parsers/src/openrpc/1.x/OpenrpcDocumentConverter.node.ts b/packages/parsers/src/openrpc/1.x/OpenrpcDocumentConverter.node.ts
@@ -94,6 +94,7 @@ export class OpenrpcDocumentConverterNode extends BaseOpenrpcConverterNode<
       subpackages,
       auths: {},
       globalHeaders: [],
+      snippetsConfiguration: undefined,
     };
   }
 }
diff --git a/servers/fdr/src/api/generated/api/resources/api/resources/latest/types/ApiDefinition.d.ts b/servers/fdr/src/api/generated/api/resources/api/resources/latest/types/ApiDefinition.d.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -226,6 +226,7 @@ const api: Latest.ApiDefinition = { @@
           availability: undefined,
         },
       ],
+      snippetsConfiguration: undefined,
     };
     describe("prune", () => {
@@ Expand Down @@