Skip to content

Alphabetize options for all Configuration pages #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025
Merged

Alphabetize options for all Configuration pages #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions fern/products/sdks/overview/csharp/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ groups:

## SDK configuration options

<ParamField path="namespace" type="string" required={false} toc={true}>
<ParamField path="additional-properties" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
Expand All @@ -30,47 +30,47 @@ groups:
<ParamField path="client-class-name" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="environment-class-name" type="string" required={false} toc={true}>
<ParamField path="custom-pager-name" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="exported-client-class-name" type="string" required={false} toc={true}>
<ParamField path="enable-forward-compatible-enums" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="explicit-namespaces" type="boolean" required={false} toc={true}>
<ParamField path="environment-class-name" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="inline-path-parameters" type="boolean" required={false} toc={true}>
<ParamField path="explicit-namespaces" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="read-only-memory-types" type="List<string>" required={false} toc={true}>
<ParamField path="exported-client-class-name" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="root-namespace-for-core-classes" type="boolean" required={false} toc={true}>
<ParamField path="generate-error-types" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="use-discriminated-unions" type="boolean" required={false} toc={true}>
<ParamField path="generate-mock-server-tests" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="root-client-class-access" type="'public' | 'internal'" required={false} toc={true}>
<ParamField path="include-exception-handler" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="custom-pager-name" type="string" required={false} toc={true}>
<ParamField path="inline-path-parameters" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="enable-forward-compatible-enums" type="boolean" required={false} toc={true}>
<ParamField path="namespace" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="additional-properties" type="boolean" required={false} toc={true}>
<ParamField path="package-id" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="generate-error-types" type="boolean" required={false} toc={true}>
<ParamField path="read-only-memory-types" type="List<string>" required={false} toc={true}>
</ParamField>

<ParamField path="package-id" type="string" required={false} toc={true}>
<ParamField path="root-client-class-access" type="'public' | 'internal'" required={false} toc={true}>
</ParamField>

<ParamField path="generate-mock-server-tests" type="boolean" required={false} toc={true}>
<ParamField path="root-namespace-for-core-classes" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="include-exception-handler" type="boolean" required={false} toc={true}>
</ParamField>
<ParamField path="use-discriminated-unions" type="boolean" required={false} toc={true}>
</ParamField>
100 changes: 50 additions & 50 deletions fern/products/sdks/overview/go/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,53 @@ groups:

## SDK Configuration Options

<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="clientConstructorName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="clientName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="exportedClientName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="importPath" type="string" required={false} toc={true}>
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.

<Note>If you plan to to distribute the generated Go SDK as a separate, published Go module, use the `module` configuration option instead.</Note>

You can generate the Go SDK code into a `gen/go/api` package with the following `generators.yml`
configuration:

```yaml {7-8}
default-group: local
groups:
local:
generators:
- name: fernapi/fern-go-sdk
version: 0.13.0
config:
importPath: github.com/<YOUR_ORGANIZATION>/<YOUR_REPOSITORY>/generated/go
output:
location: local-file-system
path: ../generated/go
```
<Info>You must update the `<YOUR_ORGANIZATION>` and `<YOUR_REPOSITORY>` placeholders
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>

</ParamField>

<ParamField path="includeLegacyClientOptions" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="inlineFileProperties" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="module" type="ModuleConfigSchema" required={false} toc={true}>
Use this option if you plan to distribute the generated Go SDK as a separate, published Go module.

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

</ParamField>

<ParamField path="packageName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="importPath" type="string" required={false} toc={true}>
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.

<Note>If you plan to to distribute the generated Go SDK as a separate, published Go module, use the `module` configuration option instead.</Note>

You can generate the Go SDK code into a `gen/go/api` package with the following `generators.yml`
configuration:

