Skip to content

Commit 2a0fcd3

Browse files
devalogdevalog
authored
Alphabetize options for all Configuration pages (#159)
1 parent 9599761 commit 2a0fcd3

File tree

7 files changed

+317
-320
lines changed

7 files changed

+317
-320
lines changed

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

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

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

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,53 @@ groups:
2121
2222
## SDK Configuration Options
2323
24+
<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false} toc={true}>
25+
</ParamField>
26+
27+
<ParamField path="clientConstructorName" type="string" required={false} toc={true}>
28+
</ParamField>
29+
30+
<ParamField path="clientName" type="string" required={false} toc={true}>
31+
</ParamField>
32+
33+
<ParamField path="exportedClientName" type="string" required={false} toc={true}>
34+
</ParamField>
35+
36+
<ParamField path="importPath" type="string" required={false} toc={true}>
37+
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.
38+
39+
<Note>If you plan to to distribute the generated Go SDK as a separate, published Go module, use the `module` configuration option instead.</Note>
40+
41+
You can generate the Go SDK code into a `gen/go/api` package with the following `generators.yml`
42+
configuration:
43+
44+
```yaml {7-8}
45+
default-group: local
46+
groups:
47+
local:
48+
generators:
49+
- name: fernapi/fern-go-sdk
50+
version: 0.13.0
51+
config:
52+
importPath: github.com/<YOUR_ORGANIZATION>/<YOUR_REPOSITORY>/generated/go
53+
output:
54+
location: local-file-system
55+
path: ../generated/go
56+
```
57+
<Info>You must update the `<YOUR_ORGANIZATION>` and `<YOUR_REPOSITORY>` placeholders
58+
with the relevant elements in your `go.mod` path. In this case, the generated Go SDK uses the same `go.mod` path used by the rest of your Go module.</Info>
59+
60+
</ParamField>
61+
62+
<ParamField path="includeLegacyClientOptions" type="boolean" required={false} toc={true}>
63+
</ParamField>
64+
65+
<ParamField path="inlineFileProperties" type="boolean" required={false} toc={true}>
66+
</ParamField>
67+
68+
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
69+
</ParamField>
70+
2471
<ParamField path="module" type="ModuleConfigSchema" required={false} toc={true}>
2572
Use this option if you plan to distribute the generated Go SDK as a separate, published Go module.
2673

@@ -79,61 +126,14 @@ replace "github.com/your/sdk" v0.0.0 => "path/to/generated/sdk"
79126

80127
</ParamField>
81128

