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

[GH-ISSUE #1493] OpenAPI Schema should include 'summary' field #8787

New Issue
Open
opened 2026-04-13 03:59:28 -05:00 by GiteaMirror · 9 comments
GiteaMirror commented 2026-04-13 03:59:28 -05:00
Owner
Copy Link

Originally created by @platform-kit on GitHub (Feb 19, 2025).
Original GitHub issue: https://github.com/better-auth/better-auth/issues/1493

Originally assigned to: @bytaesu on GitHub.

Is this suited for github?

  • Yes, this is suited for github

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

The OpenAPI schema generated by generateOpenAPISchema creates OpenAPI route definitions without a summary field, which forces Scalar / whatever OpenAPI GUI you're using to use the api route for the name. These names can be quite long, not fitting within the standard sidebar of Scalar/ etc.

Describe the solution you'd like

The schema should include short summaries of each route in the form of a summary field on the OpenAPI route definition.

Describe alternatives you've considered

Manually overwriting the auto-generated schema is a huge PITA.

Additional context

No response

Originally created by @platform-kit on GitHub (Feb 19, 2025). Original GitHub issue: https://github.com/better-auth/better-auth/issues/1493 Originally assigned to: @bytaesu on GitHub. ### Is this suited for github? - [x] Yes, this is suited for github ### Is your feature request related to a problem? Please describe. The OpenAPI schema generated by `generateOpenAPISchema` creates OpenAPI route definitions without a `summary` field, which forces Scalar / whatever OpenAPI GUI you're using to use the api route for the name. These names can be quite long, not fitting within the standard sidebar of Scalar/ etc. ### Describe the solution you'd like The schema should include short summaries of each route in the form of a `summary` field on the OpenAPI route definition. ### Describe alternatives you've considered Manually overwriting the auto-generated schema is a huge PITA. ### Additional context _No response_
GiteaMirror added the devtools label 2026-04-13 03:59:28 -05:00
GiteaMirror commented 2026-04-13 03:59:29 -05:00
Author
Owner
Copy Link

@dosubot[bot] commented on GitHub (Jun 12, 2025):

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

Issue Summary:

  • You requested an enhancement to add a summary field to the OpenAPI schema generated by generateOpenAPISchema.
  • The goal is to improve readability in OpenAPI GUIs by providing concise descriptions for each route.
  • This addresses the problem of clutter caused by long route names.
  • You emphasized the difficulty of manually editing the schema and seek an automated solution.
  • There have been no comments or developments on this issue yet.

Next Steps:

  • Please let me know if this issue is still relevant to the latest version of the better-auth repository by commenting on the issue.
  • If there is no response, the issue will be automatically closed in 7 days.

Thank you for your understanding and contribution!

<!-- gh-comment-id:2967418723 --> @dosubot[bot] commented on GitHub (Jun 12, 2025): Hi, @platform-kit. I'm [Dosu](https://dosu.dev), and I'm helping the better-auth team manage their backlog. I'm marking this issue as stale. **Issue Summary:** - You requested an enhancement to add a `summary` field to the OpenAPI schema generated by `generateOpenAPISchema`. - The goal is to improve readability in OpenAPI GUIs by providing concise descriptions for each route. - This addresses the problem of clutter caused by long route names. - You emphasized the difficulty of manually editing the schema and seek an automated solution. - There have been no comments or developments on this issue yet. **Next Steps:** - Please let me know if this issue is still relevant to the latest version of the better-auth repository by commenting on the issue. - If there is no response, the issue will be automatically closed in 7 days. Thank you for your understanding and contribution!
GiteaMirror commented 2026-04-13 03:59:29 -05:00
Author
Owner
Copy Link

@platform-kit commented on GitHub (Jun 16, 2025):

This is still relevant.

<!-- gh-comment-id:2977693553 --> @platform-kit commented on GitHub (Jun 16, 2025): This is still relevant.
GiteaMirror commented 2026-04-13 03:59:30 -05:00
Author
Owner
Copy Link

@dosubot[bot] commented on GitHub (Sep 15, 2025):

Hi, @platform-kit. 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 adding a 'summary' field to the OpenAPI schema generated by generateOpenAPISchema for concise route descriptions.
  • This addition aims to improve readability in OpenAPI GUIs like Scalar.
  • The issue was previously marked as stale due to inactivity.
  • You confirmed the issue is still relevant but there have been no further updates or developments.

Next Steps:

  • Please let me know if this feature request is still relevant to the latest version of better-auth by commenting on this issue.
  • If I do not hear back within 7 days, the issue will be automatically closed.

Thank you for your understanding and contribution!

<!-- gh-comment-id:3292901867 --> @dosubot[bot] commented on GitHub (Sep 15, 2025): Hi, @platform-kit. 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 adding a 'summary' field to the OpenAPI schema generated by `generateOpenAPISchema` for concise route descriptions. - This addition aims to improve readability in OpenAPI GUIs like Scalar. - The issue was previously marked as stale due to inactivity. - You confirmed the issue is still relevant but there have been no further updates or developments. **Next Steps:** - Please let me know if this feature request is still relevant to the latest version of better-auth by commenting on this issue. - If I do not hear back within 7 days, the issue will be automatically closed. Thank you for your understanding and contribution!
GiteaMirror commented 2026-04-13 03:59:30 -05:00
Author
Owner
Copy Link

@platform-kit commented on GitHub (Sep 15, 2025):

still relevant!

<!-- gh-comment-id:3294080528 --> @platform-kit commented on GitHub (Sep 15, 2025): still relevant!
GiteaMirror commented 2026-04-13 03:59:30 -05:00
Author
Owner
Copy Link

@dosubot[bot] commented on GitHub (Dec 15, 2025):

Hi, @platform-kit. 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 adding a summary field for each route in the OpenAPI schema generated by generateOpenAPISchema.
  • The goal is to improve readability in OpenAPI GUIs like Scalar by providing concise, descriptive route names.
  • This issue has been marked stale twice previously but you have confirmed it remains relevant.
  • No further updates or progress have been made on this enhancement request so far.

Next Steps:

  • Please let me know if this enhancement is still relevant for the latest version of better-auth by commenting on this issue.
  • If I do not hear back within 7 days, I will automatically close the issue.

Thank you for your understanding and contribution!

<!-- gh-comment-id:3656469458 --> @dosubot[bot] commented on GitHub (Dec 15, 2025): Hi, @platform-kit. 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 adding a `summary` field for each route in the OpenAPI schema generated by `generateOpenAPISchema`. - The goal is to improve readability in OpenAPI GUIs like Scalar by providing concise, descriptive route names. - This issue has been marked stale twice previously but you have confirmed it remains relevant. - No further updates or progress have been made on this enhancement request so far. **Next Steps:** - Please let me know if this enhancement is still relevant for the latest version of better-auth by commenting on this issue. - If I do not hear back within 7 days, I will automatically close the issue. Thank you for your understanding and contribution!
GiteaMirror commented 2026-04-13 03:59:31 -05:00
Author
Owner
Copy Link

@platform-kit commented on GitHub (Dec 15, 2025):

Still relevant...

<!-- gh-comment-id:3656981988 --> @platform-kit commented on GitHub (Dec 15, 2025): Still relevant...
GiteaMirror commented 2026-04-13 03:59:31 -05:00
Author
Owner
Copy Link

@bytaesu commented on GitHub (Jan 15, 2026):

Hi @platform-kit,

In Better Auth, endpoint names are meaningful as they're used in authClient. Maintaining summaries for each endpoint may not add much value compared to the upkeep cost.

When I talking with users on Discord, they sometimes check the endpoints using the OpenAPI plugin, which lets you view them easily in the sidebar!

<!-- gh-comment-id:3757157559 --> @bytaesu commented on GitHub (Jan 15, 2026): Hi @platform-kit, In Better Auth, endpoint names are meaningful as they're used in authClient. Maintaining summaries for each endpoint may not add much value compared to the upkeep cost. When I talking with users on Discord, they sometimes check the endpoints using the OpenAPI plugin, which lets you view them easily in the sidebar!
GiteaMirror commented 2026-04-13 03:59:32 -05:00
Author
Owner
Copy Link

@platform-kit commented on GitHub (Jan 16, 2026):

@bytaesu Right, I am talking about that use case. The problem is that since better-auth's endpoint names are sometimes quite long, they do not fit well within the UI of most OpenAPI / Swagger UI's. The sidebar is usually not wide enough to accomodate the long names. However most UI's (such as Scalar) will show the summary field as a human-readable label for the endpoint, which means they can be given names with a practical length that doesn't break the UI.

That's what I'm asking for, it is a huge pain in the ass to not be able to read the documentation, whenever I implement better-auth on an app where I'm using Scalar or similar tooling to auto-publish API documentation. Your naming conventions break my docs.

<!-- gh-comment-id:3758510029 --> @platform-kit commented on GitHub (Jan 16, 2026): @bytaesu Right, I am talking about that use case. The problem is that since better-auth's endpoint names are sometimes quite long, they do not fit well within the UI of most OpenAPI / Swagger UI's. The sidebar is usually not wide enough to accomodate the long names. However most UI's (such as Scalar) will show the `summary` field as a human-readable label for the endpoint, which means they can be given names with a practical length that doesn't break the UI. That's what I'm asking for, it is a huge pain in the ass to not be able to read the documentation, whenever I implement better-auth on an app where I'm using Scalar or similar tooling to auto-publish API documentation. Your naming conventions break my docs.
GiteaMirror commented 2026-04-13 03:59:32 -05:00
Author
Owner
Copy Link

@ping-maxwell commented on GitHub (Mar 25, 2026):

Hello, I've put this under the 1.6 milestone. It's possible this will be rolled over to future milestones given it's low priority state and depends on timelines & how busy we are.

<!-- gh-comment-id:4124797537 --> @ping-maxwell commented on GitHub (Mar 25, 2026): Hello, I've put this under the 1.6 milestone. It's possible this will be rolled over to future milestones given it's low priority state and depends on timelines & how busy we are.
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 devtools
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#8787
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?