Add support for patternProperties - #1105
Open
ChrisJr404 wants to merge 1 commit into
Open
Conversation
Adds a PatternProperties field to huma.Schema so object schemas can validate properties whose names match a regular expression, per the JSON Schema / OpenAPI 3.1 patternProperties keyword. The field is serialized into the generated OpenAPI document and compiled patterns are precomputed alongside the existing pattern regex so validation avoids per-request allocations. During validation each instance property is checked against every matching pattern schema, and properties matched by a pattern are exempt from additionalProperties handling. autopatch carries the field through to generated PATCH schemas. Closes danielgtaylor#1102
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.
Closes #1102.
Adds a
PatternPropertiesfield tohuma.Schemaso object schemas can validate properties whose names match a regular expression, as described by the JSON Schema / OpenAPI 3.1patternPropertieskeyword. This lets you express things like "any key matching^str_[a-z]+$must be a string" that weren't previously possible.Behaviour
PatternProperties map[string]*Schemamarshals into the generated OpenAPI document aspatternProperties.PrecomputeMessages(stored next to the existingpatternregex) and iterated in sorted order, so validation stays allocation-free on the happy path and error ordering is deterministic.patternPropertiesschema whose regex matches its name (both themap[string]anyandmap[any]anypaths).additionalProperties: falseand theadditionalProperties: <schema>cases — matching the spec.autopatchcarries the field through to generated PATCH schemas.Tests
TestSchemaPatternPropertiescovers marshaling.TestValidatecases cover value type/constraint failures, theadditionalPropertiesinteraction (bool and schema forms), and themap[any]anypath.Kept the scope small per the note in #1040 about smaller PRs being easier to review. Happy to adjust the field naming or the additionalProperties interaction if you'd prefer a different approach.