Skip to content

Commit 730e63f

Browse files
devalogdevalog
authored
Make all ParamFields linkable (#142)
1 parent b0a2cd3 commit 730e63f

File tree

6 files changed

+88
-88
lines changed

6 files changed

+88
-88
lines changed

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

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,59 +18,59 @@ groups:
1818
1919
## SDK configuration options
2020
21-
<ParamField path="namespace" type="string" required={false}>
21+
<ParamField path="namespace" type="string" required={false} toc={true}>
2222
</ParamField>
2323
24-
<ParamField path="base-api-exception-class-name" type="string" required={false}>
24+
<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
2525
</ParamField>
2626
27-
<ParamField path="base-exception-class-name" type="string" required={false}>
27+
<ParamField path="base-exception-class-name" type="string" required={false} toc={true}>
2828
</ParamField>
2929
30-
<ParamField path="client-class-name" type="string" required={false}>
30+
<ParamField path="client-class-name" type="string" required={false} toc={true}>
3131
</ParamField>
3232
33-
<ParamField path="environment-class-name" type="string" required={false}>
33+
<ParamField path="environment-class-name" type="string" required={false} toc={true}>
3434
</ParamField>
3535
36-
<ParamField path="exported-client-class-name" type="string" required={false}>
36+
<ParamField path="exported-client-class-name" type="string" required={false} toc={true}>
3737
</ParamField>
3838
39-
<ParamField path="explicit-namespaces" type="boolean" required={false}>
39+
<ParamField path="explicit-namespaces" type="boolean" required={false} toc={true}>
4040
</ParamField>
4141
42-
<ParamField path="inline-path-parameters" type="boolean" required={false}>
42+
<ParamField path="inline-path-parameters" type="boolean" required={false} toc={true}>
4343
</ParamField>
4444
45-
<ParamField path="read-only-memory-types" type="List<string>" required={false}>
45+
<ParamField path="read-only-memory-types" type="List<string>" required={false} toc={true}>
4646
</ParamField>
4747
48-
<ParamField path="root-namespace-for-core-classes" type="boolean" required={false}>
48+
<ParamField path="root-namespace-for-core-classes" type="boolean" required={false} toc={true}>
4949
</ParamField>
5050
51-
<ParamField path="use-discriminated-unions" type="boolean" required={false}>
51+
<ParamField path="use-discriminated-unions" type="boolean" required={false} toc={true}>
5252
</ParamField>
5353
54-
<ParamField path="root-client-class-access" type="'public' | 'internal'" required={false}>
54+
<ParamField path="root-client-class-access" type="'public' | 'internal'" required={false} toc={true}>
5555
</ParamField>
5656
57-
<ParamField path="custom-pager-name" type="string" required={false}>
57+
<ParamField path="custom-pager-name" type="string" required={false} toc={true}>
5858
</ParamField>
5959
60-
<ParamField path="enable-forward-compatible-enums" type="boolean" required={false}>
60+
<ParamField path="enable-forward-compatible-enums" type="boolean" required={false} toc={true}>
6161
</ParamField>
6262
63-
<ParamField path="additional-properties" type="boolean" required={false}>
63+
<ParamField path="additional-properties" type="boolean" required={false} toc={true}>
6464
</ParamField>
6565
66-
<ParamField path="generate-error-types" type="boolean" required={false}>
66+
<ParamField path="generate-error-types" type="boolean" required={false} toc={true}>
6767
</ParamField>
6868
69-
<ParamField path="package-id" type="string" required={false}>
69+
<ParamField path="package-id" type="string" required={false} toc={true}>
7070
</ParamField>
7171
72-
<ParamField path="generate-mock-server-tests" type="boolean" required={false}>
72+
<ParamField path="generate-mock-server-tests" type="boolean" required={false} toc={true}>
7373
</ParamField>
7474
75-
<ParamField path="include-exception-handler" type="boolean" required={false}>
75+
<ParamField path="include-exception-handler" type="boolean" required={false} toc={true}>
7676
</ParamField>

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ groups:
2121
2222
## SDK Configuration Options
2323
24-
<ParamField path="module" type="ModuleConfigSchema" required={false}>
24+
<ParamField path="module" type="ModuleConfigSchema" required={false} toc={true}>
2525
Use this option if you plan to distribute the generated Go SDK as a separate, published Go module.
2626
2727
<Note>If you only plan to use the generated SDK within your own Go module, use the `importPath` configuration option instead.</Note>
@@ -79,10 +79,10 @@ replace "github.com/your/sdk" v0.0.0 => "path/to/generated/sdk"
7979

8080
</ParamField>
8181

82-
<ParamField path="packageName" type="string" required={false}>
82+
<ParamField path="packageName" type="string" required={false} toc={true}>
8383
</ParamField>
8484

85-
<ParamField path="importPath" type="string" required={false}>
85+
<ParamField path="importPath" type="string" required={false} toc={true}>
8686
Use this option if you plan to depend on the generated Go SDK from within your project, and **not** depend on it as a separate, published Go module.
8787

8888
<Note>If you plan to to distribute the generated Go SDK as a separate, published Go module, use the `module` configuration option instead.</Note>
@@ -108,32 +108,32 @@ with the relevant elements in your `go.mod` path. In this case, the generated Go
108108

109109
</ParamField>
110110

111-
<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false}>
111+
<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false} toc={true}>
112112
</ParamField>
113113

