docs(sdks): document deepObjectMapQueryParameters TypeScript generator config - #6876
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(sdks): document deepObjectMapQueryParameters TypeScript generator config#6876devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…r config 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-1788800675-ts-deepobject-map-query-params.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
Documents a new opt-in TypeScript SDK generator option,
deepObjectMapQueryParameters, which encodes map-typed query parameters in OpenAPIdeepObjectstyle (?metadata[env]=prod) instead of a single JSON-stringified value (?metadata=%7B%22env%22%3A%22prod%22%7D). Servers that declare a query parameter withstyle: deepObjectcould not parse the stringified form, so SDKs generated for those APIs sent requests the server rejected. Enabling this option produces a TypeScript SDK that works with such servers; it defaults tofalse, so existing SDKs are unaffected.Implements docs for: feat(typescript): add opt-in
deepObjectMapQueryParameters(fern-api/fern#17652)Changed
fern/products/sdks/generators/typescript/configuration.mdx: newdeepObjectMapQueryParameters<ParamField>(alphabetically betweenauto-generate-idempotency-keyanddefaultTimeout) with a before/after query-string example and thenoSerdeLayerinteraction (nested object/date values are serialized through the serde layer only whennoSerdeLayer: false).No changelog entry (SDK changelogs are auto-generated).
generators-yml-reference.mdxonly links to the TypeScript page, so it was left unchanged.Vale and
fern check --warningspass; remaining findings are pre-existing on other lines/pages.Link to Devin session: https://app.devin.ai/sessions/3a0d216e8dd64014873d25f36a0c4294
Open in Devin Desktop: https://app.devin.ai/desktop/session/3a0d216e8dd64014873d25f36a0c4294?variant=devin