Skip to content

Commit 6867708

Browse files
committed
small formatting edits to config pages
1 parent 655a80f commit 6867708

File tree

9 files changed

+21
-26
lines changed

9 files changed

+21
-26
lines changed

fern/products/sdks/overview/csharp/configuration.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: .NET Configuration
2+
title: .NET configuration
33
description: Configuration options for the Fern .NET SDK.
44
---
55

@@ -15,8 +15,6 @@ groups:
1515
client_class_name: YourApiClient
1616
```
1717
18-
## SDK configuration options
19-
2018
<ParamField path="additional-properties" type="boolean" required={false} toc={true}>
2119
When enabled, allows handling of additional properties not explicitly defined in the API specification. This provides flexibility for APIs that may include extra fields in responses.
2220
</ParamField>

fern/products/sdks/overview/go/configuration.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Go Configuration
2+
title: Go configuration
33
description: Configuration options for the Fern Go SDK.
44
---
55

@@ -18,8 +18,6 @@ groups:
1818
path: ../generated/go
1919
```
2020
21-
## SDK Configuration Options
22-
2321
<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false} toc={true}>
2422
When enabled, ensures that all required properties are always included in API requests, even if they have default values or are otherwise optional in the implementation.
2523
</ParamField>

fern/products/sdks/overview/java/configuration.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Java Configuration
2+
title: Java configuration
33
description: Configuration options for the Fern Java SDK.
44
---
55
You can customize the behavior of the Java SDK generator in `generators.yml`:
@@ -14,8 +14,6 @@ groups:
1414
client-class-name: YourApiClient
1515
```
1616
17-
## SDK Configuration Options
18-
1917
<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
2018
Customizes the name of the base API exception class that all API-specific exceptions will extend. This allows you to define a custom base exception class name for better integration with your existing error handling patterns.
2119
</ParamField>

fern/products/sdks/overview/php/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: PHP Configuration
2+
title: PHP configuration
33
description: Configuration options for the Fern PHP SDK.
44
---
55

fern/products/sdks/overview/python/configuration.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Python Configuration
2+
title: Python configuration
33
description: Configuration options for the Fern Python SDK.
44
---
55

@@ -23,8 +23,6 @@ groups:
2323
skip_validation: true
2424
```
2525
26-
## SDK Configuration Options
27-
2826
<ParamField path="additional_init_exports" type="array of objects" default="null" required={false} toc={true}>
2927
Additional modules or classes to export from the package's `__init__.py` file. This allows you to customize what's available when users import your package.
3028

fern/products/sdks/overview/ruby/configuration.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Ruby Configuration
2+
title: Ruby configuration
33
description: Configuration options for the Fern Ruby SDK.
44
---
55

@@ -15,8 +15,6 @@ groups:
1515
clientClassName: YourClientName
1616
```
1717
18-
## SDK Configuration Options
19-
2018
<ParamField path="clientClassName" type="string" required={false} toc={true}>
2119
The name of the generated client class. This allows you to customize the class name that users will instantiate when using your SDK.
2220
</ParamField>

fern/products/sdks/overview/swift/configuration.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ groups:
1818
enableWireTests: false
1919
```
2020
21-
## SDK Configuration Options
22-
2321
<ParamField path="clientClassName" type="string" required={false} toc={true}>
2422
The name of the generated client class. This allows you to customize the class name that users will instantiate when using your SDK.
2523
</ParamField>

fern/products/sdks/overview/typescript/configuration.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: TypeScript Configuration
2+
title: TypeScript configuration
33
description: Configuration options for the Fern TypeScript SDK.
44
---
55

@@ -16,8 +16,6 @@ groups:
1616
noSerdeLayer: false
1717
```
1818
19-
## SDK configuration options
20-
2119
<ParamField path="allowExtraFields" type="boolean" toc={true}>
2220
Allow fields that are not defined in object schemas. This only applies to serde.
2321

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Organizes user-defined sets of generators, typically grouped by environment (lik
347347

348348
```yaml title="generators.yml" maxLines=10
349349
groups:
350-
company-typescript: # User-defined name
350+
typescript-sdk: # User-defined name
351351
audiences: ["external"]
352352
generators:
353353
- name: fernapi/fern-typescript-node-sdk
@@ -385,7 +385,7 @@ Generator settings for a specific group.
385385

386386
```yaml title="generators.yml"
387387
groups:
388-
company-typescript: # User-defined name
388+
typescript-sdk: # User-defined name
389389
audiences: ["external"]
390390
generators:
391391
- name: fernapi/fern-typescript-node-sdk
@@ -404,6 +404,17 @@ Specific version of the generator to use
404404

405405
Language-specific configuration options.
406406

407+
```yaml title="generators.yml"
408+
groups:
409+
ts-sdk: # Typescript SDK group
410+
generators:
411+
- name: fernapi/fern-typescript-sdk
412+
version: <Markdown src="/snippets/version-number-ts.mdx"/>
413+
config: # TypeScript-specific config options
414+
namespaceExport: AcmePayments
415+
noSerdeLayer: false
416+
```
417+
407418
<CardGroup cols={3}>
408419
<Card title="TypeScript" href="/sdks/generators/typescript/configuration">
409420
</Card>
@@ -421,8 +432,6 @@ Language-specific configuration options.
421432
</Card>
422433
<Card title="Swift" href="/sdks/generators/swift/configuration">
423434
</Card>
424-
<Card title="Postman" href="/sdks/generators/postman/configuration">
425-
</Card>
426435
</CardGroup>
427436

428437

@@ -432,7 +441,7 @@ Where to publish the generated SDK.
432441

433442
```yaml title="generators.yml"
434443
groups:
435-
company-typescript: # User-defined name
444+
typescript-sdk: # User-defined name
436445
audiences: ["external"]
437446
generators:
438447
- name: fernapi/fern-typescript-node-sdk

0 commit comments

Comments
 (0)