chore: Add OpenAPI Support to e2e.fetchMyKeys API

Merged
AH
7mo ago
+31-17

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
$

Endpoints:

Get E2E Keys

Looking forward to your feedback! 🚀

Summary by CodeRabbit

  • New Features

    • API documentation added for end-to-end key retrieval.

  • Improvements

    • Stronger authentication enforced for e2e key access.
    • Strict, validated responses for key retrieval to improve reliability and type safety.
    • Internal API surface streamlined for clearer endpoint behavior.

Task: ARCH-2011

[COMM-144]