```yaml {7-8}
default-group: local
groups:
local:
generators:
- name: fernapi/fern-go-sdk
version: 0.13.0
config:
importPath: github.com/<YOUR_ORGANIZATION>/<YOUR_REPOSITORY>/generated/go
output:
location: local-file-system
path: ../generated/go
```
<Info>You must update the `<YOUR_ORGANIZATION>` and `<YOUR_REPOSITORY>` placeholders
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>

</ParamField>

<ParamField path="alwaysSendRequiredProperties" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="clientConstructorName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="clientName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="exportedClientName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="includeLegacyClientOptions" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="inlineFileProperties" type="boolean" required={false} toc={true}>
<ParamField path="packageLayout" type="'flat' | 'nested'" required={false} toc={true}>
</ParamField>

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

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

<ParamField path="useReaderForBytesRequest" type="boolean" required={false} toc={true}>
</ParamField>
</ParamField>
46 changes: 23 additions & 23 deletions fern/products/sdks/overview/java/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ groups:

## SDK Configuration Options

<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false} toc={true}>

The provided string will be used as the client class name.
</ParamField>

<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="base-exception-class-name" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false} toc={true}>

The provided string will be used as the client class name.
</ParamField>

<ParamField path="custom-dependencies" type="List<string>" required={false} toc={true}>

Example:
Expand All @@ -41,40 +41,33 @@ Example:

</ParamField>

<ParamField path="publish-to" type="'central' | 'ossrh'" required={false} toc={true}>
</ParamField>

<ParamField path="inline-file-properties" type="boolean" default="false" required={false} toc={true}>
</ParamField>

<ParamField path="wrapped-aliases" type="boolean" default="false" required={false} toc={true}>
When enabled, generates wrapper types for each alias to increase type-safety.
For example, if you have an alias `ResourceId: string` then if this is true, the
generator will generate a `ResourceId.java` file. If false, it will just treat it
as `java.util.String`.
<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false} toc={true}>
</ParamField>

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

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

<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false} toc={true}>
<ParamField path="enable-inline-types" type="boolean" default="false" required={false} toc={true}>
</ParamField>

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

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

<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false} toc={true}>
<ParamField path="generate-unknown-as-json-node" type="boolean" default="false" required={false} toc={true}>
</ParamField>

<ParamField path="inline-file-properties" type="boolean" default="false" required={false} toc={true}>
</ParamField>

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

<ParamField path="enable-inline-types" type="boolean" default="false" required={false} toc={true}>
<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false} toc={true}>
</ParamField>

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

<ParamField path="package-prefix" type="string" required={false} toc={true}>
Expand All @@ -86,5 +79,12 @@ config:
```
</ParamField>

<ParamField path="package-layout" type="'nested' | 'flat'" default="nested" required={false} toc={true}>
<ParamField path="publish-to" type="'central' | 'ossrh'" required={false} toc={true}>
</ParamField>

<ParamField path="wrapped-aliases" type="boolean" default="false" required={false} toc={true}>
When enabled, generates wrapper types for each alias to increase type-safety.
For example, if you have an alias `ResourceId: string` then if this is true, the
generator will generate a `ResourceId.java` file. If false, it will just treat it
as `java.util.String`.
</ParamField>
15 changes: 7 additions & 8 deletions fern/products/sdks/overview/php/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,20 @@ groups:
<ParamField path="clientName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="packageName" type="string" required={false} toc={true}>
<ParamField path="composerJson" type="Record<string, any>" required={false} toc={true}>
</ParamField>

<ParamField path="packagePath" type="string" required={false} toc={true}>
<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
</ParamField>

<ParamField path="propertyAccess" type="'public' | 'private'" required={false} toc={true}>
<ParamField path="namespace" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="namespace" type="string" required={false} toc={true}>
<ParamField path="packageName" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="composerJson" type="Record<string, any>" required={false} toc={true}>
<ParamField path="packagePath" type="string" required={false} toc={true}>
</ParamField>

<ParamField path="propertyAccess" type="'public' | 'private'" required={false} toc={true}>
</ParamField>
Loading