Skip to content

Missing API usage guide for api.open.mp #1259

@Trysha-rbrn

Description

@Trysha-rbrn

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions