[Task] docs: add api schema
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Elixir
- Stars
- 5
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
What should be done
We should add an api schema for develloppers that describes the requests our server makes to the application and what it expects:
- format of a normal return
- error format
- ...
Contributor guide
No contributing guide indexed for this repository
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 identifying the server-to-application request boundary and any existing conventions for normal and error responses. Define the API schema for the requests, normal returns, and error format described in the issue; the work is done when these interactions are documented for developers.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100