114-
<ParamField path="clientConstructorName" type="string" required={false}>
114+
<ParamField path="clientConstructorName" type="string" required={false} toc={true}>
115115
</ParamField>
116116

117-
<ParamField path="clientName" type="string" required={false}>
117+
<ParamField path="clientName" type="string" required={false} toc={true}>
118118
</ParamField>
119119

120-
<ParamField path="exportedClientName" type="string" required={false}>
120+
<ParamField path="exportedClientName" type="string" required={false} toc={true}>
121121
</ParamField>
122122

123-
<ParamField path="includeLegacyClientOptions" type="boolean" required={false}>
123+
<ParamField path="includeLegacyClientOptions" type="boolean" required={false} toc={true}>
124124
</ParamField>
125125

126-
<ParamField path="inlinePathParameters" type="boolean" required={false}>
126+
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
127127
</ParamField>
128128

129-
<ParamField path="inlineFileProperties" type="boolean" required={false}>
129+
<ParamField path="inlineFileProperties" type="boolean" required={false} toc={true}>
130130
</ParamField>
131131

132-
<ParamField path="packageLayout" type="'flat' | 'nested'" required={false}>
132+
<ParamField path="packageLayout" type="'flat' | 'nested'" required={false} toc={true}>
133133
</ParamField>
134134

135-
<ParamField path="union" type="'v0' | 'v1'" required={false}>
135+
<ParamField path="union" type="'v0' | 'v1'" required={false} toc={true}>
136136
</ParamField>
137137

138-
<ParamField path="useReaderForBytesRequest" type="boolean" required={false}>
138+
<ParamField path="useReaderForBytesRequest" type="boolean" required={false} toc={true}>
139139
</ParamField>

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ groups:
1717
1818
## SDK Configuration Options
1919
20-
<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false}>
20+
<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false} toc={true}>
2121
2222
The provided string will be used as the client class name.
2323
</ParamField>
2424
25-
<ParamField path="base-api-exception-class-name" type="string" required={false}>
25+
<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
2626
</ParamField>
2727
28-
<ParamField path="base-exception-class-name" type="string" required={false}>
28+
<ParamField path="base-exception-class-name" type="string" required={false} toc={true}>
2929
</ParamField>
3030
31-
<ParamField path="custom-dependencies" type="List<string>" required={false}>
31+
<ParamField path="custom-dependencies" type="List<string>" required={false} toc={true}>
3232
3333
Example:
3434
@@ -41,44 +41,44 @@ Example:
4141
4242
</ParamField>
4343
44-
<ParamField path="publish-to" type="'central' | 'ossrh'" required={false}>
44+
<ParamField path="publish-to" type="'central' | 'ossrh'" required={false} toc={true}>
4545
</ParamField>
4646
47-
<ParamField path="inline-file-properties" type="boolean" default="false" required={false}>
47+
<ParamField path="inline-file-properties" type="boolean" default="false" required={false} toc={true}>
4848
</ParamField>
4949
50-
<ParamField path="wrapped-aliases" type="boolean" default="false" required={false}>
50+
<ParamField path="wrapped-aliases" type="boolean" default="false" required={false} toc={true}>
5151
When enabled, generates wrapper types for each alias to increase type-safety.
5252
For example, if you have an alias `ResourceId: string` then if this is true, the
5353
generator will generate a `ResourceId.java` file. If false, it will just treat it
5454
as `java.util.String`.
5555
</ParamField>
5656

