Skip to content

[refactor] Move Swagger API documentation from types to swagger #26

@evdmatvey

Description

@evdmatvey

Summary

Move API documentation currently defined in TypeScript types inside modules to proper Swagger folders.
This improves maintainability and ensures consistent documentation

Problem / Motivation

Currently, API descriptions are embedded in TypeScript types, which is illogical, as it does not match the direct types of a specific module

Proposed Solution

  • Identify all API types that contain documentation (e.g., response types, request bodies)
  • Replace current swagger documentation
  • Verify that Swagger UI displays all endpoints correctly

Type of Change

  • Bug
  • Feature
  • Refactor
  • Enhancement
  • Chore
  • Test
  • Docs
  • Breaking change

Metadata

Metadata

Assignees

Labels

in progressFeature or request in progressrefactorCode restructuring without changing existing behavior

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions