Skip to content

Document HTTP snippets enabled by default with configuration options #1288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 17, 2025
Merged

Document HTTP snippets enabled by default with configuration options #1288

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f39371
Document HTTP snippets enabled by default with configuration options
devin-ai-integration[bot] Oct 17, 2025
7c968b6
Merge branch 'main' into devin/1760711094-http-snippets-default-enabled
devalog Oct 17, 2025
fd59b33
clarify http snippets doc
devalog Oct 17, 2025
8086b12
clean up docs.yml page
devalog Oct 17, 2025
c8dc3e8
nit
devalog Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions fern/products/docs/pages/api-references/http-snippets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,24 @@
![HTTP code snippet selector](./http-snippets.png)
</Frame>

## 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 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:

Check warning on line 13 in fern/products/docs/pages/api-references/http-snippets.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'are enabled' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'are enabled' looks like passive voice.", "location": {"path": "fern/products/docs/pages/api-references/http-snippets.mdx", "range": {"start": {"line": 13, "column": 15}}}, "severity": "INFO"}

<Note>
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).
</Note>
<CodeBlock title="docs.yml">

```yaml
# Turn off HTTP snippets for all languages
settings:
http-snippets: false

# Enable only for specific languages (here, only Python and Ruby)
settings:
http-snippets:
- python
- ruby
```
</CodeBlock>

## How It Works

Expand Down
20 changes: 20 additions & 0 deletions fern/products/docs/pages/changelog/2025-10-17.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
## HTTP Snippets now enabled by default

Check warning on line 1 in fern/products/docs/pages/changelog/2025-10-17.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.

Raw Output:
{"message": "[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.", "location": {"path": "fern/products/docs/pages/changelog/2025-10-17.mdx", "range": {"start": {"line": 1, "column": 4}}}, "severity": "WARNING"}

Check warning on line 1 in fern/products/docs/pages/changelog/2025-10-17.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Headings] 'HTTP Snippets now enabled by default' should use sentence-style capitalization.

Raw Output:
{"message": "[Microsoft.Headings] 'HTTP Snippets now enabled by default' should use sentence-style capitalization.", "location": {"path": "fern/products/docs/pages/changelog/2025-10-17.mdx", "range": {"start": {"line": 1, "column": 4}}}, "severity": "INFO"}

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.

Check warning on line 3 in fern/products/docs/pages/changelog/2025-10-17.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).

Raw Output:
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "fern/products/docs/pages/changelog/2025-10-17.mdx", "range": {"start": {"line": 3, "column": 1}}}, "severity": "INFO"}

You can now control HTTP snippets directly in your `docs.yml` file:

```yaml title="docs.yml"
# Turn off HTTP snippets
settings:
http-snippets: false

# Or specify only certain languages
settings:
http-snippets:
- python
- ruby
```

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.
Expand Down
10 changes: 8 additions & 2 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,8 +481,14 @@
If set to true, search will display results for pages within the current product and version.
</ParamField>

<ParamField path="settings.http-snippets" type="boolean" required={false} default="false" toc={true}>
If set to true, the HTTP snippets will be displayed in the API Reference.
<ParamField path="settings.http-snippets" type="boolean | array" required={false} default="true" toc={true}>
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

Check failure on line 489 in fern/products/docs/pages/customization/what-is-docs-yml.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "fern/products/docs/pages/customization/what-is-docs-yml.mdx", "range": {"start": {"line": 489, "column": 47}}}, "severity": "ERROR"}

Learn more in the [HTTP snippets documentation](/docs/api-references/http-snippets).
</ParamField>

<ParamField path="settings.hide-404-page" type="boolean" required={false} default="false" toc={true}>
Expand Down