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

Docs: provide API Reference #1685

New Issue
Closed
opened 2026-03-13 08:55:54 -05:00 by GiteaMirror · 5 comments
GiteaMirror commented 2026-03-13 08:55:54 -05:00
Owner
Copy Link

Originally created by @julen on GitHub (Aug 12, 2025).

Originally assigned to: @ping-maxwell on GitHub.

Is this suited for github?

  • Yes, this is suited for github

Is your feature request related to a problem? Please describe.

No response

Describe the solution you'd like

Hi folks 👋

First of all, thank you for your work on this great library!

I'd like to request the addition of API reference documentation; this was already mentioned at https://github.com/better-auth/better-auth/issues/690, but opening a new issue was suggested, which is what I'm doing here.

It would be extremely helpful to have a section either in the docs or as a standalone reference that lists all possible properties, methods, and options for the main functions in better-auth (both client- and server-side), along with descriptions for each. There is already https://www.better-auth.com/docs/reference/options, but that only covers part of the API surface. Having a full reference would make it easier for developers to understand the full capabilities of the library and use it more effectively.

Thanks again for your time and considering this request.

Describe alternatives you've considered

Browsing the source code.

Additional context

No response

Originally created by @julen on GitHub (Aug 12, 2025). Originally assigned to: @ping-maxwell on GitHub. ### Is this suited for github? - [x] Yes, this is suited for github ### Is your feature request related to a problem? Please describe. _No response_ ### Describe the solution you'd like Hi folks 👋 First of all, thank you for your work on this great library! I'd like to request the addition of API reference documentation; this was already mentioned at https://github.com/better-auth/better-auth/issues/690, but [opening a new issue was suggested](https://github.com/better-auth/better-auth/issues/690#issuecomment-2510238859), which is what I'm doing here. It would be extremely helpful to have a section either in the docs or as a standalone reference that lists all possible properties, methods, and options for the main functions in better-auth (both client- and server-side), along with descriptions for each. There is already https://www.better-auth.com/docs/reference/options, but that only covers part of the API surface. Having a full reference would make it easier for developers to understand the full capabilities of the library and use it more effectively. Thanks again for your time and considering this request. ### Describe alternatives you've considered Browsing the source code. ### Additional context _No response_
GiteaMirror added the documentation label 2026-03-13 08:55:54 -05:00
GiteaMirror commented 2026-03-13 08:55:55 -05:00
Author
Owner
Copy Link

@dosubot[bot] commented on GitHub (Nov 11, 2025):

Hi, @julen. I'm Dosu, and I'm helping the better-auth team manage their backlog and am marking this issue as stale.

Issue Summary:

  • You requested comprehensive API reference documentation for the better-auth library.
  • The request includes all properties, methods, and options for both client- and server-side functions.
  • You noted that the existing documentation is incomplete.
  • No further activity or comments have been made on this issue so far.

Next Steps:

  • Please let me know if this issue is still relevant with the latest version of better-auth by commenting here.
  • If I don’t hear back within 7 days, I will automatically close this issue.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Nov 11, 2025): Hi, @julen. I'm [Dosu](https://dosu.dev), and I'm helping the better-auth team manage their backlog and am marking this issue as stale. **Issue Summary:** - You requested comprehensive API reference documentation for the better-auth library. - The request includes all properties, methods, and options for both client- and server-side functions. - You noted that the existing documentation is incomplete. - No further activity or comments have been made on this issue so far. **Next Steps:** - Please let me know if this issue is still relevant with the latest version of better-auth by commenting here. - If I don’t hear back within 7 days, I will automatically close this issue. Thank you for your understanding and contribution!
GiteaMirror commented 2026-03-13 08:55:56 -05:00
Author
Owner
Copy Link

@julen commented on GitHub (Nov 11, 2025):

@dosubot this is still relevant, thanks!

@julen commented on GitHub (Nov 11, 2025): @dosubot this is still relevant, thanks!
GiteaMirror commented 2026-03-13 08:55:56 -05:00
Author
Owner
Copy Link

@ping-maxwell commented on GitHub (Nov 18, 2025):

Would the OpenAPI plugin satisfy your needs?
It would show you all endpoints, methods, descriptions and anything along those lines based off of your auth config.

https://www.better-auth.com/docs/plugins/open-api

@ping-maxwell commented on GitHub (Nov 18, 2025): Would the OpenAPI plugin satisfy your needs? It would show you all endpoints, methods, descriptions and anything along those lines based off of your auth config. https://www.better-auth.com/docs/plugins/open-api
GiteaMirror commented 2026-03-13 08:55:56 -05:00
Author
Owner
Copy Link

@julen commented on GitHub (Nov 18, 2025):

That's a fair point and an alternative worth being aware of. That said, as a developer, having that reference directly baked in the docs site would be a better DX, which wouldn't require installing the library or configuring anything. I understand it's a bit more work for maintainers, but I'd be inclined to think that aligns with most developers' expectations.

@julen commented on GitHub (Nov 18, 2025): That's a fair point and an alternative worth being aware of. That said, as a developer, having that reference directly baked in the docs site would be a better DX, which wouldn't require installing the library or configuring anything. I understand it's a bit more work for maintainers, but I'd be inclined to think that aligns with most developers' expectations.
GiteaMirror commented 2026-03-13 08:55:57 -05:00
Author
Owner
Copy Link

@julen commented on GitHub (Jan 19, 2026):

Hey @ping-maxwell, I just noticed the issue was closed as not planned and wanted to ask if you could share a bit more on the reasoning behind the decision. Was it considered out-of-scope for the project, or are there concerns around maintaining API docs?

If there's room for reconsideration and if OpenAPI plugin you linked above should do, from a DX perspective it'd be great if better-auth could host a public copy. Thanks again!

@julen commented on GitHub (Jan 19, 2026): Hey @ping-maxwell, I just noticed the issue was closed as not planned and wanted to ask if you could share a bit more on the reasoning behind the decision. Was it considered out-of-scope for the project, or are there concerns around maintaining API docs? If there's room for reconsideration and if [OpenAPI plugin you linked above](https://github.com/better-auth/better-auth/issues/3946#issuecomment-3546283560) should do, from a DX perspective it'd be great if better-auth could host a public copy. Thanks again!
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 documentation
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#1685
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?