Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions fern/products/docs/pages/api-references/api-explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Fern will automatically populate the fields of the endpoint with the values set

## Authentication

The API Explorer supports [all authentication schemes](/learn/api-definitions/openapi/authentication) configured in your OpenAPI spec or in `generators.yml`, including multiple authentication schemes. OAuth client credentials additionally requires enabling [`playground.oauth`](/learn/docs/api-references/customize-api-ref#setting-api-explorer-options) in your `docs.yml`.
The API Explorer supports [all authentication schemes](/learn/api-definitions/openapi/authentication) configured in your OpenAPI spec or in `generators.yml`, including multiple authentication schemes. OAuth client credentials additionally requires enabling [`playground.oauth`](/learn/docs/api-references/customize-api-reference-layout#setting-api-explorer-options) in your `docs.yml`.

When multiple schemes are available, the API Explorer automatically displays them in a dropdown menu, allowing users to select and configure their preferred authentication method before sending requests. Once a user sets their authentication credentials, their credentials persist throughout their entire exploration session.

Expand All @@ -27,7 +27,7 @@ To automatically populate API keys for logged-in users, see [API key injection](

## Multiple environments

When multiple server URLs are configured in [OpenAPI](/learn/api-definitions/openapi/extensions/server-names-and-url-templating), users can switch between environments (e.g., production and sandbox) from a dropdown in the API Explorer. The selected environment persists as they navigate between pages. By default every configured environment appears; use the [`playground.environments`](/learn/docs/api-references/customize-api-ref#setting-api-explorer-options) option in your `docs.yml` to restrict which ones are available.
When multiple server URLs are configured in [OpenAPI](/learn/api-definitions/openapi/extensions/server-names-and-url-templating), users can switch between environments (e.g., production and sandbox) from a dropdown in the API Explorer. The selected environment persists as they navigate between pages. By default every configured environment appears; use the [`playground.environments`](/learn/docs/api-references/customize-api-reference-layout#setting-api-explorer-options) option in your `docs.yml` to restrict which ones are available.

<div style="position: relative; padding-bottom: 50.63657407407407%; height: 0;"><iframe src="https://www.loom.com/embed/cb642161678e41cabcb677b900006f40?sid=5e45243c-3ba1-45cf-860b-72eee1970fc5?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/api-references/sdk-snippets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,4 @@ navigation:

## Endpoint request and response snippets

Looking for information on generating API endpoint request and response snippets? See our documentation on [Endpoint Request Snippets](/learn/docs/content/components/request-snippet) and [Endpoint Response Snippets](/learn/docs/content/components/response-snippet).
Looking for information on generating API endpoint request and response snippets? See our documentation on [Endpoint Request Snippets](/learn/docs/writing-content/components/request-snippet) and [Endpoint Response Snippets](/learn/docs/writing-content/components/response-snippet).
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ For more advanced table features like sticky headers for longer datasets, see th

## Fern components

Fern has a built-in component library you can use in Markdown. [Explore the components.](/learn/docs/content/components/overview)
Fern has a built-in component library you can use in Markdown. [Explore the components.](/learn/docs/writing-content/components/overview)
Original file line number Diff line number Diff line change
Expand Up @@ -81,26 +81,26 @@ Fern Editor supports creating and editing the following components:

| Component | Support status |
| --- | --- |
| [Accordions](/learn/docs/content/components/accordions) | Supported |
| [Accordion Groups](/learn/docs/content/components/accordion-groups) | Supported |
| [Aside](/learn/docs/content/components/aside) | Coming soon |
| [Button](/learn/docs/content/components/button) | Supported |
| [Callouts](/learn/docs/content/components/callouts) | Supported |
| [Accordions](/learn/docs/writing-content/components/accordions) | Supported |
| [Accordion Groups](/learn/docs/writing-content/components/accordion-groups) | Supported |
| [Aside](/learn/docs/writing-content/components/aside) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

| [Button](/learn/docs/writing-content/components/button) | Supported |
| [Callouts](/learn/docs/writing-content/components/callouts) | Supported |
| [Cards](/learn/docs/writing-content/components/cards) | Supported |
| [Card Groups](/learn/docs/content/components/card-groups) | Supported |
| [Code Blocks](/learn/docs/content/components/code-blocks) | Supported |
| [Embed](/learn/docs/content/components/embed) | Supported |
| [Endpoint Request Snippet](/learn/docs/content/components/request-snippet) | Supported |
| [Endpoint Response Snippet](/learn/docs/content/components/response-snippet) | Supported |
| [Card Groups](/learn/docs/writing-content/components/card-groups) | Supported |
| [Code Blocks](/learn/docs/writing-content/components/code-blocks) | Supported |
| [Embed](/learn/docs/writing-content/components/embed) | Supported |
| [Endpoint Request Snippet](/learn/docs/writing-content/components/request-snippet) | Supported |
| [Endpoint Response Snippet](/learn/docs/writing-content/components/response-snippet) | Supported |
| [Endpoint Schema Snippet](/learn/docs/writing-content/components/endpoint-schema-snippet) | Supported |
| [Frames](/learn/docs/content/components/frames) | Coming soon |
| [Icons](/learn/docs/content/components/icons) | Coming soon |
| [Parameter Fields](/learn/docs/content/components/parameter-fields) | Supported |
| [Steps](/learn/docs/content/components/steps) | Supported |
| [Frames](/learn/docs/writing-content/components/frames) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

| [Icons](/learn/docs/writing-content/components/icons) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated

| [Parameter Fields](/learn/docs/writing-content/components/parameter-fields) | Supported |
| [Steps](/learn/docs/writing-content/components/steps) | Supported |
| [Tables](/learn/docs/writing-content/components/tables) | Supported |
| [Sticky tables](/learn/docs/writing-content/components/tables#sticky-tables) | Coming soon |
| [Tabs](/learn/docs/content/components/tabs) | Supported |
| [Tooltips](/learn/docs/content/components/tooltips) | Coming soon |
| [Tabs](/learn/docs/writing-content/components/tabs) | Supported |
| [Tooltips](/learn/docs/writing-content/components/tooltips) | Coming soon |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'soon' that become outdated


</StickyTable>

Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,4 @@ navigation:

## 端点请求和响应代码片段

正在寻找有关生成 API 端点请求和响应代码片段的信息?请查看我们关于[端点请求代码片段](/learn/docs/content/components/request-snippet)和[端点响应代码片段](/learn/docs/content/components/response-snippet)的文档。
正在寻找有关生成 API 端点请求和响应代码片段的信息?请查看我们关于[端点请求代码片段](/learn/docs/writing-content/components/request-snippet)和[端点响应代码片段](/learn/docs/writing-content/components/response-snippet)的文档。
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ Fern 提供两种捕获损坏链接的方法。[`broken-links` 规则](/learn/do

## Fern 组件

Fern 有一个内置的组件库,你可以在 Markdown 中使用。[探索这些组件。](/learn/docs/content/components/overview)
Fern 有一个内置的组件库,你可以在 Markdown 中使用。[探索这些组件。](/learn/docs/writing-content/components/overview)
Original file line number Diff line number Diff line change
Expand Up @@ -81,25 +81,25 @@ Fern Editor 支持创建和编辑以下组件:

| 组件 | 支持状态 |
| --- | --- |
| [手风琴](/learn/docs/content/components/accordions) | 已支持 |
| [手风琴组](/learn/docs/content/components/accordion-groups) | 已支持 |
| [侧边栏](/learn/docs/content/components/aside) | 即将推出 |
| [按钮](/learn/docs/content/components/button) | 已支持 |
| [标注](/learn/docs/content/components/callouts) | 已支持 |
| [手风琴](/learn/docs/writing-content/components/accordions) | 已支持 |
| [手风琴组](/learn/docs/writing-content/components/accordion-groups) | 已支持 |
| [侧边栏](/learn/docs/writing-content/components/aside) | 即将推出 |
| [按钮](/learn/docs/writing-content/components/button) | 已支持 |
| [标注](/learn/docs/writing-content/components/callouts) | 已支持 |
| [卡片](/learn/docs/writing-content/components/cards) | 已支持 |
| [卡片组](/learn/docs/content/components/card-groups) | 已支持 |
| [代码块](/learn/docs/content/components/code-blocks) | 已支持 |
| [嵌入](/learn/docs/content/components/embed) | 已支持 |
| [端点请求片段](/learn/docs/content/components/request-snippet) | 已支持 |
| [端点响应片段](/learn/docs/content/components/response-snippet) | 已支持 |
| [卡片组](/learn/docs/writing-content/components/card-groups) | 已支持 |
| [代码块](/learn/docs/writing-content/components/code-blocks) | 已支持 |
| [嵌入](/learn/docs/writing-content/components/embed) | 已支持 |
| [端点请求片段](/learn/docs/writing-content/components/request-snippet) | 已支持 |
| [端点响应片段](/learn/docs/writing-content/components/response-snippet) | 已支持 |
| [端点模式片段](/learn/docs/writing-content/components/endpoint-schema-snippet) | 已支持 |
| [框架](/learn/docs/content/components/frames) | 即将推出 |
| [图标](/learn/docs/content/components/icons) | 即将推出 |
| [参数字段](/learn/docs/content/components/parameter-fields) | 已支持 |
| [步骤](/learn/docs/content/components/steps) | 已支持 |
| [框架](/learn/docs/writing-content/components/frames) | 即将推出 |
| [图标](/learn/docs/writing-content/components/icons) | 即将推出 |
| [参数字段](/learn/docs/writing-content/components/parameter-fields) | 已支持 |
| [步骤](/learn/docs/writing-content/components/steps) | 已支持 |
| [表格](/learn/docs/writing-content/components/tables) | 已支持 |
| [固定表格](/learn/docs/writing-content/components/tables#sticky-tables) | 即将推出 |
| [标签页](/learn/docs/content/components/tabs) | 已支持 |
| [工具提示](/learn/docs/content/components/tooltips) | 即将推出 |
| [标签页](/learn/docs/writing-content/components/tabs) | 已支持 |
| [工具提示](/learn/docs/writing-content/components/tooltips) | 即将推出 |

</StickyTable>
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ navigation:

## 编写变更日志条目

通过编写 Markdown 文件创建新的变更日志条目。您可以使用 `.md` 或 `.mdx` 文件。使用 `.mdx` 的好处是您可以在条目中利用 Fern 内置的[组件库](/learn/docs/content/components/overview)。
通过编写 Markdown 文件创建新的变更日志条目。您可以使用 `.md` 或 `.mdx` 文件。使用 `.mdx` 的好处是您可以在条目中利用 Fern 内置的[组件库](/learn/docs/writing-content/components/overview)。

<Markdown src="/products/docs/snippets/changelog-example.mdx" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ seed.yml 中的 CI 验证脚本将在未来强制执行此规则。
生成的 WebSocket Options 类上的新 `EnableCompression` 选项通过 `ClientWebSocketOptions.DangerousDeflateOptions`
启用 `WebSocketDeflateOptions`。这可以显著减少文本重(JSON)WebSocket API 的带宽。
警告:在发送包含机密的数据时不要使用压缩(CRIME/BREACH 漏洞)。
详细信息请参见 https://learn.microsoft.com/dotnet/api/system.net.websockets.clientwebsocketoptions.dangerousdeflateoptions
详细信息请参见 <https://learn.microsoft.com/dotnet/api/system.net.websockets.clientwebsocketoptions.dangerousdeflateoptions>


## 2.42.0
Expand Down
Loading