-
-
Notifications
You must be signed in to change notification settings - Fork 183
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 what is JSON Hyper Schema to the Glossary #156
Comments
Hi @benjagm, I would like to work on this issue. Please assign it to me |
Hi @benjagm |
Thanks everyone for your interest. Next time, let make sure everyone waits to receive assignation before you start working on the PR. |
@benjagm can you please assign this to me, I have worked on this before, I would like to continue and apologies for not getting it assigned before. |
@Sanket-0510 let's give @Akshaybagai52 the chance to contribute on this one. |
All yours @Akshaybagai52 . Please see #327 before you start working on this. |
Thanks @benjagm would love to contribute to this |
Hey @benjagm can you tell me what should be the length of the definition in it? |
Ideally something with the same proportion than other definitions in the glossary. |
Okay thanks |
@benjagm JSON Hyper-Schema extends JSON Schema, offering a vocabulary to annotate JSON documents with hypermedia controls. This extension facilitates the description of links and actions that can be executed on JSON data, making it a potent tool for developing hypermedia-driven APIs. Built upon the foundation of JSON Schema, JSON Hyper-Schema introduces additional keywords to specify hyperlinks and instructions for handling remote JSON resources in hypermedia environments like HTTP. The Link Description Object (LDO) is a core concept, encapsulating information about available actions. LDO properties include "rel" (relation type), "href" (URI template), and "templateRequired" (required template variables). The "href" keyword in JSON Hyper-Schema is crucial, allowing the description of URLs using flexible URI templates with variables resolved against instance data. Concepts like "base" establish the URI base for references, aiding in constructing relative URLs. The "links" property associates Link Description Objects with instances, enabling the definition of multiple links and their relations. In conclusion, JSON Hyper-Schema enhances JSON Schema, introducing a vocabulary for hypermedia controls and enabling the creation of more interactive APIs. It provides a structured approach to articulate links and actions on JSON documents, enhancing client understanding and interaction with remote JSON resources. |
@Akshaybagai52 This is a great start! Please create a PR as it will be easier to provide feedback. |
can you review this #367 |
It would be great to add a definition of what is JSON Hyper Schema to the Glossary.
Related: json-schema-org/understanding-json-schema#28
The text was updated successfully, but these errors were encountered: