Skip to content
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

chore: update README and examples #45

Merged
merged 6 commits into from
Oct 4, 2023
Merged

Conversation

jessicamcinchak
Copy link
Member

@jessicamcinchak jessicamcinchak commented Oct 3, 2023

  • Updates and re-organises README
  • Adds one example per application type (keeping example type definitions under /examples/data and generated JSONs at root of /examples for discoverabilty)
  • Tidies up JSDoc annotations throughout schema for consistency

const validator = new Validator();
const result = validator.validate(example, generatedSchema);
const result = validator.validate(example, generatedSchema, {
disableFormat: true,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jsonschema was throwing an error on misformatted date-time formats - I'm guessing we ultimately need an extra plugin for this library too to validate them? i found the python one, but not the js one yet, so just passing this option for now to ignore special formats

@jessicamcinchak jessicamcinchak changed the title chore: update example data chore: update README and examples Oct 3, 2023
@jessicamcinchak jessicamcinchak marked this pull request as ready for review October 3, 2023 19:45
Copy link
Contributor

@DafyddLlyr DafyddLlyr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Readme is much clearer now thanks and good to see examples co-located and published with the schema 💪

@jessicamcinchak jessicamcinchak merged commit 287890d into main Oct 4, 2023
1 check passed
@jessicamcinchak jessicamcinchak deleted the jess/update-examples branch October 4, 2023 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants