-
-
Notifications
You must be signed in to change notification settings - Fork 7
Add Support for JSON Schema Draft-04 Keywords #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Diya <diyasrivastava2023@gmail.com>
|
@jdesrosiers please have a look whenever you're free,because i feel a lot of it needs to be re iterated over |
jdesrosiers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a quick review. I didn't have enough time to look over everything in much detail.
Make sure you're working with @Adityakumar37 on the items/additionalItems keywords. I'm hoping to merge that PR first, then you can rebase and add the rest of the draft-04 implementation on top of that.
Anyway, your approach for those keywords isn't right. Those are simple applicators. Simple applicators don't need error handlers. Your normalization handlers should look a lot like the keywords from draft-2020-12 that serve the same purpose.
dependencies is a weird one because it's a simple applicator in some cases (schemas) and a validation keyword in other cases (string array). It can even do both at the same time. I need to go through that handler closer later, but it seems like it should be a problem.
| const parentUri = schemaLocation.replace(/\/[^/]+$/, ""); | ||
| const parentSchema = await getSchema(parentUri); | ||
| const parentValue = /** @type {import("../../index.d.ts").JsonObject} */ (Schema.value(parentSchema)); | ||
| const exclusiveMaximum = /** @type boolean | undefined */ (parentValue.exclusiveMaximum); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't work in some cases when references are used. See the solution I used for minContains/maxContains in the contains handler for a better approach.
| errors.push({ | ||
| message: localization.getRequiredErrorMessage(missing), | ||
| instanceLocation: Instance.uri(instance), | ||
| schemaLocations: [`${schemaLocation}/${propertyPointer}`] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just use schemaLocation here. You don't need a more specific pointer.
| /** @type NormalizationHandler<any> */ | ||
| const additionalItemsNormalizationHandler = { | ||
| evaluate(_params, _instance, _context) { | ||
| return []; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returning an empty array never makes sense. This should look a lot like draft-2020-12 items.
| const keywordOutput = dependenciesErrors[schemaLocation]; | ||
| if (Array.isArray(keywordOutput)) { | ||
| for (const output of keywordOutput) { | ||
| const result = await getErrors(output, instance, localization); | ||
| errors.push(...result); | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, this is how you got around the problem of dependencies being an applicator and a validator. I hadn't intended to use getErrors for this kind of thing, but it makes sense. 👍
Signed-off-by: Diya <diyasrivastava2023@gmail.com>
|
hey @jdesrosiers , |
jdesrosiers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty close now. The only thing I haven't looked at yet is the tests.
| const parentLocation = schemaLocation.replace(/\/maximum$/, ""); | ||
| const parent = await getSchema(parentLocation); | ||
| const exclusiveNode = await Schema.step("exclusiveMaximum", parent); | ||
| const exclusive = /** @type boolean */ (Schema.value(exclusiveNode) ?? false); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't always work. You have to find the value using the keyword URI, not the keyword name. See the contains error handler for an example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, contains isn't quite right either because it considers values from other schemas applied to the same location. You're going to have find a solution that doesn't hardcode the keyword name, but only considers keywords in the same subschema.
| }); | ||
| } else { | ||
| errors.push({ | ||
| message: localization.getMaximumErrorMessage(maximum), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While testing I noticed that the messages for exclusiveMaximum and maximum are the same. This PR seems like a good opportunity to fix that.
Added Support for JSON Schema Draft-04 Keywords
I have implemented full support for the requested Draft-04 keywords in
@hyperjump/json-schema-errors.Issue : #119
Changes made
itemsandadditionalItemsDraft-04 treats
itemsandadditionalItemsas siblings whereadditionalItemsvalidation depends onitems(ifitemsis an array).itemsnormalization handler in items.js.itemshandler infers the URI of the siblingadditionalItemskeyword (by string manipulation of theitemsURI) and retrieves the schema from the AST. It then acts as the validator for the "tail" items that fall underadditionalItemscriteria.dependenciesImplemented
dependencies.jsto handle both:Numeric Keywords (
maximum,minimum)Implemented handlers
maximum.js,minimum.js.exclusiveMaximum(boolean).exclusiveMaximum) to construct the correct error message ("less than" vs "less than or equal to").Also Added test cases