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

Fixes #1402: clarify readOnly applies to any value, not just properties #1522

Conversation

DavidBiesack
Copy link
Contributor

@DavidBiesack DavidBiesack commented Jun 19, 2024

clarify that readOnly applies to any value, not just properties.
Re-format true and false code values

Resolves #1402

…ot just properties). Format `true` and `false` code values
Copy link
Member

@jdesrosiers jdesrosiers left a comment

Choose a reason for hiding this comment

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

Thanks for doing this and for taking the time to do the additional cleanup.

@@ -1,4 +1,4 @@
# JSON Schema Validation: A Vocabulary for Structural Validation of JSON
e# JSON Schema Validation: A Vocabulary for Structural Validation of JSON
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
e# JSON Schema Validation: A Vocabulary for Structural Validation of JSON
# JSON Schema Validation: A Vocabulary for Structural Validation of JSON

instance is managed exclusively by the owning authority, and attempts by an
application to modify the value of this property are expected to be ignored or
application to modify the value of an instance are expected to be ignored or
Copy link
Member

Choose a reason for hiding this comment

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

When I read "an instance" my mind went to the "the entire JSON document", which isn't the intention. I think "instance" can be used to refer to a fragment of a JSON document, but we usually don't use it that way so this might be confusing.

What if we just leave it at "the value" and drop the "of" part entirely? Or we could say "that value within an instance"?

Copy link
Member

Choose a reason for hiding this comment

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

or "the local instance"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

how about :

If `readOnly` has a value of boolean `true`, it indicates that the
corresponding value in the instance is
managed exclusively by the owning authority, and attempts by an
application to modify the value are expected to be ignored or
rejected by that owning authority.

@DavidBiesack
Copy link
Contributor Author

is his ready to merge? I'm not sure how to reset the "PR Policy / Require Minimum Open Time (pull_request)" check

@gregsdennis
Copy link
Member

We can rerun it from our end, but you can also close then reopen the PR.

It'll fail if the PR hasn't been open for two weeks. It's a policy we've had in place for a long time.

@jdesrosiers jdesrosiers merged commit 53ad7d6 into json-schema-org:main Jul 10, 2024
1 of 2 checks passed
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.

description of readOnly is ambiguous and refers to property when it should be instance
3 participants