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

Changing property key names in output format #1247

Merged
merged 3 commits into from
Jun 27, 2022

Conversation

gregsdennis
Copy link
Member

This PR is the start of changes to the output format as discussed here.

It covers changing property names:

  • keywordLocation -> evaluationPath
  • absoluteSchemaLocation -> schemaLocation
  • errors/annotations -> nested

(In making these edits, I began to see why so many people were asking for examples with annotations. I expected that to be a trivial exercise given the error examples, but I get it now.)

Copy link
Contributor

@handrews handrews left a comment

Choose a reason for hiding this comment

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

Looks good to me! I'm glad to hear you're thinking about annotation examples :-)

@karenetheridge
Copy link
Member

Like the previous discussion on required->present, I'm opposed to changing the names of things without a really good reason. What makes these names better than the existing ones? "nested" in particular I find to be really vague.

Copy link
Member

@karenetheridge karenetheridge left a comment

Choose a reason for hiding this comment

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

I noticed you didn't update the schema that validates the output formats. It probably needs a bit of work anyway even before changing the spec.

jsonschema-core.xml Show resolved Hide resolved
@gregsdennis
Copy link
Member Author

gregsdennis commented Jun 22, 2022

We have reasons for changing these. They're in the discussion. If we need to change them to something else, then please continue the discussion there. Nothing else has changed there on this topic, so I decided to move forward.

@gregsdennis
Copy link
Member Author

I noticed you didn't update the schema that validates the output formats.

I think I may leave this one for the end. I'll update the examples as I go, though.

@gregsdennis
Copy link
Member Author

Going ahead with merging this. If we want to change nested to something else later, that's easy to do.

@gregsdennis gregsdennis merged commit 0ab50fe into draft-next Jun 27, 2022
@gregsdennis gregsdennis deleted the changing-property-key-names-in-output-format branch June 27, 2022 23:39
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.

3 participants