[PR #7516] docs: add APIMethod documentation for anonymous sign-in endpoint #15616

Open
opened 2026-04-13 10:08:33 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/7516
Author: @ArthurZhang2408
Created: 1/21/2026
Status: 🔄 Open

Base: mainHead: docs/anonymous-api-method


📝 Commits (1)

  • c2c80dc docs: add APIMethod documentation for anonymous sign-in endpoint

📊 Changes

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

View changed files

📝 docs/content/docs/plugins/anonymous.mdx (+25 -3)

📄 Description

Summary

The Anonymous plugin's primary endpoint /sign-in/anonymous was missing proper API documentation. This PR adds:

  • <APIMethod> component for the /sign-in/anonymous POST endpoint (consistent with other plugin docs like email-otp, magic-link)
  • Clear explanation of what the endpoint does
  • Client example with proper error handling showing { data, error } destructuring
  • Example of the returned user object structure
  • Callout note explaining behavior when already signed in as an anonymous user

This aligns the anonymous plugin documentation with other plugins that properly document their endpoints using the <APIMethod> component.

Changes

  • docs/content/docs/plugins/anonymous.mdx: Added comprehensive API documentation for the sign-in endpoint

Summary by cubic

Documented POST /sign-in/anonymous for the Anonymous plugin using the component. Includes a client example with { data, error } handling, a sample returned user object, and a note on errors when already signed in anonymously.

Written for commit c2c80dcd83. Summary will update 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/7516 **Author:** [@ArthurZhang2408](https://github.com/ArthurZhang2408) **Created:** 1/21/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/anonymous-api-method` --- ### 📝 Commits (1) - [`c2c80dc`](https://github.com/better-auth/better-auth/commit/c2c80dcd831198305d1b3e7f5a5206e70e802491) docs: add APIMethod documentation for anonymous sign-in endpoint ### 📊 Changes **1 file changed** (+25 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/plugins/anonymous.mdx` (+25 -3) </details> ### 📄 Description ## Summary The Anonymous plugin's primary endpoint `/sign-in/anonymous` was missing proper API documentation. This PR adds: - `<APIMethod>` component for the `/sign-in/anonymous` POST endpoint (consistent with other plugin docs like email-otp, magic-link) - Clear explanation of what the endpoint does - Client example with proper error handling showing `{ data, error }` destructuring - Example of the returned user object structure - Callout note explaining behavior when already signed in as an anonymous user This aligns the anonymous plugin documentation with other plugins that properly document their endpoints using the `<APIMethod>` component. ## Changes - `docs/content/docs/plugins/anonymous.mdx`: Added comprehensive API documentation for the sign-in endpoint <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Documented POST /sign-in/anonymous for the Anonymous plugin using the <APIMethod> component. Includes a client example with { data, error } handling, a sample returned user object, and a note on errors when already signed in anonymously. <sup>Written for commit c2c80dcd831198305d1b3e7f5a5206e70e802491. Summary will update 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-13 10:08:33 -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#15616