openmultiplayer / openmultiplayer/web
Missing API usage guide for api.open.mp
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 141
- Forks
- 487
- PR merge metrics
- No merged PRs in 30d
Description
Following up on the comments in #1222:
It seems the cooool9 was actually asking about documentation for the backend API located at api.open.mp (which the CJ bot uses), not the frontend docs.
Currently, there is no public usage guide for these backend endpoints (app/transports/api). Developers have to manually read the Go source code to figure out the routes (like /v2/servers).
Suggestion:
We should at least add a basic README.md in the app/transports/api folder outlining the main endpoints.
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 in app/transports/api and read the Go source to identify the backend routes, including /v2/servers. Add a basic README.md in that folder describing the main endpoints and how developers can use them; the issue is done when the public guide covers the relevant routes without requiring source-code inspection.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100