Feature Request : JSON HyperSchema
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
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
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aaronpk/XRay
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 54/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Similar issues
-
bug-report bug-report-triage customer report
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Codeinwp/tweet-old-post#1177 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 60/100
sonata-project/dev-kit#3119 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
🧠 Admin
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day