57-
<ParamField path="enable-forward-compatible-enums" type="boolean" default="false" required={false}>
57+
<ParamField path="enable-forward-compatible-enums" type="boolean" default="false" required={false} toc={true}>
5858
</ParamField>
5959

60-
<ParamField path="generate-unknown-as-json-node" type="boolean" default="false" required={false}>
60+
<ParamField path="generate-unknown-as-json-node" type="boolean" default="false" required={false} toc={true}>
6161
</ParamField>
6262

63-
<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false}>
63+
<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false} toc={true}>
6464
</ParamField>
6565

66-
<ParamField path="enable-public-constructors" type="boolean" default="false" required={false}>
66+
<ParamField path="enable-public-constructors" type="boolean" default="false" required={false} toc={true}>
6767

6868
When enabled, generates public constructors for model types.
6969
</ParamField>
7070

71-
<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false}>
71+
<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false} toc={true}>
7272
</ParamField>
7373

74-
<ParamField path="inline-path-parameters" type="boolean" default="false" required={false}>
74+
<ParamField path="inline-path-parameters" type="boolean" default="false" required={false} toc={true}>
7575
</ParamField>
7676

77-
<ParamField path="enable-inline-types" type="boolean" default="false" required={false}>
77+
<ParamField path="enable-inline-types" type="boolean" default="false" required={false} toc={true}>
7878
</ParamField>
7979

80-
<ParamField path="package-prefix" type="string" required={false}>
80+
<ParamField path="package-prefix" type="string" required={false} toc={true}>
8181
</ParamField>
8282

