Skip to content

Commit 1d83efb

Browse files
committed
address dropped annotations requirements; remove JSON key name requirements
1 parent ef14ca7 commit 1d83efb

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

jsonschema-core.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2113,24 +2113,17 @@ applicators such as `$ref` or `$dynamicRef`.
21132113
https://example.com/schemas/common#/$defs/allOf/1
21142114
```
21152115

2116-
When represented in JSON, the key for this information MUST be "schemaLocation".
2117-
21182116
### Instance Location
21192117

21202118
The instance location is the location of the JSON value within the root instance
21212119
being validated. The value MUST be expressed as a JSON Pointer.
21222120

2123-
When represented in JSON, the key for this information MUST be
2124-
"instanceLocation".
2125-
21262121
### Errors
21272122

21282123
Errors are textual representations of individual validation failures, often
21292124
intended for human consumers. This specification contains no requirements for
21302125
the content of these errors.
21312126

2132-
When represented in JSON, the key for this information MUST be "errors".
2133-
21342127
### Annotations
21352128

21362129
Many keywords are defined to produce annotations, whether intended for
@@ -2139,8 +2132,6 @@ inter-keyword communication (e.g. between `properties` and
21392132
`readOnly`). Annotation values may be of any type and are defined by the
21402133
keywords that produced them.
21412134

2142-
When represented in JSON, the key for this information MUST be "annotations".
2143-
21442135
### Dropped Annotations
21452136

21462137
A dropped annotation is any annotation produced and subsequently dropped by the
@@ -2149,12 +2140,11 @@ This information MAY be included if the validation result of the containing
21492140
subschema was unsuccessful. It MUST NOT be included if the local validation
21502141
result of the containing subschema was successful.
21512142

2152-
Implementations that wish to provide dropped annotations MUST NOT provide them
2153-
as their default behavior. Dropped annotations MUST only be included when the
2154-
implementations is explicitly configured to do so.
2155-
2156-
When represented in JSON, the key for this information MUST be
2157-
"droppedAnnotations".
2143+
As the intended purpose for including these annotations is debugging,
2144+
implementations that wish to provide dropped annotations SHOULD NOT provide them
2145+
as their default behavior. Dropped annotations SHOULD only be included when the
2146+
implementation is explicitly configured to do so or if the implementation is
2147+
specifically intended to be used as a debugging tool.
21582148

21592149
## Security Considerations {#security}
21602150

0 commit comments

Comments
 (0)