Giters

Adhalianna / tracke.rs

A flexible task management tool working as a web application

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

As a software developer I can read the tracke.rs API documentation to clear out any doubts I might have about it

Adhalianna opened this issue · comments

commented

Acceptance criteria:

  • Every route (path) handled by the API must be present in the documentation
  • Every type that has constraints or format more specific than the data types supported by the JSON format must be described in the documentation and the expected format/constraints/structure must be mentioned
  • The documentation must be in the form of the OpenAPI Specification (OAS) of version at least 3.0
  • The routes must be grouped (tagged) in such a way that at least the login, registration and task management APIs are separated
  • The server should also provide a service which renders the OAS documentation in a visual form using either Swagger UI or Redoc