[S2S]: JSON object format and introduction
Open
Nobody has claimed this yet.
server-to-server
- Dominant language
- No language data
- Stars
- 125
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
Throughout the spec, tables are being used to describe JSON Object types. This issue is tracking how best to display them, how to introduce re-usable types.
Related topic is using JSON Schema (or other) for a canonical source of truth (#758), but this issue is separately tracking how to display them in-document regardless.
Contributor 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.
Research direction
Start by reviewing the specification sections that currently use tables for JSON Object types and compare the related canonical-source discussion in issue #758. Done means the project has an agreed approach for displaying these objects and introducing reusable types throughout the specification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100