Skip to content

[docs] - Swagger Open API documentation #19

Description

@dave-ok

Description

To enable end users/API consumers know available endpoints, relevant parameters, valid data and their types, url and request methods we need a documentation for the API.

This API documentation will be generated using swagger tools, particularly swagger-jsdoc and swagger-ui-express and will be hosted on /api-docs. Alternative API documentation tools can be used.

Support Articles:

Metadata

Metadata

Assignees

No one assigned

    Labels

    back-endBackend IssuesdocumentationImprovements or additions to documentationfeatureA new feature

    Type

    No type

    Fields

    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