[S2S]: Provide JSON Schema definition and compile tables from them
Open
Nobody has claimed this yet.
ready-for-PR
server-to-server
- Dominant language
- No language data
- Stars
- 125
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
Providing JSON Schemas as a source-of-truth for the Server-to-Server API would be the preferred mechanism for maintaining and visualizing the API. Generated tables will prevent version-skew between the document and the API.
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 locating the current Server-to-Server API definitions and the documentation tables they support. Determine how JSON Schemas can become the source of truth and how the tables would be generated; done means the schemas and generated tables stay aligned without manual version skew.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100