Rule Type schema validation: change library and apply defaults #4953
Conversation
JAORMX
force-pushed
the
refactor-validate-and-defaults
branch
from
8089c5f
to
56b5a4f
Compare
This changes the underlying library to something that's actually maintained: github.com/santhosh-tekuri/jsonschema/v6 It also adds the feature of applying defaults if they were defined in the JSON schema. Signed-off-by: Juan Antonio Osorio <[email protected]>
Signed-off-by: Juan Antonio Osorio <[email protected]>
JAORMX
force-pushed
the
refactor-validate-and-defaults
branch
from
1e16bb5
to
a4c37a1
Compare
That might make sense, I just wanted to simplify the API by doing both validation and applying defaults. Else the implementor gets a more verbose setup. |
| if rt.Def.ParamSchema != nil { | ||
| paramSchemaLoader := gojsonschema.NewGoLoader(rt.Def.ParamSchema) | ||
| paramSchema, err = gojsonschema.NewSchema(paramSchemaLoader) | ||
| paramSchema, err = compileSchema(rt.GetDef().GetParamSchema().AsMap()) |
There was a problem hiding this comment.
Can compileSchema return a nil schema if the ParamSchema is empty?
There was a problem hiding this comment.
In particular, that could make this:
paramSchema, err := compileSchema(rt.GetDef().GetParamSchema())
if err != nil {
...
}
| return buildValidationError(result.Errors()) | ||
| func validateAgainstSchema(schema *jsonschema.Schema, obj map[string]any) error { | ||
| if err := schema.Validate(obj); err != nil { | ||
| return buildValidationError(err.(*jsonschema.ValidationError).Causes) |
There was a problem hiding this comment.
Do we need to worry that this error might have some other type? (And, does this need to be a separate method?)
| } | ||
|
|
||
| return fmt.Errorf("invalid json schema: %s", strings.TrimSpace(strings.Join(problems, "\n"))) |
There was a problem hiding this comment.
In all honesty, I don't remember. It may not be needed anymore.
| return fmt.Errorf("invalid json schema: %s", strings.TrimSpace(strings.Join(problems, "\n"))) | ||
| } | ||
|
|
||
| // applyDefaults recursively applies default values from the schema to the object. | ||
| func applyDefaults(schema *jsonschema.Schema, obj map[string]any) { |
There was a problem hiding this comment.
I wish the library had this function, but it looks like it doesn't. 😞
There was a problem hiding this comment.
No library I found has one 😢
It feels like we should do |
Summary
This changes the underlying library to something that's actually
maintained: github.com/santhosh-tekuri/jsonschema/v6
It also adds the feature of applying defaults if they were defined in
the JSON schema.
Closes #1657
Change Type
Mark the type of change your PR introduces:
Testing
Added a relevant unit test.
Review Checklist: