Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

add rate limiting docs#10

Merged
narthur merged 1 commit intomasterfrom
api-docs
Jun 11, 2025
Merged

add rate limiting docs#10
narthur merged 1 commit intomasterfrom
api-docs

Conversation

@narthur
Copy link
Collaborator

@narthur narthur commented Jun 11, 2025

No description provided.

Copilot AI review requested due to automatic review settings June 11, 2025 10:08
@narthur narthur temporarily deployed to api-docs - docs.tr.com PR #10 June 11, 2025 10:08 — with Render Destroyed
@github-actions
Copy link

User-Visible Improvements

This PR contains 1 user-visible improvement:

  1. Added rate limiting information to the API documentation (Users will now be aware of the rate limits for different API routes, which can help prevent unintentional overuse of the API.)

Last updated: 2025-06-11T10:08:37.523Z

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds new Rate Limiting sections to both API v2 and v1 reference docs.

  • Introduces a “Rate Limiting” heading and table in src/api-v2.md
  • Adds rate limits for both wildcard routes and a specific endpoint in src/api-v1.md

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/api-v2.md Added Rate Limiting section for /api2/* routes
src/api-v1.md Added Rate Limiting section for /api1/* and /api1/me/tasks
Comments suppressed due to low confidence (2)

src/api-v2.md:22

  • Consider adding details on how clients should handle a rate limit breach, e.g., the API returns HTTP 429 with a Retry-After header to indicate when the next request is allowed.
## Rate Limiting

src/api-v1.md:67

  • Clarify how the global /api1/* limit interacts with the more restrictive /api1/me/tasks limit—e.g., is the specific endpoint limit enforced in addition to or instead of the global limit?
| `/api1/*` | 15 minutes | 100 requests |

@narthur narthur merged commit 00a097a into master Jun 11, 2025
4 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants