Skip to content

chore: toc enabled for java sdk config #143

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

Closed
wants to merge 1 commit into from
Closed

chore: toc enabled for java sdk config #143

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
32 changes: 16 additions & 16 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,18 +17,18 @@ groups:

## SDK Configuration Options

<ParamField path="client-class-name" type="string" default="<Organization>ApiClient" required={false}>
<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}>
<ParamField path="base-api-exception-class-name" type="string" required={false} toc={true}>
</ParamField>

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

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

Example:

Expand All @@ -41,44 +41,44 @@ Example:

</ParamField>

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

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

<ParamField path="wrapped-aliases" type="boolean" default="false" required={false}>
<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>

<ParamField path="enable-forward-compatible-enums" type="boolean" default="false" required={false}>
<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}>
<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}>
<ParamField path="json-include" type="'non-empty' | 'non-absent'" default="non-absent" required={false} toc={true}>
</ParamField>

<ParamField path="enable-public-constructors" type="boolean" default="false" required={false}>
<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}>
<ParamField path="disable-required-property-builder-checks" type="boolean" default="false" required={false} toc={true}>
</ParamField>

<ParamField path="inline-path-parameters" type="boolean" default="false" required={false}>
<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}>
<ParamField path="enable-inline-types" type="boolean" default="false" required={false} toc={true}>
</ParamField>

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

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