Skip to content

Commit f90b594

Browse files
committed
Update configuration.mdx based on issue #266
1 parent b5108e5 commit f90b594

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

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

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@ groups:
2121
## SDK Configuration Options
2222
2323
<ParamField path="additional_init_exports" type="array" default="null" required={false} toc={true}>
24+
A list of additional exports to include in the package's __init__.py file.
2425
</ParamField>
2526
2627
<ParamField path="default_bytes_stream_chunk_size" type="number" default="null" required={false} toc={true}>
2728
The chunk size to use (if any) when processing a response bytes stream within `iter_bytes` or `aiter_bytes` results in: `for chunk in response.iter_bytes(chunk_size=<default_bytes_stream_chunk_size>):`
2829
</ParamField>
2930

3031
<ParamField path="exclude_types_from_init_exports" type="bool" default="false" required={false} toc={true}>
32+
When true, types will not be exported in the package's __init__.py file.
3133
</ParamField>
3234

3335
<ParamField path="extra_dependencies" type="object" default="{}" required={false} toc={true}>
@@ -40,44 +42,45 @@ groups:
4042
</ParamField>
4143

4244
<ParamField path="extra_dev_dependencies" type="object" default="{}" required={false} toc={true}>
45+
Additional development dependencies to include in the generated SDK.
4346
</ParamField>
4447

4548
<ParamField path="extras" type="object" default="{}" required={false} toc={true}>
49+
Optional dependencies that can be installed with the package.
4650
</ParamField>
4751

4852
<ParamField path="flat_layout" type="bool" default="false" required={false} toc={true}>
53+
When true, generates a flatter file structure without nested directories.
4954
</ParamField>
5055

5156
<ParamField path="follow_redirects_by_default" type="bool" default="true" required={false} toc={true}>
5257
Whether to follow redirects by default in HTTP requests.
5358
</ParamField>
5459

5560
<ParamField path="improved_imports" type="bool" default="true" required={false} toc={true}>
56-
Feature flag that improves imports in the Python SDK by removing nested `resources` directory
61+
Feature flag that improves imports in the Python SDK by removing nested `resources` directory.
5762
</ParamField>
5863

5964
<ParamField path="include_legacy_wire_tests" type="bool" default="false" required={false} toc={true}>
60-
Whether or not to include legacy wire tests in the generated SDK
65+
Whether or not to include legacy wire tests in the generated SDK.
6166
</ParamField>
6267

6368
<ParamField path="include_union_utils" type="bool" default="false" required={false} toc={true}>
69+
When true, generates utility functions for union types.
6470
</ParamField>
6571

6672
<ParamField path="inline_path_params" type="bool" default="false" required={false} toc={true}>
67-
If true, treats path parameters as named parameters in endpoint functions.
73+
If true, treats path parameters as named parameters in endpoint functions. This allows for automatic parameter injection like project_id when using x-fern-sdk-variables in your OpenAPI spec.
6874
</ParamField>
6975

7076
<ParamField path="inline_request_params" type="bool" default="true" required={false} toc={true}>
7177
Feature flag that removes the usage of request objects, and instead uses parameters in function signatures where possible.
7278
</ParamField>
7379

7480
<ParamField path="package_name" type="string" default="null" required={false} toc={true}>
75-
76-
Specifies the Python package name that users will import your generated client
77-
from.
81+
Specifies the Python package name that users will import your generated client from.
7882

79-
For example, setting `package_name: "my_custom_package"` enables users to use
80-
`my_custom_package import Client` to import your client:
83+
For example, setting `package_name: "my_custom_package"` enables users to use `from my_custom_package import Client` to import your client:
8184

8285
```yaml {7-10}
8386
default-group: local
@@ -92,6 +95,7 @@ groups:
9295
</ParamField>
9396

9497
<ParamField path="pydantic_config" type="SdkPydanticModelCustomConfig" default="SdkPydanticModelCustomConfig()" required={false} toc={true}>
98+
Configuration options for Pydantic model generation.
9599
</ParamField>
96100

97101
<ParamField path="pydantic_config.include_union_utils" type="bool" default="false" required={false} toc={true}>
@@ -123,7 +127,7 @@ groups:
123127
<ParamField path="pydantic_config.version" type="'v1' | 'v2' | 'both' | 'v1_on_v2'" default="both" required={false} toc={true}>
124128
By default, the generator generates pydantic models that are v1 and v2 compatible. However you can override them to:
125129
- `v1`: strictly use Pydantic v1
126-
- `v2`: strictly use Pydantic v2
130+
- `v2`: strictly use Pydantic v2
127131
- `both`: maintain compatibility with both versions
128132
- `v1_on_v2`: use Pydantic v1 compatibility layer on v2
129133

@@ -140,20 +144,23 @@ groups:
140144
</ParamField>
141145
142146
<ParamField path="pyproject_toml" type="string" default="null" required={false} toc={true}>
147+
Custom pyproject.toml content to include in the generated package.
143148
</ParamField>
144149
145150
<ParamField path="should_generate_websocket_clients" type="bool" default="false" required={false} toc={true}>
146151
Feature flag that enables generation of Python websocket clients.
147152
</ParamField>
148153
149154
<ParamField path="skip_formatting" type="bool" default="false" required={false} toc={true}>
155+
When true, skips code formatting of the generated SDK.
150156
</ParamField>
151157
152158
<ParamField path="timeout_in_seconds" type="number | 'infinity'" default="60" required={false} toc={true}>
153159
By default, the generator generates a client that times out after 60 seconds. You can customize this value by providing a different number or setting to `infinity` to get rid of timeouts.
154160
</ParamField>
155161

156162
<ParamField path="use_api_name_in_package" type="bool" default="false" required={false} toc={true}>
163+
When true, includes the API name in the generated package name.
157164
</ParamField>
158165

159166
<ParamField path="use_inheritance_for_extended_models" type="bool" default="true" required={false} toc={true}>

0 commit comments

Comments
 (0)