Merge pull request #609 from danielgtaylor/docs-writeonly-required-reuse

docs: add note about required write-only field
danielgtaylor · Oct 15, 2024 · 1c7affe · 1c7affe
2 parents f398d76 + 041433b
commit 1c7affe
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/docs/features/request-validation.md b/docs/docs/features/request-validation.md
@@ -145,6 +145,10 @@ You will need to take care to ensure read-only fields are not modified. It's up
 
 Write-only fields, if stored in a datastore, can be combined with `omitempty` and then set to the zero value in handlers, or filtered out via datastore queries or projection. They can also be kept out of the datastore altogether but used to compute values in fields that will get stored.
 
+!!! info "Note"
+
+    If a write-only field needs to be required on the request but the same struct is re-used in the response, you can use `json:"name,omitempy"` with `required:"true"`.
+
 ## Strict vs. Loose Field Validation
 
 By default, Huma is strict about which fields are allowed in an object, making use of the `additionalProperties: false` JSON Schema setting. This means if a client sends a field that is not defined in the schema, the request will be rejected with an error. This can help to prevent typos and other issues and is recommended for most APIs.