networknt / networknt/json-schema-validator
Public documentation of built-in error codes?
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 352
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 5
Description
Exposing error codes is awesome, thanks for that!
I was initially thinking of including the error code in the validation error message I expose to the user of my integration.
However, since there don't seem to be any public document listing built-in error codes and what they mean (apart from reading the raw source of com.networknt.schema.ValidatorTypeCode), I'm not sure there is value in exposing that.
Is there a plan to have an online document with a list of built-in error codes and they mean?
If there was, I could include the link in the error description e.g.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the built-in codes in com.networknt.schema.ValidatorTypeCode and the repository's existing documentation structure. Done means providing an online document that lists the built-in error codes and explains what they mean.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100