Skip to content

API documentation #57

@y21

Description

@y21

Is your feature request related to a problem? Please describe.
API endpoints/HTTP methods are not explained anywhere and the only way to find out is by checking the source code of the API (also undocumented).

Describe the solution you'd like
We should add a simple page explaining all endpoints and its GET parameters / POST data / headers and whatsoever.
Also I want it to be automated, so we would need to store each endpoints' information. Adding a static getter to each module that returns an object with required information should do its job.

Describe alternatives you've considered

  • Document manually by hand

Metadata

Metadata

Assignees

Labels

api v1Relates to the APIenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions