From d8fe7d6c871785c01656875e553973670809ad06 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Sat, 26 Jul 2025 19:19:03 -0400 Subject: [PATCH 1/2] make clarifying updates --- .../sdks/snippets/option-1-openapi.mdx | 25 +++++++++++-------- .../sdks/snippets/option-2-fern-def.mdx | 4 +-- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/fern/products/sdks/snippets/option-1-openapi.mdx b/fern/products/sdks/snippets/option-1-openapi.mdx index aa0fae2ac..d02c865eb 100644 --- a/fern/products/sdks/snippets/option-1-openapi.mdx +++ b/fern/products/sdks/snippets/option-1-openapi.mdx @@ -1,31 +1,34 @@ - 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. 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. - - 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. - - - - `--organization ` configures your organization name in `fern.config.json`. This is required in order to successfully generate your SDK. - + Run one of the following commands based on your spec's location:test ```bash - fern init --openapi path/to/openapi.yml --organization + fern init --openapi path/to/openapi.yml \ + --organization ``` ```bash - fern init --openapi https://api.example.com/openapi.yml --organization + fern init --openapi https://api.example.com/openapi.yml \ + --organization ``` - This creates a `fern` folder in your current directory with the OpenAPI Specification. The exact folder structure might look different depending on your initial input files. + `--organization ` configures your organization name in + `fern.config.json`. This is required in order to successfully generate your + SDK. + + This creates a `fern` folder in your current directory with the OpenAPI Specification. The exact folder structure might look different depending on your initial input files. ```bash fern/ diff --git a/fern/products/sdks/snippets/option-2-fern-def.mdx b/fern/products/sdks/snippets/option-2-fern-def.mdx index c0fd80a44..76216d2eb 100644 --- a/fern/products/sdks/snippets/option-2-fern-def.mdx +++ b/fern/products/sdks/snippets/option-2-fern-def.mdx @@ -4,9 +4,9 @@ fern init --organization ``` - `--organization ` configures your organization + `--organization ` configures your organization name in `fern.config.json`. This is required in order to successfully - generate your SDK. + generate your SDK. This creates a `fern` folder in your current directory with the Fern Definition. From f37a63d5f846f79c84682898267d2a6db36377c8 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Sat, 26 Jul 2025 19:21:25 -0400 Subject: [PATCH 2/2] edit --- fern/products/sdks/snippets/option-1-openapi.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fern/products/sdks/snippets/option-1-openapi.mdx b/fern/products/sdks/snippets/option-1-openapi.mdx index d02c865eb..644a1632c 100644 --- a/fern/products/sdks/snippets/option-1-openapi.mdx +++ b/fern/products/sdks/snippets/option-1-openapi.mdx @@ -1,7 +1,7 @@ Initialize the fern folder using your OpenAPI Specification. 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 + 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. Run one of the following commands based on your spec's location:test