Skip to content

Remove debug/error language from $comment #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove debug/error language from $comment #1643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions specs/jsonschema-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1141,24 +1141,18 @@ the positive integer constraint is a subschema in `$defs`:
This keyword reserves a location for comments from schema authors to readers or
maintainers of the schema.

The value of this keyword MUST be a string. Implementations MUST NOT present
this string to end users. Tools for editing schemas SHOULD support displaying
and editing this keyword. The value of this keyword MAY be used in debug or
error output which is intended for developers making use of schemas.
The value of this keyword MUST be a string.

This keyword MUST not affect validation or be collected as an annotation.

The value of this keyword MAY be used as directives for developer tooling such
as a directive for a linter to ignore a linting rule in a schema.

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

Implementations MAY strip `$comment` values at any point during processing. In
particular, this allows for shortening schemas when the size of deployed schemas
is a concern.

Implementations MUST NOT take any other action based on the presence, absence,
or contents of `$comment` properties. In particular, the value of `$comment`
MUST NOT be collected as an annotation result.

## Loading and Processing Schemas

### Loading a Schema
Expand Down
Loading