83-
<ParamField path="package-layout" type="'nested' | 'flat'" default="nested" required={false}>
83+
<ParamField path="package-layout" type="'nested' | 'flat'" default="nested" required={false} toc={true}>
8484
</ParamField>

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@ groups:
1818
1919
## SDK Configuration Options
2020
21-
<ParamField path="clientName" type="string" required={false}>
21+
<ParamField path="clientName" type="string" required={false} toc={true}>
2222
</ParamField>
2323
24-
<ParamField path="inlinePathParameters" type="boolean" required={false}>
24+
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
2525
</ParamField>
2626
27-
<ParamField path="packageName" type="string" required={false}>
27+
<ParamField path="packageName" type="string" required={false} toc={true}>
2828
</ParamField>
2929
30-
<ParamField path="packagePath" type="string" required={false}>
30+
<ParamField path="packagePath" type="string" required={false} toc={true}>
3131
</ParamField>
3232
33-
<ParamField path="propertyAccess" type="'public' | 'private'" required={false}>
33+
<ParamField path="propertyAccess" type="'public' | 'private'" required={false} toc={true}>
3434
</ParamField>
3535
36-
<ParamField path="namespace" type="string" required={false}>
36+
<ParamField path="namespace" type="string" required={false} toc={true}>
3737
</ParamField>
3838
39-
<ParamField path="composerJson" type="Record<string, any>" required={false}>
39+
<ParamField path="composerJson" type="Record<string, any>" required={false} toc={true}>
4040
</ParamField>
4141

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

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ groups:
1919
2020
## SDK Configuration Options
2121
22-
<ParamField path="extra_dependencies" type="object" default="{}" required={false}>
22+
<ParamField path="extra_dependencies" type="object" default="{}" required={false} toc={true}>
2323
If you want to add custom dependencies to your generated SDK, you can specify them using this configuration. For example, to add a dependency on boto3, your config would look like:
2424
```
2525
config:
@@ -28,38 +28,38 @@ groups:
2828
```
2929
</ParamField>
3030
31-
<ParamField path="extra_dev_dependencies" type="object" default="{}" required={false}>
31+
<ParamField path="extra_dev_dependencies" type="object" default="{}" required={false} toc={true}>
3232
</ParamField>
3333
34-
<ParamField path="extras" type="object" default="{}" required={false}>
34+
<ParamField path="extras" type="object" default="{}" required={false} toc={true}>
3535
</ParamField>
3636
37-
<ParamField path="skip_formatting" type="bool" default="false" required={false}>
37+
<ParamField path="skip_formatting" type="bool" default="false" required={false} toc={true}>
3838
</ParamField>
3939
40-
<ParamField path="client" type="ClientConfiguration" default="ClientConfiguration()" required={false}>
40+
<ParamField path="client" type="ClientConfiguration" default="ClientConfiguration()" required={false} toc={true}>
4141
</ParamField>
4242
43-
<ParamField path="include_union_utils" type="bool" default="false" required={false}>
43+
<ParamField path="include_union_utils" type="bool" default="false" required={false} toc={true}>
4444
</ParamField>
4545
46-
<ParamField path="use_api_name_in_package" type="bool" default="false" required={false}>
46+
<ParamField path="use_api_name_in_package" type="bool" default="false" required={false} toc={true}>
4747
</ParamField>
4848
49-
<ParamField path="package_name" type="string" default="null" required={false}>
49+
<ParamField path="package_name" type="string" default="null" required={false} toc={true}>
5050
</ParamField>
5151
52-
<ParamField path="timeout_in_seconds" type="number | 'infinity'" default="60" required={false}>
52+
<ParamField path="timeout_in_seconds" type="number | 'infinity'" default="60" required={false} toc={true}>
5353
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.
5454
</ParamField>
5555

56-
<ParamField path="flat_layout" type="bool" default="false" required={false}>
56+
<ParamField path="flat_layout" type="bool" default="false" required={false} toc={true}>
5757
</ParamField>
5858

59-
<ParamField path="pydantic_config" type="SdkPydanticModelCustomConfig" default="SdkPydanticModelCustomConfig()" required={false}>
59+
<ParamField path="pydantic_config" type="SdkPydanticModelCustomConfig" default="SdkPydanticModelCustomConfig()" required={false} toc={true}>
6060
</ParamField>
6161

62-
<ParamField path="pydantic_config.include_union_utils" type="bool" default="false" required={false}>
62+
<ParamField path="pydantic_config.include_union_utils" type="bool" default="false" required={false} toc={true}>
6363
When enabled, the generator will output a Pydantic `__root__` class that will contain utilities to visit the union. For example, for the following union type:
6464

6565
```
@@ -85,7 +85,7 @@ groups:
8585
When enabled, the python generator will not run Black formatting in the generated code. Black is slow so this can potentially speed up code generation quite a bit.
8686
</ParamField>
8787

88-
<ParamField path="pydantic_config.version" type="'v1' | 'v2' | 'both' | 'v1_on_v2'" default="both" required={false}>
88+
<ParamField path="pydantic_config.version" type="'v1' | 'v2' | 'both' | 'v1_on_v2'" default="both" required={false} toc={true}>
8989
By default, the generator generates pydantic models that are v1 and v2 compatible. However you can override them to:
9090
- `v1`: strictly use Pydantic v1
9191
- `v2`: strictly use Pydantic v2
@@ -100,55 +100,55 @@ groups:
100100
```
101101
</ParamField>
102102
103-
<ParamField path="additional_init_exports" type="array" default="null" required={false}>
103+
<ParamField path="additional_init_exports" type="array" default="null" required={false} toc={true}>
104104
</ParamField>
105105
106-
<ParamField path="exclude_types_from_init_exports" type="bool" default="false" required={false}>
106+
<ParamField path="exclude_types_from_init_exports" type="bool" default="false" required={false} toc={true}>
107107
</ParamField>
108108
109-
<ParamField path="improved_imports" type="bool" default="true" required={false}>
109+
<ParamField path="improved_imports" type="bool" default="true" required={false} toc={true}>
110110
Feature flag that improves imports in the Python SDK by removing nested `resources` directory
111111
</ParamField>
112112

