Skip to content

Commit ea38e91

Browse files
authored
Add OpenAPI authentication extensions to extension overview page (API Definitions) (#715)
1 parent eb48f8f commit ea38e91

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

fern/products/api-def/openapi-pages/auth.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ components:
164164
prefix: "Token " # Optional
165165
```
166166

167+
<Info>
168+
The `prefix` option lets you automatically add a prefix to API keys. This is useful when your API expects tokens in a specific format like `"Bearer abc123"` or `"Token abc123"`.
169+
</Info>
170+
167171
The generated SDK would look like:
168172

169173
```ts index.ts

fern/products/api-def/openapi-pages/extensions/overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ The table below shows all available extensions and links to detailed documentati
1414
| --- | --- |
1515
| [`x-fern-version`](./api-version) | Configure API version schemes and headers |
1616
| [`x-fern-audiences`](./audiences) | Filter endpoints, schemas, and properties by audience |
17+
| [`x-fern-basic`](/api-definitions/openapi/authentication#basic-security-scheme) | Customize basic authentication parameter names and environment variables |
18+
| [`x-fern-bearer`](/api-definitions/openapi/authentication#bearer-security-scheme) | Customize bearer authentication parameter names and environment variables |
1719
| [`x-fern-availability`](./availability) | Mark availability status (beta, generally-available, deprecated) |
1820
| [`x-fern-base-path`](./base-path) | Set base path prepended to all endpoints |
1921
| [`x-fern-enum`](./enum-descriptions-and-names) | Add descriptions and custom names to enum values |
2022
| [`x-fern-examples`](./request-response-examples) | Associate request and response examples |
2123
| [`x-fern-global-headers`](./global-headers) | Configure headers used across all endpoints |
24+
| [`x-fern-header`](/api-definitions/openapi/authentication#apikey-security-scheme) | Customize API key header authentication parameter names and environment variables |
2225
| [`x-fern-ignore`](./ignoring-elements) | Skip reading specific endpoints or schemas |
2326
| [`x-fern-sdk-method-name`](./method-names) | Customize SDK method names |
2427
| [`x-fern-sdk-group-name`](./method-names) | Organize methods into SDK groups |

0 commit comments

Comments
 (0)