shapes-ISSUE-182 (Validation report): [Editorial] Clarifications need to section 3.0

shapes-ISSUE-182 (Validation report): [Editorial] Clarifications need to section 3.0

http://www.w3.org/2014/data-shapes/track/issues/182

Raised by: Karen Coyle
On product: 

Section 3.0 on validation talks about the validation results, but doesn't explain clearly which properties are required and which are optional. It also should refer to the shapes graph as the source of the properties, not just to their appearance in the report. Some examples:

"3.4.1.3 Value (sh:value)

Validation results may have a value for the property sh:value pointing at a specific node that has caused the result."

- it isn't clear if sh:value MUST be returned if sh:value is coded in the constraint, or if echoing back sh:value when it exists is itself optional.

3.4.1.8 Declaring the Severity of a Constraint uses "can" not "MAY", and gives the default as sh:Violation (Does that mean T/F cannot have a default?). Better wording would be:

"The severity level of a constraint violation MAY be coded in the constraint of a shapes graph using the property sh:severity, which takes as its value one of the SHACL pre-defined severities, or a locally defined severity." (followed by remaining sentences)

Also, the example given shows the shapes graph, but would be more informative if it also included the validation report that results.

Note that examples throughout do not include sh:severity or sh:message in constraints, which requires some explanation, perhaps in the introductory area where examples are described. (I presume that it is expected that most or many constraints will include a severity, so it would be a normally occurring property, and that sh:message will also be common.)

The Example validation report in section 2.2 (Filter shapes) has sh:severity and sh:message although those are not shown in the shapes graph.

Received on Thursday, 29 September 2016 15:40:09 UTC