82-
<ParamField path="packageName" type="string" required={false} toc={true}>
83-
</ParamField>
84-
85-
<ParamField path="importPath" type="string" required={false} toc={true}>
86-
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.
87-
88-
<Note>If you plan to to distribute the generated Go SDK as a separate, published Go module, use the `module` configuration option instead.</Note>
89-
90-
You can generate the Go SDK code into a `gen/go/api` package with the following `generators.yml`
91-
configuration:
92-
93-
```yaml {7-8}
94-
default-group: local
95-
groups:
96-
local:
97-
generators:
98-
- name: fernapi/fern-go-sdk
99-
version: 0.13.0
100-
config:
101-
importPath: github.com/<YOUR_ORGANIZATION>/<YOUR_REPOSITORY>/generated/go
102-
output:
103-
location: local-file-system
104-
path: ../generated/go
105-
```
106-
<Info>You must update the `<YOUR_ORGANIZATION>` and `<YOUR_REPOSITORY>` placeholders
107-
with the relevant elements in your `go.mod` path. In this case, the generated Go SDK uses the same `go.mod` path used by the rest of your Go module.</Info>
108-
109-
</ParamField>
110-
111-
<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false} toc={true}>
112-
</ParamField>
113-
114-
<ParamField path="clientConstructorName" type="string" required={false} toc={true}>
115-
</ParamField>
116-
117-
<ParamField path="clientName" type="string" required={false} toc={true}>
118-
</ParamField>
119-
120-
<ParamField path="exportedClientName" type="string" required={false} toc={true}>
121-
</ParamField>
122-
123-
<ParamField path="includeLegacyClientOptions" type="boolean" required={false} toc={true}>
124-
</ParamField>
125-
126-
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
127-
</ParamField>
128-
129-
<ParamField path="inlineFileProperties" type="boolean" required={false} toc={true}>
129+
<ParamField path="packageLayout" type="'flat' | 'nested'" required={false} toc={true}>
130130
</ParamField>
131131

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

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

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

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

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ groups:
1717
1818
## SDK Configuration Options
1919
20-
<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false} toc={true}>
21-
22-
The provided string will be used as the client class name.
23-
</ParamField>
24-
2520
<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
2621
</ParamField>
2722
2823
<ParamField path="base-exception-class-name" type="string" required={false} toc={true}>
2924
</ParamField>
3025
26+
<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false} toc={true}>
27+
28+
The provided string will be used as the client class name.
29+
</ParamField>
30+
3131
<ParamField path="custom-dependencies" type="List<string>" required={false} toc={true}>
3232
3333
Example:
@@ -41,40 +41,33 @@ Example:
4141
4242
</ParamField>
4343
44-
<ParamField path="publish-to" type="'central' | 'ossrh'" required={false} toc={true}>
45-
</ParamField>
46-
47-
<ParamField path="inline-file-properties" type="boolean" default="false" required={false} toc={true}>
48-
</ParamField>
49-
50-
<ParamField path="wrapped-aliases" type="boolean" default="false" required={false} toc={true}>
51-
When enabled, generates wrapper types for each alias to increase type-safety.
52-
For example, if you have an alias `ResourceId: string` then if this is true, the
53-
generator will generate a `ResourceId.java` file. If false, it will just treat it
54-
as `java.util.String`.
44+
<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false} toc={true}>
5545
</ParamField>
5646
5747
<ParamField path="enable-forward-compatible-enums" type="boolean" default="false" required={false} toc={true}>
5848
</ParamField>
5949
60-
<ParamField path="generate-unknown-as-json-node" type="boolean" default="false" required={false} toc={true}>
61-
</ParamField>
62-
63-
<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false} toc={true}>
50+
<ParamField path="enable-inline-types" type="boolean" default="false" required={false} toc={true}>
6451
</ParamField>
6552
6653
<ParamField path="enable-public-constructors" type="boolean" default="false" required={false} toc={true}>
6754
6855
When enabled, generates public constructors for model types.
6956
</ParamField>
7057
71-
<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false} toc={true}>
58+
<ParamField path="generate-unknown-as-json-node" type="boolean" default="false" required={false} toc={true}>
59+
</ParamField>
60+
61+
<ParamField path="inline-file-properties" type="boolean" default="false" required={false} toc={true}>
7262
</ParamField>
7363
7464
<ParamField path="inline-path-parameters" type="boolean" default="false" required={false} toc={true}>
7565
</ParamField>
7666
77-
<ParamField path="enable-inline-types" type="boolean" default="false" required={false} toc={true}>
67+
<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false} toc={true}>
68+
</ParamField>
69+
70+
<ParamField path="package-layout" type="'nested' | 'flat'" default="nested" required={false} toc={true}>
7871
</ParamField>
7972
8073
<ParamField path="package-prefix" type="string" required={false} toc={true}>
@@ -86,5 +79,12 @@ config:
8679
```
8780
</ParamField>
8881
89-
<ParamField path="package-layout" type="'nested' | 'flat'" default="nested" required={false} toc={true}>
82+
<ParamField path="publish-to" type="'central' | 'ossrh'" required={false} toc={true}>
9083
</ParamField>
84+
85+
<ParamField path="wrapped-aliases" type="boolean" default="false" required={false} toc={true}>
86+
When enabled, generates wrapper types for each alias to increase type-safety.
87+
For example, if you have an alias `ResourceId: string` then if this is true, the
88+
generator will generate a `ResourceId.java` file. If false, it will just treat it
89+
as `java.util.String`.
90+
</ParamField>

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,20 @@ groups:
2121
<ParamField path="clientName" type="string" required={false} toc={true}>
2222
</ParamField>
2323
24-
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
25-
</ParamField>
26-
27-
<ParamField path="packageName" type="string" required={false} toc={true}>
24+
<ParamField path="composerJson" type="Record<string, any>" required={false} toc={true}>
2825
</ParamField>
2926
30-
<ParamField path="packagePath" type="string" required={false} toc={true}>
27+
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
3128
</ParamField>
3229
33-
<ParamField path="propertyAccess" type="'public' | 'private'" required={false} toc={true}>
30+
<ParamField path="namespace" type="string" required={false} toc={true}>
3431
</ParamField>
3532
36-
<ParamField path="namespace" type="string" required={false} toc={true}>
33+
<ParamField path="packageName" type="string" required={false} toc={true}>
3734
</ParamField>
3835
39-
<ParamField path="composerJson" type="Record<string, any>" required={false} toc={true}>
36+
<ParamField path="packagePath" type="string" required={false} toc={true}>
4037
</ParamField>
4138
39+
<ParamField path="propertyAccess" type="'public' | 'private'" required={false} toc={true}>
40+
</ParamField>

0 commit comments

Comments
 (0)