chore: Add OpenAPI support for the Rocket.Chat autotranslate translateMessage API

Merged
AH
7mo ago
+87-55

Description:
This PR integrates OpenAPI support into the Rocket.Chat API, migrate of Rocket.Chat API endpoints to the new OpenAPI pattern. The update includes improved API documentation, enhanced type safety, and response validation using AJV.

Key Changes:

  • Implemented the new pattern and added AJV-based JSON schema validation for API.
  • Uses the ExtractRoutesFromAPI utility from the TypeScript definitions to dynamically derive the routes from the endpoint specifications.
  • Enabled Swagger UI integration for this API.
  • Route Methods Chaining for the endpoints.
  • This does not introduce any breaking changes to the endpoint logic.

Issue Reference:
Relates to #34983, part of the ongoing OpenAPI integration effort.

Testing:

  • Verified that the API response schemas are correctly documented in Swagger UI.
  • All tests passed without any breaking changes

Looking forward to your feedback! 🚀

Summary by CodeRabbit

  • New Features

    • Added OpenAPI documentation support for autotranslate endpoints

  • Bug Fixes

    • Improved error handling for translation operations with explicit result validation

  • Chores

    • Modernized API route definition syntax for better maintainability
    • Enhanced API validation with type-safe schema enforcement
    • Updated the translate message operation's return type for improved clarity

COMM-144
Task: ARCH-1994