From 1dc16d19f368841b5f0729f957217ff314426d45 Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Wed, 23 Jul 2025 16:08:31 -0400 Subject: [PATCH 1/4] Remove Fern's SDKs --- .../pages/api-get-started.mdx | 22 ------------------- 1 file changed, 22 deletions(-) diff --git a/fern/products/cli-api-reference/pages/api-get-started.mdx b/fern/products/cli-api-reference/pages/api-get-started.mdx index 535841edb..83c436ddd 100644 --- a/fern/products/cli-api-reference/pages/api-get-started.mdx +++ b/fern/products/cli-api-reference/pages/api-get-started.mdx @@ -7,28 +7,6 @@ subtitle: 'Welcome to the Fern API reference.' The Fern API allows you to manage SDKs and code snippets using Fern's public RESTful API. -## Accessing the Fern API - -Fern maintains official API clients for TypeScript and Python. We recommend using these clients, though the API supports any language or framework that sends HTTP requests. Let us know if you'd like an SDK in another language. - - - } - href='https://github.com/fern-api/typescript-sdk' - > - API client - - - } - href='https://github.com/fern-api/python-sdk' - > - API client - - - ## Authentication Fern API requests require a bearer token for authentication. Use the CLI command [`fern token`](/learn/cli-api/cli-reference/commands#fern-token) to generate a bearer token. Tokens do not expire. From 5c756e3c8b0f4936b0e0a9a18eeb58187610e137 Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Wed, 23 Jul 2025 16:09:56 -0400 Subject: [PATCH 2/4] skip-slug for CLI and API Ref --- fern/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs.yml b/fern/docs.yml index 069eadeb1..6be1736bc 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -62,7 +62,7 @@ products: path: ./products/cli-api-reference/cli-api-reference.yml icon: fa-regular fa-terminal image: ./images/product-switcher/cli-api-reference-light.png - slug: cli-api-reference + skip-slug: true # - display-name: AsyncAPI # path: ./products/asyncapi-def/asyncapi-def.yml From c954109471d3ced5617e06271809d192f96363bd Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Wed, 23 Jul 2025 16:12:11 -0400 Subject: [PATCH 3/4] revert --- fern/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs.yml b/fern/docs.yml index 6be1736bc..069eadeb1 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -62,7 +62,7 @@ products: path: ./products/cli-api-reference/cli-api-reference.yml icon: fa-regular fa-terminal image: ./images/product-switcher/cli-api-reference-light.png - skip-slug: true + slug: cli-api-reference # - display-name: AsyncAPI # path: ./products/asyncapi-def/asyncapi-def.yml From 4e204bcb39846fdf837ecb55b51930c47a73566b Mon Sep 17 00:00:00 2001 From: Danny Sheridan Date: Wed, 23 Jul 2025 16:15:36 -0400 Subject: [PATCH 4/4] Change Fern folder to fern folder --- .../introduction/what-is-the-fern-folder.mdx | 9 ++++---- .../pages/openapi/automation.mdx | 4 ++-- .../api-definition/pages/openapi/overview.mdx | 4 ++-- .../cli-changelog/2023-08-16.mdx | 2 +- .../cli-changelog/2023-11-20.mdx | 22 +++++++++---------- .../products/openapi-def/pages/automation.mdx | 2 +- fern/products/openapi-def/pages/overview.mdx | 4 ++-- fern/products/sdks/fern-folder.mdx | 2 +- .../snippets/initialize-fern-folder-intro.mdx | 2 +- .../sdks/snippets/option-1-openapi.mdx | 2 +- .../sdks/snippets/option-2-fern-def.mdx | 2 +- .../sdks/snippets/option-3-asyncapi.mdx | 2 +- 12 files changed, 28 insertions(+), 29 deletions(-) diff --git a/fern/products/api-definition/pages/introduction/what-is-the-fern-folder.mdx b/fern/products/api-definition/pages/introduction/what-is-the-fern-folder.mdx index ff50b77dc..bcfaa1b62 100644 --- a/fern/products/api-definition/pages/introduction/what-is-the-fern-folder.mdx +++ b/fern/products/api-definition/pages/introduction/what-is-the-fern-folder.mdx @@ -1,14 +1,13 @@ --- title: The Fern Folder -description: Describes the Fern folder structure +description: Describes the fern folder structure and its contents --- -Configuring fern starts with the `fern` folder. The fern folder contains your API definitions, -generators, and your CLI version. +Configuring fern starts with the `fern` folder which contains your API definitions, generators, and your CLI version. ## Directory structure -When you run `fern init`, your Fern folder will be initialized with the following files: +When you run `fern init`, your fern folder will be initialized with the following files: ```bash fern/ ├─ fern.config.json @@ -88,7 +87,7 @@ api: ## Multiple APIs -The Fern folder is capable of housing multiple API definitions. Instead of placing your API definition at the top-level, you can nest them within an `apis` folder. Be sure to include a `generators.yml` file within each API folder that specifies the location of the API definition. +The fern folder is capable of housing multiple API definitions. Instead of placing your API definition at the top-level, you can nest them within an `apis` folder. Be sure to include a `generators.yml` file within each API folder that specifies the location of the API definition. diff --git a/fern/products/api-definition/pages/openapi/automation.mdx b/fern/products/api-definition/pages/openapi/automation.mdx index 5b974583e..042f39552 100644 --- a/fern/products/api-definition/pages/openapi/automation.mdx +++ b/fern/products/api-definition/pages/openapi/automation.mdx @@ -1,6 +1,6 @@ --- title: Sync your OpenAPI Specification -subtitle: Pull your latest OpenAPI Specification into your Fern Folder automatically. +subtitle: Pull your latest OpenAPI Specification into your fern folder automatically. --- If you host your OpenAPI Specification at a publicly available URL, you can have Fern programmatically fetch the latest spec on a preconfigured cadence through the [sync-openapi GitHub Action](https://github.com/fern-api/sync-openapi). This ensures your committed OpenAPI spec stays up to date with your live API. @@ -49,6 +49,6 @@ If you host your OpenAPI Specification at a publicly available URL, you can have Navigate to your repository's `Settings > Secrets and variables > Actions`. Select **New repository secret**, name it `OPENAPI_SYNC_TOKEN`, add your token, and click **Add secret**. -By default, this will create daily PRs with API spec updates to the repo containing your Fern folder. If you would like to adjust the frequency, learn more about GitHub's [schedule event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule). +By default, this will create daily PRs with API spec updates to the repo containing your fern folder. If you would like to adjust the frequency, learn more about GitHub's [schedule event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule). For detailed configuration options and other use cases, see the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi). diff --git a/fern/products/api-definition/pages/openapi/overview.mdx b/fern/products/api-definition/pages/openapi/overview.mdx index 725c5d7fe..c6cc053e0 100644 --- a/fern/products/api-definition/pages/openapi/overview.mdx +++ b/fern/products/api-definition/pages/openapi/overview.mdx @@ -104,9 +104,9 @@ components: in: header ``` -## Setup your Fern folder +## Setup your fern folder -Start by initializing your Fern folder with an OpenAPI spec +Start by initializing your fern folder with an OpenAPI spec ```sh file diff --git a/fern/products/cli-api-reference/cli-changelog/2023-08-16.mdx b/fern/products/cli-api-reference/cli-changelog/2023-08-16.mdx index 760e0f473..0c6fca6d9 100644 --- a/fern/products/cli-api-reference/cli-changelog/2023-08-16.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2023-08-16.mdx @@ -1,3 +1,3 @@ ## 0.15.0-rc0 -**`(chore):`** - **Break**: The fern directory now has a top-level `apis` directory to handle apis and docs no longer live within an api definition +**`(chore):`** - **Break**: The fern folder now has a top-level `apis` directory to handle apis and docs no longer live within an api definition diff --git a/fern/products/cli-api-reference/cli-changelog/2023-11-20.mdx b/fern/products/cli-api-reference/cli-changelog/2023-11-20.mdx index 6af29ab27..27e483578 100644 --- a/fern/products/cli-api-reference/cli-changelog/2023-11-20.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2023-11-20.mdx @@ -11,18 +11,18 @@ **`(chore):`** **Full Changelog**: https://github.com/fern-api/fern/compare/0.15.2-rc0...0.15.2-rc1 ## 0.15.2-rc0 -**`(chore):`** ## What's Changed -* upgrade json5 to `2.2.2` by @dsinghvi in https://github.com/fern-api/fern/pull/2304 -* chore: remove wire verification by @dsinghvi in https://github.com/fern-api/fern/pull/2305 -* chore: upgrade yaml to 2.3.3 by @dsinghvi in https://github.com/fern-api/fern/pull/2306 -* fix: `fern generate --local` with `.fernignore` fails in Github Workflow by @dsinghvi in https://github.com/fern-api/fern/pull/2307 - - +**`(chore):`** ## What's Changed +* upgrade json5 to `2.2.2` by @dsinghvi in https://github.com/fern-api/fern/pull/2304 +* chore: remove wire verification by @dsinghvi in https://github.com/fern-api/fern/pull/2305 +* chore: upgrade yaml to 2.3.3 by @dsinghvi in https://github.com/fern-api/fern/pull/2306 +* fix: `fern generate --local` with `.fernignore` fails in Github Workflow by @dsinghvi in https://github.com/fern-api/fern/pull/2307 + + **Full Changelog**: https://github.com/fern-api/fern/compare/0.15.1...0.15.2-rc0 ## 0.15.1 -**`(chore):`** _It's been forever since we released a non release candidate!_ - -**Break** -- The file structure of the Fern folder has now changed. If you have a single API, your definition can live directly at the top-level. If you have multiple, they will need to live in an apis folder. When you run `fern upgrade` the directory structure will automatically be updated. +**`(chore):`** _It's been forever since we released a non release candidate!_ + +**Break** +- The file structure of the fern folder has now changed. If you have a single API, your definition can live directly at the top-level. If you have multiple, they will need to live in an apis folder. When you run `fern upgrade` the directory structure will automatically be updated. diff --git a/fern/products/openapi-def/pages/automation.mdx b/fern/products/openapi-def/pages/automation.mdx index 5b974583e..23a319a95 100644 --- a/fern/products/openapi-def/pages/automation.mdx +++ b/fern/products/openapi-def/pages/automation.mdx @@ -49,6 +49,6 @@ If you host your OpenAPI Specification at a publicly available URL, you can have Navigate to your repository's `Settings > Secrets and variables > Actions`. Select **New repository secret**, name it `OPENAPI_SYNC_TOKEN`, add your token, and click **Add secret**. -By default, this will create daily PRs with API spec updates to the repo containing your Fern folder. If you would like to adjust the frequency, learn more about GitHub's [schedule event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule). +By default, this will create daily PRs with API spec updates to the repo containing your fern folder. If you would like to adjust the frequency, learn more about GitHub's [schedule event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule). For detailed configuration options and other use cases, see the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi). diff --git a/fern/products/openapi-def/pages/overview.mdx b/fern/products/openapi-def/pages/overview.mdx index 725c5d7fe..c6cc053e0 100644 --- a/fern/products/openapi-def/pages/overview.mdx +++ b/fern/products/openapi-def/pages/overview.mdx @@ -104,9 +104,9 @@ components: in: header ``` -## Setup your Fern folder +## Setup your fern folder -Start by initializing your Fern folder with an OpenAPI spec +Start by initializing your fern folder with an OpenAPI spec ```sh file diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 78ed7ec40..fe5eaa402 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -1,6 +1,6 @@ --- title: Set up the Fern Folder -description: Describes the Fern folder structure +description: Describes the fern folder structure --- Configuring Fern starts with the `fern` folder, the root directory that contains diff --git a/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx b/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx index 1d02a8e1a..7f9cd4b86 100644 --- a/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx +++ b/fern/products/sdks/snippets/initialize-fern-folder-intro.mdx @@ -1,4 +1,4 @@ -You can initialize your Fern folder with either a Fern Definition or OpenAPI specification. +You can initialize your fern folder with either a Fern Definition or OpenAPI specification. You can always convert a Fern Definition to OpenAPI or OpenAPI to a Fern Definition later on. diff --git a/fern/products/sdks/snippets/option-1-openapi.mdx b/fern/products/sdks/snippets/option-1-openapi.mdx index d9aaf5011..aa0fae2ac 100644 --- a/fern/products/sdks/snippets/option-1-openapi.mdx +++ b/fern/products/sdks/snippets/option-1-openapi.mdx @@ -1,5 +1,5 @@ - Initialize the Fern folder using your OpenAPI Specification. Run one of the following commands based on your spec's location. + Initialize the fern folder using your OpenAPI Specification. Run one of the following commands based on your spec's location. Fern can handle both JSON and YML formats for OpenAPI specifications, and the --openapi flag accepts either format, so you can use whichever format your API spec is available in. diff --git a/fern/products/sdks/snippets/option-2-fern-def.mdx b/fern/products/sdks/snippets/option-2-fern-def.mdx index 43fbb5e7f..c0fd80a44 100644 --- a/fern/products/sdks/snippets/option-2-fern-def.mdx +++ b/fern/products/sdks/snippets/option-2-fern-def.mdx @@ -1,4 +1,4 @@ -1. Initialize the Fern folder using the Fern Definition by running the following command: +1. Initialize the fern folder using the Fern Definition by running the following command: ```bash fern init --organization diff --git a/fern/products/sdks/snippets/option-3-asyncapi.mdx b/fern/products/sdks/snippets/option-3-asyncapi.mdx index b445e5004..b54bf097e 100644 --- a/fern/products/sdks/snippets/option-3-asyncapi.mdx +++ b/fern/products/sdks/snippets/option-3-asyncapi.mdx @@ -1,5 +1,5 @@ - Initialize the Fern folder using your AsyncAPI Specification. Run one of the following commands based on your spec's location. + Initialize the fern folder using your AsyncAPI Specification. Run one of the following commands based on your spec's location. Fern can handle both JSON and YML formats for AsyncAPI specifications, and the --openapi flag accepts either format, so you can use whichever format your API spec is available in.