Skip to content

docs: document requireBaseUrl TypeScript generator config - #6545

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1785949647-ts-require-base-url
Open

docs: document requireBaseUrl TypeScript generator config#6545
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1785949647-ts-require-base-url

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

requireBaseUrl is a new opt-in TypeScript generator config flag that flips which client option is required: baseUrl becomes required and environment becomes optional. This matters for teams whose APIs have no named environments, or who want callers to point the SDK at an arbitrary host: previously those users still had to pass an environment string even though it wasn't a meaningful choice. With the flag on, baseUrl is the required, discoverable option, and generated snippets and the README construct the client the same way instead of showing a non-compiling environment example.

Implements docs for: feat(typescript): add requireBaseUrl config to require baseUrl and make environment optional (fern-api/fern#17321)

Docs changed

  • fern/products/sdks/generators/typescript/configuration.mdx: adds a requireBaseUrl <ParamField> (boolean, default false) matching the shape of the neighboring options, covering the flipped required/optional client options, the snippet and README behavior, and that the option is ignored for APIs with multiple base URLs.

No SDK changelog entry, per the SDK changelog being handled separately.

Link to Devin session: https://app.devin.ai/sessions/1b65a5e95dfa4810bc5dc320e65ffc9d

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
devin-ai-integration Bot requested a review from devalog as a code owner August 5, 2026 17:07
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants