Skip to content

swagger-jsdoc should be replaced #728

@scheidtdav

Description

@scheidtdav

Description

[swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc) has not seen an update in almost 4 years and frequently introduces security vulnerabilites.

We should migrate to a maintained, easy-to-use solution for our api documentation before replacing the current docs.

Use case

Developers need an easy workflow to reduce the amount of work it takes to get good documentation.
Users need good documentation.

Implementation ideas (optional)

TSOA seems like a good fit and leverages the fact that we use typescript, thus reducing the amount of additional work needed.

Additional information (optional)

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions