Feature Request : JSON HyperSchema

Open
#76 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
json, php
Domain
api

Research direction

Start by reading the existing provider descriptions in p3k\XRay\Formats and the linked ActivityPubSchema example. The issue proposes describing providers with JSON Hyper-Schema but does not specify a concrete change or acceptance criteria; clarify the scope and expected result with the maintainers before starting.

Written by the indexing model from the issue text.

Description

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 ?

Dominant language
PHP
Stars
96
Forks
17
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aaronpk/XRay

All issues in aaronpk/XRay

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.