Skip to content

Add clarification for http-snippets configuration with curl-only example #1337

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 20, 2025
Merged

Add clarification for http-snippets configuration with curl-only example #1337

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4454174
Add clarification for http-snippets configuration with curl-only example
devin-ai-integration[bot] Oct 20, 2025
42b28de
Update: clarify that curl is always shown by default
devin-ai-integration[bot] Oct 20, 2025
7a8f24a
Fix Vale style issues: use active voice and contractions
devin-ai-integration[bot] Oct 20, 2025
8cd8e91
fix callout and tighten language
devalog Oct 20, 2025
c5a15f5
language fix
devalog Oct 20, 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
10 changes: 7 additions & 3 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 @@ -10,16 +10,20 @@

## Configuration

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:
All documentation sites include HTTP snippets by default. To control which languages appear in the HTTP snippet selector, use the `settings.http-snippets` configuration in your `docs.yml` file.

<Note>
curl is always displayed in the HTTP snippets selector and can't be removed via `docs.yml` configuration. To hide it, [use custom CSS](/docs/customization/custom-css-js#custom-css).

Check warning on line 16 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] 'be removed' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'be removed' looks like passive voice.", "location": {"path": "fern/products/docs/pages/api-references/http-snippets.mdx", "range": {"start": {"line": 16, "column": 68}}}, "severity": "INFO"}
</Note>

<CodeBlock title="docs.yml">

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

# Enable only for specific languages (here, only Python and Ruby)
# Enable only specific languages (in addition to curl)
settings:
http-snippets:
- python
Expand Down