Skip to content

Commit

Permalink
doc README regarding validation
Browse files Browse the repository at this point in the history
  • Loading branch information
notEthan committed Oct 1, 2021
1 parent d50c7b0 commit e1f9ada
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -212,6 +212,15 @@ module ContactPhone
end
```

## Validation

JSI implements all required features, and many optional features, for validation according to supported JSON Schema specifications. To validate instances, see methods {JSI::Base#jsi_validate}, {JSI::Base#jsi_valid?}, {JSI::Schema#validate_instance}, {JSI::Schema#instance_valid?}.

The following optional features are not completely supported:

- The `format` keyword does not perform any validation.
- Regular expressions are interpreted by Ruby's Regexp class, whereas JSON Schema recommends interpreting these as ECMA 262 regular expressions. Certain expressions behave differently, particularly `^` and `$`.

## Metaschemas

A metaschema is a schema which describes schemas. Likewise, a schema is an instance of a metaschema.
Expand Down

0 comments on commit e1f9ada

Please sign in to comment.