Include Rate Limit Headers in Project Export API Response
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Description:
The Project Export API endpoint (GET /projects/:id/export/download) currently does not include rate limit headers in its response. This behavior is inconsistent with other API endpoints, such as the Users API, which do include these headers. The inclusion of rate limit headers is crucial for clients to understand their current rate limit status and to handle rate limiting gracefully.
Steps to reproduce
Trigger a request to the Project Export API endpoint: /projects/:id/export/download. Observe the absence of rate limit headers (RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, Retry-After) in the response.
The response from the Project Export API endpoint should include rate limit headers, similar to other endpoints like the Users API. These headers provide essential information about the current rate limit status.However, the response from the Project Export API endpoint does not include any rate limit headers.
The implementation of rate limit headers may require a review of the current setup of the Project Export API, particularly in how it interacts with the rate limiting mechanisms (RackAttack and ApplicationRateLimiter). Ensuring that the endpoint utilizes the appropriate middleware or logic to include these headers in the response would resolve this inconsistency.
This issue impacts clients who rely on rate limit headers to manage their API usage and avoid hitting rate limits unexpectedly. By providing these headers, we can improve the user experience and help clients implement more robust and reliable integrations with our API.