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

Update output schema to describe new structure #1285

Merged
merged 1 commit into from
Oct 17, 2022

Conversation

gregsdennis
Copy link
Member

@gregsdennis gregsdennis commented Sep 8, 2022

Updates the output schema file to match the new structure as described by the specification. Follow-up to #1249.

I've tested this against the example output in the spec.

Resolves #949

"type": "string",
"format": "json-pointer"
},
"absoluteKeywordLocation": {
"schemaLocation": {
"type": "string",
"format": "uri"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be iri now?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah I see you're already on it, re the other PR about uri->iri changes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to push this forward as I can't wait on your PR any longer. It needs to be rebased anyway.

"$ref": "#/$defs/outputUnitArray"
}
},
"required": [ "valid", "nested" ]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does the 'basic' format contain 'nested'? My understanding was that basic is still a flat structure.

Copy link
Member Author

@gregsdennis gregsdennis Sep 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basic is an object with only valid and nested at the root. The rest is normal output units in the nested array.

{
  "valid": true,
  "nested": [ <flat list> ]
}

This provides the overall validation result at the root and a flat list. It's the same as 2020-12, except that the location properties aren't required at the root (because they're always just / and redundant).

@gregsdennis gregsdennis marked this pull request as ready for review October 17, 2022 01:12
@gregsdennis gregsdennis merged commit 9665007 into main Oct 17, 2022
@gregsdennis gregsdennis deleted the gregsdennis-update-output-schema branch October 17, 2022 20:48
@karenetheridge
Copy link
Member

Shouldn't this have gone into draft-next, not main?

@gregsdennis
Copy link
Member Author

@karenetheridge draft-next was merged some time ago.

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

Successfully merging this pull request may close these issues.

Some inconsistencies in output schema
3 participants