Skip to content
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.

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

Output unit schema inconsistent with spec #1504

Open
tombentley opened this issue May 3, 2024 · 4 comments
Open

Output unit schema inconsistent with spec #1504

tombentley opened this issue May 3, 2024 · 4 comments

Comments

@tombentley
Copy link

The 2020-12 spec says this about successful validations:

The JSON key for failed validations is "error"; for successful validations it is "annotation".

A later sentence draws an explicit contrast for the case of nested results :

Note the plural forms, as a keyword with nested results can also have a local error or annotation.

But the output schema only defines a property for the plural annotations and not the singular annotation.

@gregsdennis
Copy link
Member

The output schema defines error because errors are only strings. It doesn't define a subschema for annotation because annotations can be of any value.

@tombentley
Copy link
Author

tombentley commented Jun 18, 2024

Wouldn't it be clearer to use annotation: true to define the property in that case? At least that way annotation is present in the schema. When I read the text I found it confusing that something was mentioned in the text (not in an especially clear way, imho) but not even present in the schema.

@gregsdennis
Copy link
Member

I see your point. Intentionality is worth something.

I'll go ahead and reopen this, but it'll be for an errata correction. I'm not sure how to make that change since the file has already moved on to the next version of the output. This might need to be done in the website repo.

@gregsdennis gregsdennis reopened this Jun 18, 2024
@jdesrosiers
Copy link
Member

I'm not sure how to make that change since the file has already moved on to the next version of the output.

There's branch for each release. You can make the change on top of that branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants