Skip to content

Commit 3e81674

Browse files
committed
link to annotation requirements; add requirements of output specs to include details for errors and annotations
1 parent 1d83efb commit 3e81674

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

jsonschema-core.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2124,6 +2124,10 @@ Errors are textual representations of individual validation failures, often
21242124
intended for human consumers. This specification contains no requirements for
21252125
the content of these errors.
21262126

2127+
Output specifications which include errors SHOULD be written such that the
2128+
sources (schema and instance) of a given error is easily identifiable and SHOULD
2129+
use the terms defined by this document to do so.
2130+
21272131
### Annotations
21282132

21292133
Many keywords are defined to produce annotations, whether intended for
@@ -2132,6 +2136,10 @@ inter-keyword communication (e.g. between `properties` and
21322136
`readOnly`). Annotation values may be of any type and are defined by the
21332137
keywords that produced them.
21342138

2139+
Output specifications which include annotations SHOULD be written such that they
2140+
can be easily associated with the data defined in {{collect}} and SHOULD use the
2141+
terms defined by this document to do so.
2142+
21352143
### Dropped Annotations
21362144

21372145
A dropped annotation is any annotation produced and subsequently dropped by the
@@ -2146,6 +2154,10 @@ as their default behavior. Dropped annotations SHOULD only be included when the
21462154
implementation is explicitly configured to do so or if the implementation is
21472155
specifically intended to be used as a debugging tool.
21482156

2157+
Output specifications which include dropped annotations SHOULD be written such
2158+
that they can be easily associated with the data defined in {{collect}} and
2159+
SHOULD use the terms defined by this document to do so.
2160+
21492161
## Security Considerations {#security}
21502162

21512163
Both schemas and instances are JSON values. As such, all security considerations

0 commit comments

Comments
 (0)