You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/docs/pages/api-references/customize-api-ref.mdx
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -176,7 +176,7 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
176
176
</Tabs>
177
177
178
178
### Adding custom sections
179
-
You can add arbitrary folders in the sidebar by adding a `section` to your API Reference layout. A section can comprise entire groups of endpoints, individual endpoints, or even just Markdown pages. Sections can be customized by adding properties like a `icon`, `summary`, `slug` (or `skip-slug`), and `contents`.
179
+
You can add arbitrary folders in the sidebar by adding a `section` to your API Reference layout. A section can comprise entire groups of endpoints, individual endpoints, or even just Markdown pages. Sections can be customized by adding properties like a `icon`, `summary`, `slug` (or `skip-slug`), `availability`, and `contents`.
180
180
181
181
<Tabs>
182
182
<Tab title="OpenAPI Specification">
@@ -243,18 +243,20 @@ navigation:
243
243
244
244
### Adding availability
245
245
246
-
You can set the availability for the entire API reference or for specific sections.
246
+
You can set the availability for the entire API reference or for specific sections. Options are: `stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, or `beta`.
247
247
248
-
```yaml title="docs.yml" {5}
248
+
249
+
```yaml title="docs.yml" {3, 6}
249
250
navigation:
250
251
- api: API Reference
252
+
availability: generally-available
251
253
layout:
252
-
- user:
253
-
availability: generally-available
254
-
- POST /user
255
-
- PUT /user/{username}
256
-
- DELETE /user/{username}
257
-
```
258
-
When you set availability for an API Reference section, all child endpoints will inherit that availability unless explicitly overridden in your API definition.
254
+
- section: My Section
255
+
availability: beta
256
+
icon: flower
257
+
contents:
258
+
```
259
+
260
+
When you set availability for a section, all endpoints in that section will inherit the section-level availability unless explicitly overridden in your API definition.
259
261
260
262
<Warning>You can't set availability for individual endpoints in `docs.yml`. Endpoint availability must be configured directly in your API definition. Learn more about availability for [OpenAPI](/learn/api-definitions/openapi/extensions/availability) or [Fern Definition](/learn/api-definitions/ferndef/availability).</Warning>
Copy file name to clipboardExpand all lines: fern/products/docs/pages/navigation/versions.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,7 +121,7 @@ versions:
121
121
```
122
122
</CodeBlock>
123
123
124
-
Version availability is distinct from [section and page availability](/learn/docs/configuration/navigation#section-and-page-availability). If you want to set section and page availability, do so in your version-specific `yml` files.
124
+
Version availability is distinct from [section and page availability](/learn/docs/configuration/navigation#section-and-page-availability), with different options. If you want to set section and page availability, do so in your version-specific `yml` files.
125
125
126
126
</Step>
127
127
<Step title="Remove extra navigation from docs.yml">
0 commit comments