ML - Provide OpenAPI API documentation and SwaggerUI

[ledsoft]

The backend should provide OpenAPI documentation of the REST API and SwaggerUI to access it online for each instance.

[ledsoft]

/kbss-bot help

[kbss-bot]

SearchIssuesAgent Report 🤖

Most Relevant🔥

• Reference: Provide REST API documentation per instance termit#228
• Content: Currently, the REST API documentation is maintained manually at SwaggerHub. However, this is quite inefficient for two reasons: manual maintenance in a separate place than the source code makes it often outdated, and testing the API is difficult because different instances would require different versions on SwaggerHub. Instead, the documentation should be a part of each deployment of TermIt so that it can be directly tested. Moreover, the documentation of the endpoints would be specified directly in code. Springdoc OpenAPI could be used for this purpose.
• Reason: This issue strongly relates to the need for OpenAPI documentation and SwaggerUI as it highlights the challenges of maintaining documentation in external systems and suggests better integration as requested in the input.

---

Additional Relevant Issues:

• Reference: Implement swagger UI record-manager-ui#259
• Content: Implement swagger UI that will be visible through nginx reverse proxy within deploy/internal-auth and deploy/keycloak-auth. It requires to implement: record-manager backend exposing swagger UI - nginx rules to expose it through the reverse proxy.
• Reason: This describes the implementation of SwaggerUI, which directly involves user interface access to API documentation, aligning with the requirement to provide accessible API documentation mentioned in the input.

---

Note: While other issues relate to Swagger UI functionality, they do not provide direct context or requirements for producing OpenAPI documentation. Thus, they are not included here but indicate a broader context in troubleshooting related components.

📋 Click to see available commands

🤖 Issue Command List

Command	Description
/kbss-bot label	Label the current issue
/kbss-bot summarize	Generates a concise summary of the current issue
/kbss-bot find-similar-issues	Finds similar issues to the given issue
/kbss-bot find-similar-pull-requests	Finds similar pull requests to the given issue
/kbss-bot find-similar-commits	Finds similar commits to the given issue
/kbss-bot find-similar-code	Finds similar code to this issue

[ledsoft]

/kbss-bot find-similar-issues