Skip to content

Document moduleName option (Swift SDK) #720

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 2 commits into from
Sep 7, 2025
Merged

Document moduleName option (Swift SDK) #720

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1eb3267
Visual Editor: Update
fern-api[bot] Sep 6, 2025
908d3ed
undo changes on welcome.mdx
devalog Sep 6, 2025
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
9 changes: 7 additions & 2 deletions fern/products/sdks/overview/swift/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Configuration options for the Fern Swift SDK.

You can customize the behavior of the Swift SDK generator in `generators.yml`:

```yaml {6-8} title="generators.yml"
```yaml {6-9} title="generators.yml"
groups:
swift-sdk:
generators:
Expand All @@ -14,6 +14,7 @@ groups:
config:
clientClassName: YourClientName
environmentEnumName: YourCustomEnvironment
moduleName: MyCustomModule
```

## SDK Configuration Options
Expand All @@ -24,4 +25,8 @@ The name of the generated client class. This allows you to customize the class n

<ParamField path="environmentEnumName" type="string" required={false} toc={true}>
The name of the generated environment enum. This allows you to customize the enum name that defines your API environments (such as production, staging, development) and ensures consistent naming across SDK generations.
</ParamField>
</ParamField>

<ParamField path="moduleName" type="string" required={false} toc={true}>
The module name used in client code (e.g., `import MyCustomModule`). When provided, this name is used consistently across the library, product, and target.
</ParamField>