-
-
Notifications
You must be signed in to change notification settings - Fork 320
Improve guidance on annotations and output #787
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
Conversation
Remove wording that is no longer meaningful now that we have recommended output formats. Also do not use meta-schema as example for relative and absolute paths because my brain broke trying to figure out what it was doing.
This looks fine to me. |
@epicfaace if you have a moment to take a look I'd welcome you're feedback on this PR. |
The default behavior is simply to collect all values in a list in | ||
indeterminate order. Given the extensibility of keywords, including | ||
applicators, it is not possible to define a universally predictable | ||
order of processing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like the spec is moving towards defining rules for handling annotations in overlapping subschemas (as this paragraph is removed, and the wording in readOnly
and writeOnly
show), which is good.
Thanks for pointing me to this. The same logic you mentioned about defaults in #786 (and which is discussed in 7.6.1.1) could be used to argue against, however, the guidance added in this PR about how to handle overlapping annotations, such as:
(For example, what if an implementor would prefer that the value of I'd prefer that the schema be explicit in these cases, as the PR does. My question is this: If it's able to be explicit about handling attributes such as |
@epicfaace for However, Over the course of numerous years on this project, nothing remotely resembling a consensus around
The goal here is to provide the appropriate amount of guidance for a given keyword, not to provide a one-size-fits-all approach to keyword definitions. Some keywords are helped by a recommendation (but you'll note that I weakened them from |
similar changes were made in json-schema-org#787.
similar changes were made in json-schema-org#787.
Fixes #786.
Remove wording that is no longer meaningful now that we have
recommended output formats.
Also do not use meta-schema as example for relative and absolute
paths because my brain broke trying to figure out what it was doing.
Finally, a few tweaks in the output description where I felt it was
a bit confusing- @gregsdennis let me know if these are wrong or if
you feel they're a net negative.