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

Examples on usage #56

Closed
lornatumuhairwe opened this issue Mar 10, 2020 · 3 comments
Closed

Examples on usage #56

lornatumuhairwe opened this issue Mar 10, 2020 · 3 comments

Comments

@lornatumuhairwe
Copy link

lornatumuhairwe commented Mar 10, 2020

The json schema validation is really great!

I had some trouble writing a schema for validation. The current documentation didn't guide me well. After a while.. I finally got it down but I think it can be better.

I would like to write a few examples and stick them in the current README, if it's okay. I think it would make it easier for other people that come across it.

What do you think? Or are there docs I'm missing somewhere?

cc @jonasschmidt

@lornatumuhairwe
Copy link
Author

Wrote some examples in this gist incase someone runs into this.

@lornatumuhairwe lornatumuhairwe changed the title Better documentation around usage Examples on usage Mar 12, 2020
@jonasschmidt
Copy link
Owner

Thank you for the feedback. Since the lack of documentation seems to be more about JSON Schema in general and not this library in particular, maybe linking to some online resources on how to write and validate a JSON Schema might be a better solution?

@lornatumuhairwe
Copy link
Author

lornatumuhairwe commented Mar 12, 2020

Thank you for the response. That will be great!

I found this page that lists all the compliant implementations. The ruby implementation has good examples.
This tutorial too was also great has a great example in elixir

Do you have any resources in mind?

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

No branches or pull requests

2 participants