docs: add collapse-optional-nullable flag to Java SDK configuration #1882
Conversation
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
Add documentation for the collapse-optional-nullable configuration flag that enables OptionalNullable types for PATCH requests. This flag allows distinguishing between absent, null, and present field states for proper JSON Merge Patch semantics. Co-Authored-By: [email protected] <[email protected]>
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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </ParamField> | ||
| <ParamField path="collapse-optional-nullable" type="boolean" default="false" required={false} toc={true}> | ||
| When enabled, generates `OptionalNullable<T>` types for PATCH request fields to distinguish between three states: absent (field not provided), null (field explicitly set to null), and present (field has a non-null value). This enables proper handling of JSON Merge Patch semantics where omitting a field, setting it to null, and providing a value have different meanings. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'PATCH' has no definition.
Contributor
Add PATCH to the list of allowed acronyms in FernStyles/Acronyms.yml to match other HTTP methods (GET, POST, PUT) and resolve Vale suggestion. Co-Authored-By: [email protected] <[email protected]>
Contributor
- Remove PATCH from Vale acronyms exceptions (should not hide Vale suggestions) - Change 'PATCH request fields' to 'merge patch request fields' to avoid triggering Vale Acronyms rule - Maintains technical accuracy while complying with Vale style guidelines Co-Authored-By: [email protected] <[email protected]>
Contributor
tstanmay13
approved these changes
Nov 10, 2025
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.
docs: add collapse-optional-nullable flag to Java SDK configuration
Summary
Added documentation for the
collapse-optional-nullableconfiguration flag to the Java SDK configuration page. This flag was introduced in PR #10218 and enablesOptionalNullable<T>types for merge patch requests to distinguish between three field states: absent (not provided), null (explicitly set to null), and present (has a value).The documentation is placed alphabetically between
client-class-nameandcustom-dependenciesand follows the existing style and format of other boolean configuration flags.Review & Testing Checklist for Human
default="false"is correct. I inferred this from the schema showing the field as optional, but the schema doesn't explicitly specify a default value. Check the generator code or PR #10218 to confirm.Notes
BaseJavaCustomConfigSchema.ts:collapse-optional-nullableseed/java-sdk/nullable-optional/collapse-optional-nullable/