From 81072835526f86ca13c439af4db5b695da152c00 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Tue, 2 Sep 2025 17:06:14 -0400 Subject: [PATCH 1/2] clarify multiple api project structure --- fern/snippets/multiple-apis.mdx | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/fern/snippets/multiple-apis.mdx b/fern/snippets/multiple-apis.mdx index 2bbe1b952..53fbb60a3 100644 --- a/fern/snippets/multiple-apis.mdx +++ b/fern/snippets/multiple-apis.mdx @@ -1,6 +1,8 @@ -The fern folder can house multiple API definitions. When you have multiple APIs, nest your definition files within an `apis` folder. +The fern folder can house multiple API definitions. When you have multiple APIs, nest your definition files within a top-level `apis` folder. -Each API must also have a separate `generators.yml` file that specifies the location of the API definition and configures SDK generation. +Each API must have a separate `generators.yml` file that specifies the location of the API definition and configures SDK generation. + +Below is an example of what a fern folder containing multiple APIs might look like. Your exact structure might vary depending on your organization's conventions and needs – the important part is that each API has its own `generators.yml` file. ```bash fern/ @@ -8,11 +10,11 @@ fern/ ├─ generators.yml # Optional: top-level configuration for all APIs └─ apis/ └─ first-api/ # First API - ├─ generators.yml # Required: points to API spec - └─ openapi/ - ├─ openapi.yml # API Definition file + └─ definition/ + ├─ generators.yml # Required: points to API spec and configures SDKs + └─ openapi.yml # API Definition file └─ second-api/ # Second API - ├─ generators.yml # Required: points to API spec - └─ openapi/ - ├─ openapi.yml # API Definition file + └─ definition/ + ├─ generators.yml # Required: points to API spec and configures SDKs + └─ openapi.yml # API Definition file ``` \ No newline at end of file From 0e7bd89b830ba441a2dbf9e14e2ac54a10c607ad Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Tue, 2 Sep 2025 17:12:11 -0400 Subject: [PATCH 2/2] naming edit for consistency --- fern/snippets/multiple-apis.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/fern/snippets/multiple-apis.mdx b/fern/snippets/multiple-apis.mdx index 53fbb60a3..93554ef3c 100644 --- a/fern/snippets/multiple-apis.mdx +++ b/fern/snippets/multiple-apis.mdx @@ -10,11 +10,11 @@ fern/ ├─ generators.yml # Optional: top-level configuration for all APIs └─ apis/ └─ first-api/ # First API - └─ definition/ + └─ spec-folder/ # definition, openapi, asyncapi, etc. ├─ generators.yml # Required: points to API spec and configures SDKs - └─ openapi.yml # API Definition file + └─ spec-file.yml # API Definition file └─ second-api/ # Second API - └─ definition/ + └─ spec-folder/ # definition, openapi, asyncapi, etc. ├─ generators.yml # Required: points to API spec and configures SDKs - └─ openapi.yml # API Definition file + └─ spec-file.yml # API Definition file ``` \ No newline at end of file