search

gt-space / servo

Control server software that coordinates actions between all other systems.
0 stars 0 forks source link

API Documentation #6

Open AndrewCarlisleECE opened 8 months ago

AndrewCarlisleECE commented 8 months ago

The API documentation file is empty, and other projects (mainly the GUI project) need to have a reliable API reference for Servo. It should contain:

  1. Each endpoint (ex. /auth), organized in a way that is logical
  2. The accepted methods for that endpoint (ex. POST)
  3. A description of the purpose of the endpoint
  4. The expected request format
  5. Whether it needs authentication first (may be included within request format, or auth header details specified elsewhere and linked to)
  6. The expected response format (including possible errors)

From the point this issue is filled, every new endpoint will need to include API documentation in its pull request.

AndrewCarlisleECE commented 8 months ago

Although old, this issue is still essential and absolutely needs to be completed. Now, let's do an OpenAPI spec instead of just using Markdown. That way it can be imported into Postman and used with other tools.