fix(cli): log the name of the api that fails to register (#4753)

fern-api · Sep 26, 2024 · 2c5bf84 · 2c5bf84
1 parent d95bbc6
commit 2c5bf84
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/fern/pages/changelogs/cli/2024-09-26.mdx b/fern/pages/changelogs/cli/2024-09-26.mdx
@@ -0,0 +1,4 @@
+## 0.43.2
+**`(fix):`** The CLI now prints which API cannot be registered if `fern generate --docs` fails. 
+
+
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,10 @@
+- changelogEntry:
+    - summary: |
+        The CLI now prints which API cannot be registered if `fern generate --docs` fails. 
+      type: fix
+  irVersion: 53
+  version: 0.43.2
+
 - changelogEntry:
     - summary: |
         The CLI now supports running OpenAPI generator 0.1.0 with IR version 53. 

diff --git a/packages/cli/docs-resolver/src/DocsDefinitionResolver.ts b/packages/cli/docs-resolver/src/DocsDefinitionResolver.ts
@@ -49,6 +49,7 @@ export class DocsDefinitionResolver {
             ir: IntermediateRepresentation;
             snippetsConfig: APIV1Write.SnippetsConfig;
             playgroundConfig?: DocsV1Write.PlaygroundConfig;
+            apiName?: string;
         }) => Promise<string>
     ) {}
 
@@ -383,7 +384,8 @@ export class DocsDefinitionResolver {
                 const apiDefinitionId = await this.registerApi({
                     ir,
                     snippetsConfig,
-                    playgroundConfig: { oauth: item.playground?.oauth }
+                    playgroundConfig: { oauth: item.playground?.oauth },
+                    apiName: item.apiName
                 });
                 const api = convertIrToApiDefinition(ir, apiDefinitionId, { oauth: item.playground?.oauth });
                 const node = new ApiReferenceNodeConverter(

diff --git a/packages/cli/generation/remote-generation/remote-workspace-runner/src/publishDocs.ts b/packages/cli/generation/remote-generation/remote-workspace-runner/src/publishDocs.ts
@@ -151,7 +151,7 @@ export async function publishDocs({
                 }
             }
         },
-        async ({ ir, snippetsConfig, playgroundConfig }) => {
+        async ({ ir, snippetsConfig, playgroundConfig, apiName }) => {
             const apiDefinition = convertIrToFdrApi({ ir, snippetsConfig, playgroundConfig });
             context.logger.debug("Calling registerAPI... ", JSON.stringify(apiDefinition, undefined, 4));
             const response = await fdr.api.v1.register.registerApiDefinition({
@@ -172,7 +172,11 @@ export async function publishDocs({
                         );
                     }
                     default:
-                        return context.failAndThrow("Failed to register API", response.error);
+                        if (apiName != null) {
+                            return context.failAndThrow(`Failed to register API ${apiName}`, response.error);
+                        } else {
+                            return context.failAndThrow("Failed to register API", response.error);
+                        }
                 }
             }
         }