break(cli): require generators.yml to be present if using OpenAPI (#…

…4510)
fern-api · Sep 3, 2024 · 6b62522 · 6b62522
1 parent 7554746
commit 6b62522
Show file tree

Hide file tree

Showing 41 changed files with 1,849 additions and 102 deletions.
diff --git a/fern/pages/api-definition/introduction/what-is-the-fern-folder.mdx b/fern/pages/api-definition/introduction/what-is-the-fern-folder.mdx
@@ -51,6 +51,8 @@ The `generators.yml` file can include information about where your API specifica
 <AccordionGroup>
 <Accordion title="generators.yml for Python + TypeScript SDKs">
 ```yaml
+api: 
+  path: ./path/to/openapi.yml
 groups:
   public:
     generators:
@@ -79,7 +81,7 @@ groups:
 <Accordion title="generators.yml for locating an API definition">
 ```yaml
 api: 
-  path: ./api.yaml
+  path: ./path/to/openapi.yml
 ```
 </Accordion>
 </AccordionGroup>

diff --git a/generators/commons/src/__test__/SourceFetcher.test.ts b/generators/commons/src/__test__/SourceFetcher.test.ts
@@ -1,4 +1,4 @@
-import { AbsoluteFilePath, getDirectoryContents } from "@fern-api/fs-utils";
+import { AbsoluteFilePath, getDirectoryContents, getDirectoryContentsForSnapshot } from "@fern-api/fs-utils";
 import path from "path";
 import { AbstractGeneratorContext } from "../AbstractGeneratorContext";
 import { SourceFetcher } from "../SourceFetcher";
@@ -31,5 +31,5 @@ it("fetch proto.zip", async () => {
         "google/api/http.proto",
         "user/v1/user.proto"
     ]);
-    expect(await getDirectoryContents(FIXTURES)).toMatchSnapshot();
+    expect(await getDirectoryContentsForSnapshot(FIXTURES)).toMatchSnapshot();
 }, 100_000);
diff --git a/...rations/0.15.0-rc0/update-directory-structure/__test__/update-directory-structure.test.ts b/...rations/0.15.0-rc0/update-directory-structure/__test__/update-directory-structure.test.ts
@@ -1,4 +1,4 @@
-import { AbsoluteFilePath, getDirectoryContents, join, RelativeFilePath } from "@fern-api/fs-utils";
+import { AbsoluteFilePath, getDirectoryContentsForSnapshot, join, RelativeFilePath } from "@fern-api/fs-utils";
 import { createMockTaskContext } from "@fern-api/task-context";
 import { cp } from "fs/promises";
 import tmp from "tmp-promise";
@@ -27,7 +27,7 @@ describe("update-directory-structure", () => {
             // eslint-disable-next-line no-console
             console.log(`Migrated fixture ${fixture} at path ${tmpDir.path}`);
 
-            expect(await getDirectoryContents(AbsoluteFilePath.of(tmpDir.path))).toMatchSnapshot();
+            expect(await getDirectoryContentsForSnapshot(AbsoluteFilePath.of(tmpDir.path))).toMatchSnapshot();
         });
     }
 

diff --git a/packages/cli/cli-migrations/src/migrations/0.41.0-rc0/index.ts b/packages/cli/cli-migrations/src/migrations/0.41.0-rc0/index.ts
@@ -0,0 +1,9 @@
+import { VersionMigrations } from "../../types/VersionMigrations";
+import RequireGeneratorsYml from "./require-generators-yml";
+
+const versionMigrations: VersionMigrations = {
+    version: "0.41.0-rc0",
+    migrations: [RequireGeneratorsYml]
+};
+
+export default versionMigrations;