RicoSuter/NJsonSchema

Improve pretty print of validation errors

Open

#332 opened on Mar 8, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (550 forks)github user discovery
help wantedproject: NJsonSchema.Validationtype: enhancement

Repository metrics

Stars
 (1,578 stars)
PR merge metrics
 (Avg merge 39d 6h) (1 merged PR in 30d)

Description

Let's say an allOf clause is violated because there is a required property missing. Currently, if we iterate through errors, we are getting:

"NotAllOf: #/\n{\n  PropertyRequired: #/someproperty\n}\n{\n}\n"

This structure is not easily processable, and not very pretty to print. It would be great if we could build something like:

{
	"NotAllOf": {
		"PropertyRequired": "#/someproperty"
	}
}

I have not seen a way to iterate through nested errors in order to achieve this.

Contributor guide

Research direction
Investigate the existing validation error structure in NJsonSchema and propose a method to format errors as a nested JSON object.
Tech stack
csharp
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#JSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60