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 what is JSON Hyper Schema to the Glossary #156

Closed
benjagm opened this issue Oct 13, 2023 · 13 comments · Fixed by #405
Closed

Add what is JSON Hyper Schema to the Glossary #156

benjagm opened this issue Oct 13, 2023 · 13 comments · Fixed by #405
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Oct 13, 2023

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

@sudo-jarvis
Copy link

Hi @benjagm, I would like to work on this issue. Please assign it to me

@benjagm benjagm added the Status: Available No one has claimed responsibility for resolving this issue. label Feb 20, 2024
@Akshaybagai52
Copy link
Contributor

Hi @benjagm
can you assign this issue to me
Thanks

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Feb 23, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Feb 23, 2024

Thanks everyone for your interest. Next time, let make sure everyone waits to receive assignation before you start working on the PR.

@benjagm benjagm moved this from Todo to In Progress in JSON Schema Docs Feb 23, 2024
@benjagm benjagm moved this from In Progress to Ready to Review in JSON Schema Docs Feb 23, 2024
@Sanket-0510
Copy link
Contributor

@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.

@benjagm benjagm moved this from Ready to Review to In Progress in JSON Schema Docs Feb 24, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Feb 24, 2024

@Sanket-0510 let's give @Akshaybagai52 the chance to contribute on this one.

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 24, 2024

Hi @benjagm
can you assign this issue to me
Thanks

All yours @Akshaybagai52 . Please see #327 before you start working on this.

@Akshaybagai52
Copy link
Contributor

Thanks @benjagm would love to contribute to this

@Akshaybagai52
Copy link
Contributor

Hey @benjagm can you tell me what should be the length of the definition in it?

@benjagm
Copy link
Collaborator Author

benjagm commented Feb 26, 2024

what should be the length of the definition in it?

Ideally something with the same proportion than other definitions in the glossary.

@Akshaybagai52
Copy link
Contributor

Refere

Okay thanks

@Akshaybagai52
Copy link
Contributor

@benjagm
can you check this is this good? :-

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.

@jdesrosiers
Copy link
Member

@Akshaybagai52 This is a great start! Please create a PR as it will be easier to provide feedback.

@Akshaybagai52
Copy link
Contributor

@Akshaybagai52 This is a great start! Please create a PR as it will be easier to provide feedback.

can you review this #367
Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants