Skip to content

Commit

Permalink
docs: cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
sagold committed Jun 28, 2024
1 parent 689311f commit 910a521
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
> footprint or high performance, this package focuses on exposing utilities for browser and node environments and
> lessens the pain to build custom tools around json-schema.
> ⚠️ This documentation refers to the upcoming release version 10, which can be installed by `npm install [email protected]`. For the latest release please refer to the [documentation of version 9.3.5](https://github.com/sagold/json-schema-library/tree/v9.3.5)
<p style="text-align:center">
<a href="#draft-methods">draft methods</a> | <a href="#draft-extensions">draft extensions</a> | <a href="#draft-customization">draft customization</a> | <a href="#breaking-changes">breaking changes</a>
</p>

> ⚠️ This documentation refers to the upcoming release version 10, which can be insalled by `npm install [email protected]`. For the latest release please refer to the [documentation of version 9.3.5](https://github.com/sagold/json-schema-library/tree/v9.3.5)
**install**

`yarn add json-schema-library`
Expand Down
38 changes: 19 additions & 19 deletions TASKS.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Draft 2019-09 Scope

- [ ] introduction of scopes reduces jlib performance by ~20-22%. can we do sth about this?
- moving this logic to draft 2019 would solve this, but introduce two different apis unless we can hide it
- a consistent api might lead to performance impacts of legacy drafts
- an inconsistent api would not be manageable (duplicate utils like getTemplate etc)
- there is probably a lot that can be improved (also in compile time)
- [ ] add all subSchemas to scope-history as only if and anyOf are tested
- [ ] decision on supported draft 2019-09 format-options
- [ ] `getSchema` inconsistent return of non-node for root-requests
- [ ] introduction of scopes reduces jlib performance by ~20-22%. can we do sth about this?
- moving this logic to draft 2019 would solve this, but introduce two different apis unless we can hide it
- a consistent api might lead to performance impacts of legacy drafts
- an inconsistent api would not be manageable (duplicate utils like getTemplate etc)
- there is probably a lot that can be improved (also in compile time)
- [ ] add all subSchemas to scope-history as only if and anyOf are tested
- [ ] decision on supported draft 2019-09 format-options

# Tasks

- [ ] template default options retrieved from draft
- [ ] additionalProperties: true per default
- [ ] compile needs another parameter for rootschema, in case refs are defined elsewhere

- [ ] template default options retrieved from draft
- [ ] additionalProperties: true per default
- [ ] compile needs another parameter for rootschema, in case refs are defined elsewhere

### possibly

- [ ] remove hard coded schema interpretation
- [ ] Improve -- _oneOf-Error messages_ (specific errors where possible, instead of one-of-error)
- [ ] Add -- Resolve $ref local json-pointer without requiring compiled schema
- [ ] Refactor -- move type validation as keyword to validation/keywords
- [ ] Refactor -- Use addValidation to setup base validation mappings?
- [ ] Features -- latest draft support
- [ ] Refactor -- improve performance
- [ ] Feature -- Helper to find a json- and json-schema-pointer
- [ ] remove hard coded schema interpretation
- [ ] Improve -- _oneOf-Error messages_ (specific errors where possible, instead of one-of-error)
- [ ] Add -- Resolve $ref local json-pointer without requiring compiled schema
- [ ] Refactor -- move type validation as keyword to validation/keywords
- [ ] Refactor -- Use addValidation to setup base validation mappings?
- [ ] Features -- latest draft support
- [ ] Refactor -- improve performance
- [ ] Feature -- Helper to find a json- and json-schema-pointer

0 comments on commit 910a521

Please sign in to comment.