github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-23 23:52:05 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #5950] [MERGED] docs: fix out-dated api-key docs about rate-limits #31945

New Issue
Closed
opened 2026-04-17 22:49:12 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-17 22:49:12 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/5950
Author: @ping-maxwell
Created: 11/13/2025
Status: ✅ Merged
Merged: 11/13/2025
Merged by: @himself65

Base: canary ← Head: docs/fix-out-dated-api-key-docs-abt-rate-limits

📝 Commits (2)

  • ee2ad53 docs: fix out-dated api-key docs abt rate-limits
  • 69dd2b0 Merge branch 'canary' into docs/fix-out-dated-api-key-docs-abt-rate-limits

📊 Changes

1 file changed (+39 additions, -7 deletions)

View changed files

📝 docs/content/docs/plugins/api-key.mdx (+39 -7)

📄 Description

Updates the api-key docs regarding rate-limits, also documents how rate-limits apply for get-session requests that use x-api-key.

Linear:
https://linear.app/better-auth/issue/DEV-240/docs-document-api-key-rate-limit-behaviour-when-using-x-api-key

Summary by cubic

Fixes outdated API key rate limit docs and explains how limits apply when sessions are created with x-api-key. Addresses Linear DEV-240.

  • Bug Fixes
    • Clarified where rate limits apply: API key verification and session creation when enableSessionForAPIKeys is on; noted double increment when calling verifyApiKey() and getSession() with x-api-key, with guidance to avoid it.
    • Documented sliding-window behavior and error response (tryAgainIn).
    • Added how to disable rate limits globally or per key, and updated refill/expiration rules.

Written for commit 69dd2b050a. Summary will update automatically on new commits.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/5950 **Author:** [@ping-maxwell](https://github.com/ping-maxwell) **Created:** 11/13/2025 **Status:** ✅ Merged **Merged:** 11/13/2025 **Merged by:** [@himself65](https://github.com/himself65) **Base:** `canary` ← **Head:** `docs/fix-out-dated-api-key-docs-abt-rate-limits` --- ### 📝 Commits (2) - [`ee2ad53`](https://github.com/better-auth/better-auth/commit/ee2ad5360c893f307b1bdb86ec241d3dceb44954) docs: fix out-dated api-key docs abt rate-limits - [`69dd2b0`](https://github.com/better-auth/better-auth/commit/69dd2b050ad7630e15097dbf79cf2d6604addcc2) Merge branch 'canary' into docs/fix-out-dated-api-key-docs-abt-rate-limits ### 📊 Changes **1 file changed** (+39 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/plugins/api-key.mdx` (+39 -7) </details> ### 📄 Description Updates the api-key docs regarding rate-limits, also documents how rate-limits apply for get-session requests that use `x-api-key`. Linear: https://linear.app/better-auth/issue/DEV-240/docs-document-api-key-rate-limit-behaviour-when-using-x-api-key <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Fixes outdated API key rate limit docs and explains how limits apply when sessions are created with x-api-key. Addresses Linear DEV-240. - **Bug Fixes** - Clarified where rate limits apply: API key verification and session creation when enableSessionForAPIKeys is on; noted double increment when calling verifyApiKey() and getSession() with x-api-key, with guidance to avoid it. - Documented sliding-window behavior and error response (tryAgainIn). - Added how to disable rate limits globally or per key, and updated refill/expiration rules. <sup>Written for commit 69dd2b050ad7630e15097dbf79cf2d6604addcc2. Summary will update automatically on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-17 22:49:12 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#31945
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?