113-
<ParamField path="follow_redirects_by_default" type="bool" default="true" required={false}>
113+
<ParamField path="follow_redirects_by_default" type="bool" default="true" required={false} toc={true}>
114114
Whether to follow redirects by default in HTTP requests.
115115
</ParamField>
116116

117-
<ParamField path="inline_request_params" type="bool" default="true" required={false}>
117+
<ParamField path="inline_request_params" type="bool" default="true" required={false} toc={true}>
118118
Feature flag that removes the usage of request objects, and instead uses parameters in function signatures where possible.
119119
</ParamField>
120120

121-
<ParamField path="inline_path_params" type="bool" default="false" required={false}>
121+
<ParamField path="inline_path_params" type="bool" default="false" required={false} toc={true}>
122122
If true, treats path parameters as named parameters in endpoint functions.
123123
</ParamField>
124124

125-
<ParamField path="should_generate_websocket_clients" type="bool" default="false" required={false}>
125+
<ParamField path="should_generate_websocket_clients" type="bool" default="false" required={false} toc={true}>
126126
Feature flag that enables generation of Python websocket clients.
127127
</ParamField>
128128

129-
<ParamField path="pyproject_python_version" type="string" default="^3.8" required={false}>
129+
<ParamField path="pyproject_python_version" type="string" default="^3.8" required={false} toc={true}>
130130
<Warning>This changes your declared python dependency, which is not meant to be done often if at all. This is a last resort if any dependencies force you to change your version requirements.</Warning>
131131
</ParamField>
132132

133-
<ParamField path="use_typeddict_requests" type="bool" default="false" required={false}>
133+
<ParamField path="use_typeddict_requests" type="bool" default="false" required={false} toc={true}>
134134
Whether or not to generate `TypedDicts` instead of Pydantic Models for request objects.
135135
</ParamField>
136136

137-
<ParamField path="use_typeddict_requests_for_file_upload" type="bool" default="false" required={false}>
137+
<ParamField path="use_typeddict_requests_for_file_upload" type="bool" default="false" required={false} toc={true}>
138138
Whether or not to generate TypedDicts instead of Pydantic Models for file upload request objects. Note that this flag was only introduced due to an oversight in the `use_typeddict_requests` flag implementation; it should be removed in the future.
139139
</ParamField>
140140

141-
<ParamField path="use_inheritance_for_extended_models" type="bool" default="true" required={false}>
141+
<ParamField path="use_inheritance_for_extended_models" type="bool" default="true" required={false} toc={true}>
142142
Whether to generate Pydantic models that implement inheritance when a model utilizes the Fern `extends` keyword.
143143
</ParamField>
144144

145-
<ParamField path="pyproject_toml" type="string" default="null" required={false}>
145+
<ParamField path="pyproject_toml" type="string" default="null" required={false} toc={true}>
146146
</ParamField>
147147

148-
<ParamField path="default_bytes_stream_chunk_size" type="number" default="null" required={false}>
148+
<ParamField path="default_bytes_stream_chunk_size" type="number" default="null" required={false} toc={true}>
149149
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>):`
150150
</ParamField>
151151

152-
<ParamField path="include_legacy_wire_tests" type="bool" default="false" required={false}>
152+
<ParamField path="include_legacy_wire_tests" type="bool" default="false" required={false} toc={true}>
153153
Whether or not to include legacy wire tests in the generated SDK
154154
</ParamField>

0 commit comments

Comments
 (0)