Skip to content

Commit fd59b33

Browse files
committed
clarify http snippets doc
1 parent 7c968b6 commit fd59b33

File tree

2 files changed

+6
-33
lines changed

2 files changed

+6
-33
lines changed

fern/products/docs/pages/api-references/http-snippets.mdx

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,45 +10,23 @@ subtitle: HTTP snippets allow users to see API request examples using common HTT
1010

1111
## Configuration
1212

13-
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.
14-
15-
### Enable all HTTP snippets (default)
16-
17-
By default, all supported HTTP snippet languages will be displayed:
13+
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:
1814

1915
<CodeBlock title="docs.yml">
20-
```yaml
21-
# HTTP snippets are enabled by default
22-
# No configuration needed
23-
```
24-
</CodeBlock>
25-
26-
### Disable HTTP snippets
2716

28-
To turn off HTTP snippets completely:
29-
30-
<CodeBlock title="docs.yml">
3117
```yaml
18+
# Turn off HTTP snippets for all languages
3219
settings:
3320
http-snippets: false
34-
```
35-
</CodeBlock>
36-
37-
### Display specific languages
38-
39-
To show only a subset of HTTP snippet languages, provide an array of language identifiers:
4021

41-
<CodeBlock title="docs.yml">
42-
```yaml
22+
# Enable only for specific languages (here, only Python and Ruby)
4323
settings:
4424
http-snippets:
4525
- python
4626
- ruby
4727
```
4828
</CodeBlock>
4929
50-
This configuration will display only Python and Ruby HTTP snippets, excluding cURL and other languages.
51-
5230
## How It Works
5331
5432
### Request Examples

fern/products/docs/pages/changelog/2025-10-17.mdx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## HTTP Snippets Now Enabled by Default
1+
## HTTP Snippets now enabled by default
22

33
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.
44

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

7-
```yaml
7+
```yaml title="docs.yml"
88
# Turn off HTTP snippets
99
settings:
1010
http-snippets: false
@@ -16,13 +16,8 @@ settings:
1616
- ruby
1717
```
1818
19-
If you don't specify any configuration, all HTTP snippet languages will be displayed by default.
19+
Visit the [HTTP snippets documentation](/docs/api-references/http-snippets) to learn more.
2020
21-
<Card
22-
title="Learn more about HTTP snippets"
23-
variant="bordered"
24-
href="/docs/api-references/http-snippets"
25-
/>
2621
## Introducing Runnable Endpoint
2722
2823
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.

0 commit comments

Comments
 (0)