Skip to content

docs: document applyQueryDefaultsOnNilRequest Go generator option #6447

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

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document applyQueryDefaultsOnNilRequest Go generator option #6447

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
4 changes: 4 additions & 0 deletions fern/products/sdks/generators/go/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ groups:
When enabled, ensures that all required properties are always included in API requests, even if they have default values or are otherwise optional in the implementation.
</ParamField>

<ParamField path="applyQueryDefaultsOnNilRequest" type="boolean" default="false" required={false} toc={true}>
When enabled, passing `nil` as the request argument encodes query parameters as if a zero-value request struct were passed, so query parameter defaults are still sent. By default, `nil` requests drop those defaults.
</ParamField>

<ParamField path="auto-generate-idempotency-key" type="boolean | object" default="false" toc={true}>
Overrides the API-wide [`api.settings.auto-generate-idempotency-key`](/learn/sdks/reference/generators-yml#settings) for this SDK. Set `true` to attach an [idempotency-key header](/learn/sdks/deep-dives/idempotency#auto-generate-idempotency-keys) to eligible requests (`POST` and `PUT` by default) unless the caller provides one, or `false` to opt this SDK out when auto-generation is enabled API-wide. Pass an object to customize `header-name` and `methods`.
</ParamField>
Expand Down
Loading