docs: document requireBaseUrl TypeScript generator config - #6545
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: document requireBaseUrl TypeScript generator config#6545devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1785949647-ts-require-base-url.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
requireBaseUrlis a new opt-in TypeScript generator config flag that flips which client option is required:baseUrlbecomes required andenvironmentbecomes 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 anenvironmentstring even though it wasn't a meaningful choice. With the flag on,baseUrlis the required, discoverable option, and generated snippets and the README construct the client the same way instead of showing a non-compilingenvironmentexample.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 arequireBaseUrl<ParamField>(boolean, defaultfalse) 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