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

Feature Request : JSON HyperSchema #76

Open
sebilasse opened this issue Nov 2, 2018 · 0 comments
Open

Feature Request : JSON HyperSchema #76

sebilasse opened this issue Nov 2, 2018 · 0 comments

Comments

@sebilasse
Copy link

sebilasse commented Nov 2, 2018

This is more an idea referring to
https://blog.apisyouwonthate.com/getting-started-with-json-hyper-schema-184775b91f
https://blog.apisyouwonthate.com/getting-started-with-json-hyper-schema-part-2-ca9d7ffdf6f6
https://blog.apisyouwonthate.com/common-hypermedia-patterns-with-json-hyper-schema-17c78cf884ff

Summing up: About a descriptive and reusable and language independent format to describe e.g. websites (evolved pretty much)
We can tell in a few lines

  • what URLs of what purpose a site has
  • how the parts from https://tools.ietf.org/html/rfc6570 (or user submitted data) map to JSON keys (if different)
  • what constraints are expected
  • completely reusable

See e.g. p3k\XRay\Formats - they describe such sites / services.
If we would describe such stuff (like I currently do) with https://json-schema.org everybody could consume them in a programming language of their choice.
There are additional tools as autobuilding forms for them and validators and so on.

After writing https://github.com/redaktor/ActivityPubSchema I will do the same for e.g. the providers in p3k\XRay\Formats !
How do you think about it ?

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

No branches or pull requests

1 participant