SORMAS-Foundation
Extend API swagger documentation
Problem Description
The API swagger documentation is relative hard to use for new developers and people interested in interfacing with SORMAS.
Proposed Change
Extend swagger documentation with descriptive text that explains what an endpoint is used for, which parameters it accepts and what they are doing. Provide examples for data structures for requests and response.
Acceptance Criteria
The swagger documentation is extended with tags that either contian explanatory texts or are marked "tbd" for future expansion.
Implementation Details
Additional Information
Currently being developed, opened issue to be referenced in the pull request.
I kindly want to draw your attention to https://github.com/hzi-braunschweig/SORMAS-Project/issues/11175 . There is a great chance that openapi doc generation will stop working at some point in the future.
You should consider using Apidog, as it's very user-friendly, especially for beginners. It's easy to get started with and provides a great user experience.
