Skip to content

[APES-1818] Document rate-limit metadata tags and window queries - #41501

Open
raymondyou97 wants to merge 2 commits into
masterfrom
raymond-you/ratelimit-tag-docs
Open

raymondyou97 wants to merge 2 commits into
masterfrom
raymond-you/ratelimit-tag-docs

Conversation

@raymondyou97

@raymondyou97 raymondyou97 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Documents the limit_count and limit_period tags used to query configured requests per window. Includes an example metric query grouped by period and explains tag availability and historical-data limitations. Retains separate metric families for allowed and blocked requests and child_org_name for child-organization views, without introducing redundant tags.

No prebuilt dashboard changes are required. The example query is for customers' own metric exploration and visualizations; it does not introduce a new section in the integration dashboard.

Merge readiness

  • Ready for merge
  • Confirm the documented tags are available in each target site before publishing.

AI assistance

Pi assisted with the content update, source comparison, and validation.

Additional notes

  • Updates the live Astro API documentation source; translated and retired Hugo copies are unchanged.
  • Markdoc parsing and validation against the repository schema pass.
  • Vale reports no new findings compared with the unchanged page (five existing warnings and four existing suggestions).
  • Repository pre-commit checks pass.
  • No production site build or publication was performed.

Describe tag availability, configured request limits per window, child-organization compatibility, and migration of status filters. Keep publication pending availability of the documented tags.
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

No changed files under hugo/content/en/, e.g. this PR only touches the Astro API docs app:

Use separate metric families for allowed and blocked requests and child_org_name for child organizations. Document only the restored count and period metadata.
@raymondyou97
raymondyou97 marked this pull request as ready for review November 6, 2026 21:00
@raymondyou97
raymondyou97 requested a review from a team as a code owner November 6, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant