Skip to content

Improve API docs #1332

@mzur

Description

@mzur

Our current API documentation is generated with apidoc. This creates the docs as SPA, which is not good for search engines or AI agents. I'd like to migrate to a Swagger API doc that should be both human and machine-readable, maybe even with interactive docs that can be tested if the user provides an API token. However, I don't want to update all the APIDoc blocks in the code so the new system should work with the existing information (except maybe where the doc in the code is formatted incorrectly).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Medium Priority

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions