`divviup-api` API client and/or documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 10
- Forks
- 5
- Avg merge
- 2h 41m
- Merged PRs (30d)
- 66
Description
Some of our subscribers want to access divviup-api programmatically. To make this easier, we should distribute a client library for that API. Java- or TypeScript are probably a good choice (especially as such a client already mostly exists in divviup-api/app/src/ApiClient.ts), but we'll have to talk to subscribers to see what meets their needs. Or perhaps it will suffice to provide documentation and API specs and let subscribers generate their own clients.
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 with app/src/ApiClient.ts to understand the existing TypeScript client and review the issue's alternatives. Consult subscribers to determine whether a Java or TypeScript client, or API documentation and specifications for generated clients, best meets their needs. Done means delivering the agreed client library or documentation and API specifications.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100