diff --git a/README.md b/README.md index 3591254fb..acc1537fc 100644 --- a/README.md +++ b/README.md @@ -443,6 +443,20 @@ JsonValue complexValue = JsonValue.from(Map.of( )); ``` +Normally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset. + +To forcibly omit a required parameter or property, pass [`JsonMissing`](orb-java-core/src/main/kotlin/com/withorb/api/core/Values.kt): + +```java +import com.withorb.api.core.JsonMissing; +import com.withorb.api.models.CustomerCreateParams; + +CustomerCreateParams params = CustomerCreateParams.builder() + .name("x") + .email(JsonMissing.of()) + .build(); +``` + ### Response properties To access undocumented response properties, call the `_additionalProperties()` method: