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

Add validation result and JSON pointer in the glossary #677

Merged
merged 7 commits into from
May 2, 2024

Conversation

starlightknown
Copy link
Contributor

@starlightknown starlightknown commented Apr 25, 2024

What kind of change does this PR introduce?
As discussed in the issue. This PR adds two very similar sections to the glossary section.

Issue Number:

Screenshots/videos:

If relevant, did you update the documentation?

Summary

This PR is a part of the individual PR's getting created for completing the glossary page.

Does this PR introduce a breaking change?
no

@starlightknown starlightknown requested a review from a team as a code owner April 25, 2024 11:32
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

@@ -55,6 +55,10 @@ The essence of JSON Hyper-Schema lies in its ability to define links and actions

In other words, JSON Hyper-Schema extends JSON Schema by introducing features for creating hypermedia controls. This facilitates the creation of interactive APIs and ensures compatibility with existing JSON HTTP APIs, maintaining a seamless integration. It adds a layer of interactivity to JSON documents, making it easier to interact with remote JSON resources.

### JSON pointer

JSON Pointer is a format for data exchange between systems, defining a string for accessing and modifying values within a JSON document. By using JSON Pointer, we can precisely reference and retrieve specific values within a JSON document. The [subschema](#subschema) is typically identified via a JSON Pointer, or equivalent syntax, allowing for targeted validation and manipulation of data within the JSON document.
Copy link
Member

Choose a reason for hiding this comment

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

It'd be good to link to the JSON Pointer spec (RFC 6901).

Also, JSON Pointer merely identifies a location within a document. It doesn't (itself) access or modify values, though it is used by other standards to accomplish those tasks.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for adding the link, but the rest has not been addressed. JSON Pointer does not modify documents. It only serves to indicate a location within a document.

Copy link
Member

@gregsdennis gregsdennis left a comment

Choose a reason for hiding this comment

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

Much better. Thank you.

Would like another pair of eyes on this from the team.

pages/learn/glossary.md Outdated Show resolved Hide resolved
pages/learn/glossary.md Outdated Show resolved Hide resolved
pages/learn/glossary.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

Looks great to me!

@gregsdennis
Copy link
Member

I'm going to take this as is. If we want to improve upon it later, we can open a new PR.

@gregsdennis gregsdennis merged commit 8bf72d1 into json-schema-org:main May 2, 2024
2 checks passed
@starlightknown starlightknown deleted the new-terms branch May 3, 2024 07:17
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.

None yet

5 participants