Skip to content

readme update #19

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.

Sign up for GitHub

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

Merged
neo7337 merged 1 commit into from
Oct 11, 2022
Merged

readme update #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ The validator covers the specifications, and its respective validations accordin
- [Benchmarking](#benchmarking)
- [Quick Start Guide](#quick-start-guide)
- [Features](#features)
- [Mandatory Validations Check](#mandatory-validations-check)
- [Validations Supported](#validations-supported)

---
Expand Down Expand Up @@ -76,21 +75,10 @@ To add check for validations, add the `constraints` tag in the struct fields.

### Features

#### Mandatory Validations Check

2 constraints are to be present with each struct contraint tag
1. `required`
2. `nillable`

If any one of the constraint is not passed, the validation fails with the respective error.

#### Validations Supported

| S.No. | Name | Data Type Supported | Status |
|:------|:------------:|---------------------|--------|
| 1 | required | all | WIP |
| 2 | nillable | all | WIP |
| 3 | default | all | WIP |
| 4 | min | numeric | ✅ |
| 5 | max | numeric | ✅ |
| 6 | exclusiveMin | numeric | ✅ |
Expand All @@ -99,4 +87,5 @@ If any one of the constraint is not passed, the validation fails with the respec
| 9 | max-length | string | ✅ |
| 10 | min-length | string | ✅ |
| 11 | pattern | string | ✅ |
| 11 | notnull | string | ✅ |
| 12 | enum | all | ✅ |