From 3f39371c5c4f5b11aca362b358c587bec0320440 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Fri, 17 Oct 2025 14:25:11 +0000 Subject: [PATCH 1/4] Document HTTP snippets enabled by default with configuration options Co-Authored-By: Catherine Deskur --- .../pages/api-references/http-snippets.mdx | 45 ++++++++++++++++--- .../docs/pages/changelog/2025-10-17.mdx | 25 +++++++++++ .../pages/customization/what-is-docs-yml.mdx | 10 ++++- 3 files changed, 71 insertions(+), 9 deletions(-) create mode 100644 fern/products/docs/pages/changelog/2025-10-17.mdx diff --git a/fern/products/docs/pages/api-references/http-snippets.mdx b/fern/products/docs/pages/api-references/http-snippets.mdx index a9cc3fd54..1e1dbc2a1 100644 --- a/fern/products/docs/pages/api-references/http-snippets.mdx +++ b/fern/products/docs/pages/api-references/http-snippets.mdx @@ -8,15 +8,46 @@ subtitle: HTTP snippets allow users to see API request examples using common HTT ![HTTP code snippet selector](./http-snippets.png) -## Setup +## Configuration -1. Ensure you have a paid Fern subscription -2. Contact support to request HTTP snippets activation -3. Once enabled, build your production docs +HTTP snippets are now enabled by default for all documentation sites. You can control this behavior using the `settings.http-snippets` configuration in your `docs.yml` file. - -Currently, HTTP snippets are provided as an all-or-nothing set. You cannot configure which languages are displayed. If you would like this feature, please [open a GitHub issue](https://github.com/fern-api/fern/issues/new?template=docs-feature.yml). - +### Enable all HTTP snippets (default) + +By default, all supported HTTP snippet languages will be displayed: + + +```yaml +# HTTP snippets are enabled by default +# No configuration needed +``` + + +### Disable HTTP snippets + +To turn off HTTP snippets completely: + + +```yaml +settings: + http-snippets: false +``` + + +### Display specific languages + +To show only a subset of HTTP snippet languages, provide an array of language identifiers: + + +```yaml +settings: + http-snippets: + - python + - ruby +``` + + +This configuration will display only Python and Ruby HTTP snippets, excluding cURL and other languages. ## How It Works diff --git a/fern/products/docs/pages/changelog/2025-10-17.mdx b/fern/products/docs/pages/changelog/2025-10-17.mdx new file mode 100644 index 000000000..2ea9c7310 --- /dev/null +++ b/fern/products/docs/pages/changelog/2025-10-17.mdx @@ -0,0 +1,25 @@ +## HTTP Snippets Now Enabled by Default + +HTTP snippets are now enabled by default for all documentation sites, making it easier for developers to see cURL, Python, Ruby, and other HTTP client examples directly in your API reference. Previously, this feature required internal configuration to activate. + +You can now control HTTP snippets directly in your `docs.yml` file: + +```yaml +# Turn off HTTP snippets +settings: + http-snippets: false + +# Or specify only certain languages +settings: + http-snippets: + - python + - ruby +``` + +If you don't specify any configuration, all HTTP snippet languages will be displayed by default. + + diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index 2532f201d..76229ee6b 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -481,8 +481,14 @@ settings: If set to true, search will display results for pages within the current product and version. - - If set to true, the HTTP snippets will be displayed in the API Reference. + + Controls the display of HTTP snippets in the API Reference. HTTP snippets are now enabled by default. + + - Set to `false` to disable HTTP snippets completely + - Set to `true` (or omit) to enable all HTTP snippet languages + - Provide an array of language identifiers (e.g., `["python", "ruby"]`) to display only specific languages + + Learn more in the [HTTP snippets documentation](/docs/api-references/http-snippets). From fd59b33cbd87e3876cf5751b20553a2ba94ee854 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 17 Oct 2025 14:44:28 -0400 Subject: [PATCH 2/4] clarify http snippets doc --- .../pages/api-references/http-snippets.mdx | 28 ++----------------- .../docs/pages/changelog/2025-10-17.mdx | 11 ++------ 2 files changed, 6 insertions(+), 33 deletions(-) diff --git a/fern/products/docs/pages/api-references/http-snippets.mdx b/fern/products/docs/pages/api-references/http-snippets.mdx index 1e1dbc2a1..49918fc84 100644 --- a/fern/products/docs/pages/api-references/http-snippets.mdx +++ b/fern/products/docs/pages/api-references/http-snippets.mdx @@ -10,36 +10,16 @@ subtitle: HTTP snippets allow users to see API request examples using common HTT ## Configuration -HTTP snippets are now enabled by default for all documentation sites. You can control this behavior using the `settings.http-snippets` configuration in your `docs.yml` file. - -### Enable all HTTP snippets (default) - -By default, all supported HTTP snippet languages will be displayed: +HTTP snippets are enabled by default for all documentation sites. To disable snippets or enable only for certain languages, use the `settings.http-snippets` configuration in your `docs.yml` file: -```yaml -# HTTP snippets are enabled by default -# No configuration needed -``` - - -### Disable HTTP snippets -To turn off HTTP snippets completely: - - ```yaml +# Turn off HTTP snippets for all languages settings: http-snippets: false -``` - - -### Display specific languages - -To show only a subset of HTTP snippet languages, provide an array of language identifiers: - -```yaml +# Enable only for specific languages (here, only Python and Ruby) settings: http-snippets: - python @@ -47,8 +27,6 @@ settings: ``` -This configuration will display only Python and Ruby HTTP snippets, excluding cURL and other languages. - ## How It Works ### Request Examples diff --git a/fern/products/docs/pages/changelog/2025-10-17.mdx b/fern/products/docs/pages/changelog/2025-10-17.mdx index eddc629d8..ce00ceb29 100644 --- a/fern/products/docs/pages/changelog/2025-10-17.mdx +++ b/fern/products/docs/pages/changelog/2025-10-17.mdx @@ -1,10 +1,10 @@ -## HTTP Snippets Now Enabled by Default +## HTTP Snippets now enabled by default HTTP snippets are now enabled by default for all documentation sites, making it easier for developers to see cURL, Python, Ruby, and other HTTP client examples directly in your API reference. Previously, this feature required internal configuration to activate. You can now control HTTP snippets directly in your `docs.yml` file: -```yaml +```yaml title="docs.yml" # Turn off HTTP snippets settings: http-snippets: false @@ -16,13 +16,8 @@ settings: - ruby ``` -If you don't specify any configuration, all HTTP snippet languages will be displayed by default. +Visit the [HTTP snippets documentation](/docs/api-references/http-snippets) to learn more. - ## Introducing Runnable Endpoint Test API endpoints directly from your documentation with our new interactive component. Runnable Endpoint allows your users to send real HTTP requests to your API without leaving your docs, making it easier for developers to explore and understand your API. From 8086b122dd921e1c71b2e4b247056f39ca175238 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 17 Oct 2025 14:51:32 -0400 Subject: [PATCH 3/4] clean up docs.yml page --- .../pages/customization/what-is-docs-yml.mdx | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index 76229ee6b..7da5516e2 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -481,14 +481,19 @@ settings: If set to true, search will display results for pages within the current product and version. - - Controls the display of HTTP snippets in the API Reference. HTTP snippets are now enabled by default. + + Controls the display of [HTTP snippets in the API Reference](/docs/api-references/http-snippets). HTTP snippets are enabled by default for all languages. - Set to `false` to disable HTTP snippets completely - - Set to `true` (or omit) to enable all HTTP snippet languages - - Provide an array of language identifiers (e.g., `["python", "ruby"]`) to display only specific languages - - Learn more in the [HTTP snippets documentation](/docs/api-references/http-snippets). + - Provide a list of languages to enable snippets for specific languages only + +```yaml title="docs.yml" +# Enable only for Python and Ruby +settings: + http-snippets: + - python + - ruby +``` From c8dc3e85a2729ed868faec82254e204a322178e3 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 17 Oct 2025 14:58:06 -0400 Subject: [PATCH 4/4] nit --- fern/products/docs/pages/customization/what-is-docs-yml.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index 7da5516e2..ee98ff5ea 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -458,7 +458,7 @@ settings: disable-search: false dark-mode-code: true default-search-filters: true - http-snippets: true + http-snippets: false hide-404-page: true use-javascript-as-typescript: false ```