[PR #5273] [MERGED] docs: fix incorrect option for session in API key plugin #22795

Closed
opened 2026-04-15 21:17:17 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/5273
Author: @MatthewSH
Created: 10/13/2025
Status: Merged
Merged: 10/13/2025
Merged by: @Kinfe123

Base: canaryHead: patch-2


📝 Commits (1)

  • b35ba5b docs: fix incorrect option for session in API key plugin

📊 Changes

1 file changed (+3 additions, -3 deletions)

View changed files

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

📄 Description

Happened to notice when upgrading to 1.3.27 but the documentation has the incorrect configuration value of sessionForAPIKeys and also did not update the schema for the new value as well.


Summary by cubic

Fix API key plugin docs to use the correct option name enableSessionForAPIKeys instead of sessionForAPIKeys. Updated the schema entry and description (default false) to match current behavior.


🔄 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/5273 **Author:** [@MatthewSH](https://github.com/MatthewSH) **Created:** 10/13/2025 **Status:** ✅ Merged **Merged:** 10/13/2025 **Merged by:** [@Kinfe123](https://github.com/Kinfe123) **Base:** `canary` ← **Head:** `patch-2` --- ### 📝 Commits (1) - [`b35ba5b`](https://github.com/better-auth/better-auth/commit/b35ba5b792cd7493cd14600278e98e497257a70a) docs: fix incorrect option for session in API key plugin ### 📊 Changes **1 file changed** (+3 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/plugins/api-key.mdx` (+3 -3) </details> ### 📄 Description Happened to notice when upgrading to 1.3.27 but the documentation has the incorrect configuration value of `sessionForAPIKeys` and also did not update the schema for the new value as well. <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Fix API key plugin docs to use the correct option name enableSessionForAPIKeys instead of sessionForAPIKeys. Updated the schema entry and description (default false) to match current behavior. <!-- 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-15 21:17:17 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#22795