Skip to content

Commit 4a04e39

Browse files
committed
docs: add hide-descriptions and hide-navigation-buttons search properties
1 parent e8cf5f6 commit 4a04e39

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

docs/customization/data-sources/openapi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
sidebar_position: 5
3-
title: OpenAPI specifications
4-
description: Add OpenAPI/Swagger specifications for optimized API documentation
3+
title: OpenAPI
4+
description: Add OpenAPI/Swagger documents for optimized API documentation
55
---
66

7-
# OpenAPI specifications
7+
# OpenAPI documents
88

9-
Add OpenAPI specification files to include API documentation in your project.
9+
Add OpenAPI document files to include API documentation in your project.
1010

1111
:::tip
1212
File content remains private. Your chatbot won't expose file links as sources to users.
1313
:::
1414

15-
## Why use OpenAPI specifications
15+
## Why use OpenAPI documents
1616

17-
OpenAPI specifications provide structured data that's processed more accurately than crawling documentation websites:
17+
OpenAPI documents provide structured data that's processed more accurately than crawling documentation websites:
1818

1919
- **Complete API coverage**: All endpoints, parameters, and schemas included automatically
2020
- **Structured format**: YAML/JSON format enables precise parsing of API details
@@ -27,12 +27,12 @@ OpenAPI specifications provide structured data that's processed more accurately
2727
- JSON (`.json`) or YAML (`.yaml`, `.yml`) format
2828
- Publicly accessible URL
2929

30-
## Add OpenAPI specifications
30+
## Add OpenAPI documents
3131

3232
1. Go to [app.biel.ai](https://app.biel.ai)
3333
2. Select **Projects** > your project > **Settings** > **Sources**
3434
3. Select **OpenAPI**
35-
4. Enter the specification URL
35+
4. Enter the document URL
3636
5. Click **Add OpenAPI URL**
3737

3838
Example URLs:
@@ -44,7 +44,7 @@ https://api.example.com/v1/openapi.yml
4444

4545
## Troubleshooting
4646

47-
**Specification not loading**
47+
**Document not loading**
4848
- Check URL accessibility
4949
- Verify valid OpenAPI syntax
5050

docs/customization/layout.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,9 @@ The table below lists all the available properties that modify the search modal:
109109
|------------------------|-----------------------------------------------------------------------------------------------|
110110
| **Layout** | | |
111111
| `hide-ask-ai-button` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, the "Ask AI" button is hidden from the search results. |
112+
| `hide-descriptions` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, hides descriptions in search results for a cleaner interface.|
112113
| `hide-filters` | **Type**: `boolean`<br />**Default value**: `true`<br /><br />When set to `true`, removes the source filter dropdown from the search modal, simplifying the search interface. |
114+
| `hide-navigation-buttons` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, hides navigation buttons (up and down arrows, enter, escape) in the search modal for a simplified interface. |
113115
| `modal-position` | **Type**: `string`<br />**Default value**: `top-center`<br />**Available values:** `center`, `top-center`, `top-right`, `bottom-left`<br /><br />Position of the modal.|
114116
| `stacked` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, displays search results in a stacked layout.|
115117
| `clean-titles` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, removes site names from page titles that follow the format "Page Title | Site Name" for cleaner presentation.|

0 commit comments

Comments
 (0)