Missing API usage guide for api.open.mp
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- go
- Domain
- api, documentation
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.
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.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 490
- Avg merge
- 38m
- Merged PRs (30d)
- 4
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing 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.
More from openmultiplayer/web
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
openmultiplayer/web#1272 · 1 reaction ·
-
By hamzaOpen
Difficulty 5/5 Over a week Newbie friendliness 15/100
openmultiplayer/web#1280 · 2 reactions ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
openmultiplayer/web#1269 · 1 reaction ·
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
openmultiplayer/web#1268 · 1 reaction ·
-
DB_Open (newer function; uppercase) links to db_open (older function) in "related functions" sectionOpen
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
openmultiplayer/web#1262 · 5 comments ·
All issues in openmultiplayer/web
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
[Bug] remember() with special characters in namespace hangs until timeout instead of returning 400Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MystenLabs/MemWal#1133 · 1 comment ·
Maintainers usually reply within 1 day
-
bug user-priority/P2
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Effect-TS/effect#8881 · 1 comment ·
Maintainers usually reply within 1 day