Skip to content

Commit c7b9b14

Browse files
committed
Remove debug/error language from $comment
1 parent b11ba1d commit c7b9b14

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

specs/jsonschema-core.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1141,24 +1141,18 @@ the positive integer constraint is a subschema in `$defs`:
11411141
This keyword reserves a location for comments from schema authors to readers or
11421142
maintainers of the schema.
11431143

1144-
The value of this keyword MUST be a string. Implementations MUST NOT present
1145-
this string to end users. Tools for editing schemas SHOULD support displaying
1146-
and editing this keyword. The value of this keyword MAY be used in debug or
1147-
error output which is intended for developers making use of schemas.
1144+
The value of this keyword MUST be a string.
1145+
1146+
This keyword MUST not affect validation or be collected as an annotation.
1147+
1148+
The value of this keyword MAY be used as directives for developer tooling such
1149+
as a directive for a linter to ignore a linting rule in a schema.
11481150

11491151
Tools that translate schemas between media types or programming languages MAY
11501152
choose to convert that media type or programming language's native comments to
11511153
or from `$comment` values. The behavior of such translation when both native
11521154
comments and `$comment` properties are present is implementation-dependent.
11531155

1154-
Implementations MAY strip `$comment` values at any point during processing. In
1155-
particular, this allows for shortening schemas when the size of deployed schemas
1156-
is a concern.
1157-
1158-
Implementations MUST NOT take any other action based on the presence, absence,
1159-
or contents of `$comment` properties. In particular, the value of `$comment`
1160-
MUST NOT be collected as an annotation result.
1161-
11621156
## Loading and Processing Schemas
11631157

11641158
### Loading a Schema

0 commit comments

Comments
 (0)