Skip to content

Improve Rate Limiting docs for Hive Gateway#107

Merged
ardatan merged 3 commits into
mainfrom
copilot/improve-rate-limiting-docs
May 7, 2026
Merged

Improve Rate Limiting docs for Hive Gateway#107
ardatan merged 3 commits into
mainfrom
copilot/improve-rate-limiting-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

The rate limiting page had a single minimal example, no guidance for multi-instance deployments, and incomplete directive field docs with broken external links.

Changes

  • Introduction: explains why field-level rate limiting matters in GraphQL; upfront callout about in-memory (per-instance) vs. distributed limits
  • Programmatic config: concrete sub-sections for auth token, IP address, and multiple rules; typed options reference table replacing inline comments
  • @rateLimit directive: restructured as a 3-step guide; added identityArgs (per-argument limiting) and arrayLengthField (bulk operations) examples; replaced bullet list with typed field reference table
  • Distributed rate limiting: new section showing how to pair the cache.type: "redis" option with rateLimiting to enforce limits consistently across gateway instances

Copilot AI and others added 2 commits May 6, 2026 14:42
…section, and field reference tables

Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/8035d318-a1c3-4605-b812-3b4bbec969ba

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
@ardatan ardatan requested a review from enisdenjo May 6, 2026 14:52
@ardatan ardatan marked this pull request as ready for review May 6, 2026 14:53
Copilot AI review requested due to automatic review settings May 6, 2026 14:53
Copilot AI temporarily deployed to storybook-preview May 6, 2026 14:53 Inactive
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

@ardatan
Copy link
Copy Markdown
Member

ardatan commented May 6, 2026

@copilot fix lint errors

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 6, 2026

@copilot fix lint errors

Fixed in e9c039c — ran oxfmt to resolve the table alignment and GraphQL directive formatting issues.

Copilot finished work on behalf of ardatan May 6, 2026 15:03
Copilot AI requested a review from ardatan May 6, 2026 15:03
Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 6, 2026

@copilot fix lint errors

Fixed in e9c039c. The oxfmt --check step was failing due to unformatted table columns and a GraphQL directive argument. Applied oxfmt to align the table columns and reformat the multiline @rateLimit directive.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • www.npmjs.com
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@ardatan ardatan merged commit 72ec7d1 into main May 7, 2026
9 checks passed
@ardatan ardatan deleted the copilot/improve-rate-limiting-docs branch May 7, 2026 09:51
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.

3 participants