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

[PR #477] [CLOSED] feat: api endpoint documentation #3318

New Issue
Closed
opened 2026-03-13 10:48:54 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-03-13 10:48:54 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/477
Author: @LovelessCodes
Created: 11/9/2024
Status: ❌ Closed

Base: main ← Head: feature/api-docs

📝 Commits (2)

  • e3195c1 added: scalar package to docs
  • 89ef8a7 feat: new references route with openapi spec

📊 Changes

4 files changed (+1656 additions, -70 deletions)

View changed files

➕ docs/app/reference/route.ts (+9 -0)
📝 docs/package.json (+1 -0)
➕ docs/public/openapi.yml (+1341 -0)
📝 pnpm-lock.yaml (+305 -70)

📄 Description

Summary

This PR enhances the documentation for API endpoints using Scalar to provide clear, organized, and user-friendly information.

Key Changes

Scalar Integration: Introduced Scalar to display API endpoints with detailed descriptions, examples, method types, and parameters.

Benefits

Improved Usability: Easier for users to understand and implement API endpoints.
Increased Adoption: Facilitates library adoption by new users through clear, comprehensive endpoint documentation.

🔄 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/477 **Author:** [@LovelessCodes](https://github.com/LovelessCodes) **Created:** 11/9/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `feature/api-docs` --- ### 📝 Commits (2) - [`e3195c1`](https://github.com/better-auth/better-auth/commit/e3195c1bea77584deece95d4842b775a429649b4) added: scalar package to docs - [`89ef8a7`](https://github.com/better-auth/better-auth/commit/89ef8a7f8a37d0a7d064783974debce9a09bf9df) feat: new references route with openapi spec ### 📊 Changes **4 files changed** (+1656 additions, -70 deletions) <details> <summary>View changed files</summary> ➕ `docs/app/reference/route.ts` (+9 -0) 📝 `docs/package.json` (+1 -0) ➕ `docs/public/openapi.yml` (+1341 -0) 📝 `pnpm-lock.yaml` (+305 -70) </details> ### 📄 Description ### Summary This PR enhances the documentation for API endpoints using Scalar to provide clear, organized, and user-friendly information. ### Key Changes **Scalar Integration**: Introduced Scalar to display API endpoints with detailed descriptions, examples, method types, and parameters. ### Benefits **Improved Usability**: Easier for users to understand and implement API endpoints. **Increased Adoption**: Facilitates library adoption by new users through clear, comprehensive endpoint documentation. --- <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-03-13 10:48:54 -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#3318
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?