[PR #2107] [MERGED] fix(openapi): add operationIds to routes #21058

Closed
opened 2026-04-15 20:05:48 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/2107
Author: @thomasmol
Created: 4/3/2025
Status: Merged
Merged: 11/15/2025
Merged by: @Bekacru

Base: mainHead: fix/generate-valid-openapi-schema


📝 Commits (10+)

📊 Changes

21 files changed (+152 additions, -126 deletions)

View changed files

📝 packages/better-auth/src/api/routes/account.ts (+2 -0)
📝 packages/better-auth/src/api/routes/callback.ts (+1 -0)
📝 packages/better-auth/src/api/routes/email-verification.ts (+4 -40)
📝 packages/better-auth/src/api/routes/reset-password.ts (+26 -0)
📝 packages/better-auth/src/api/routes/session.ts (+4 -0)
📝 packages/better-auth/src/api/routes/sign-in.ts (+14 -71)
📝 packages/better-auth/src/api/routes/sign-out.ts (+2 -0)
📝 packages/better-auth/src/api/routes/sign-up.ts (+2 -0)
📝 packages/better-auth/src/api/routes/update-user.ts (+38 -3)
📝 packages/better-auth/src/plugins/admin/admin.ts (+1 -1)
📝 packages/better-auth/src/plugins/email-otp/index.ts (+14 -7)
📝 packages/better-auth/src/plugins/jwt/index.ts (+2 -0)
📝 packages/better-auth/src/plugins/magic-link/index.ts (+2 -0)
📝 packages/better-auth/src/plugins/oauth-proxy/index.ts (+2 -0)
📝 packages/better-auth/src/plugins/oidc-provider/index.ts (+6 -1)
📝 packages/better-auth/src/plugins/open-api/generator.ts (+15 -2)
📝 packages/better-auth/src/plugins/organization/routes/crud-invites.ts (+3 -1)
📝 packages/better-auth/src/plugins/organization/routes/crud-members.ts (+5 -0)
📝 packages/better-auth/src/plugins/organization/routes/crud-org.ts (+2 -0)
📝 packages/better-auth/src/plugins/passkey/index.ts (+4 -0)

...and 1 more files

📄 Description

Fixes #2097

This pull request introduces several changes to the packages/better-auth module, primarily focusing on adding operationId fields to various API endpoints and correcting OpenAPI schema references. These changes enhance the API documentation and ensure consistency across the endpoints.

  • Added operationId fields to multiple API endpoints, including plugins
  • Corrected OpenAPI schema references from ref to $ref:
    • verifyEmail in email-verification.ts
    • signInSocial in sign-in.ts
    • signInEmail in sign-in.ts
    • updateUser in update-user.ts
    • changeEmail in update-user.ts
  • Added the parameter definition for the reset-password/:token endpoint
  • Added openapi metadata for the delete-user endpoint to fix the required: [] invalid schema
  • Force include Session table in openapi schema
  • Change OpenAPI type generation for type: date to type: string \n format: date-time

🔄 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/2107 **Author:** [@thomasmol](https://github.com/thomasmol) **Created:** 4/3/2025 **Status:** ✅ Merged **Merged:** 11/15/2025 **Merged by:** [@Bekacru](https://github.com/Bekacru) **Base:** `main` ← **Head:** `fix/generate-valid-openapi-schema` --- ### 📝 Commits (10+) - [`6612360`](https://github.com/better-auth/better-auth/commit/661236025a5a6ae38f0a4631d10a86299b6d70bf) fix date formatting and schema referencing in openapi definitions - [`31ddbaf`](https://github.com/better-auth/better-auth/commit/31ddbafb96e4b98352a31c0011a1fbab101a8e9b) fix session table omission in openapi schema - [`c190535`](https://github.com/better-auth/better-auth/commit/c1905358d53b084f2578471ee149840b4ba00bba) fix request body schema for delete user - [`7229547`](https://github.com/better-auth/better-auth/commit/7229547ff9c3db84f53cb927ec1308cd346561fa) linting! - [`d99fe04`](https://github.com/better-auth/better-auth/commit/d99fe04072905d0b8f9a5ec1e45b51aabf6553e1) operation ids in metadata - [`30161f1`](https://github.com/better-auth/better-auth/commit/30161f16ebc7bddff4510f2806902c7dad6a8cf6) more operation ids - [`a7962d3`](https://github.com/better-auth/better-auth/commit/a7962d3b34a7f22cf58489b4885f3b8fa6ca1903) revert some changes - [`de330f5`](https://github.com/better-auth/better-auth/commit/de330f558a8151cf35ffcadf384799abbc298aa0) fixes - [`78dc175`](https://github.com/better-auth/better-auth/commit/78dc1756bb83753f2dcc04e622ee6d8fe1cbaf4b) . - [`1d49851`](https://github.com/better-auth/better-auth/commit/1d4985111b13d1ad4c6a498066d1140ac70f73b9) fixes ### 📊 Changes **21 files changed** (+152 additions, -126 deletions) <details> <summary>View changed files</summary> 📝 `packages/better-auth/src/api/routes/account.ts` (+2 -0) 📝 `packages/better-auth/src/api/routes/callback.ts` (+1 -0) 📝 `packages/better-auth/src/api/routes/email-verification.ts` (+4 -40) 📝 `packages/better-auth/src/api/routes/reset-password.ts` (+26 -0) 📝 `packages/better-auth/src/api/routes/session.ts` (+4 -0) 📝 `packages/better-auth/src/api/routes/sign-in.ts` (+14 -71) 📝 `packages/better-auth/src/api/routes/sign-out.ts` (+2 -0) 📝 `packages/better-auth/src/api/routes/sign-up.ts` (+2 -0) 📝 `packages/better-auth/src/api/routes/update-user.ts` (+38 -3) 📝 `packages/better-auth/src/plugins/admin/admin.ts` (+1 -1) 📝 `packages/better-auth/src/plugins/email-otp/index.ts` (+14 -7) 📝 `packages/better-auth/src/plugins/jwt/index.ts` (+2 -0) 📝 `packages/better-auth/src/plugins/magic-link/index.ts` (+2 -0) 📝 `packages/better-auth/src/plugins/oauth-proxy/index.ts` (+2 -0) 📝 `packages/better-auth/src/plugins/oidc-provider/index.ts` (+6 -1) 📝 `packages/better-auth/src/plugins/open-api/generator.ts` (+15 -2) 📝 `packages/better-auth/src/plugins/organization/routes/crud-invites.ts` (+3 -1) 📝 `packages/better-auth/src/plugins/organization/routes/crud-members.ts` (+5 -0) 📝 `packages/better-auth/src/plugins/organization/routes/crud-org.ts` (+2 -0) 📝 `packages/better-auth/src/plugins/passkey/index.ts` (+4 -0) _...and 1 more files_ </details> ### 📄 Description Fixes #2097 This pull request introduces several changes to the `packages/better-auth` module, primarily focusing on adding `operationId` fields to various API endpoints and correcting OpenAPI schema references. These changes enhance the API documentation and ensure consistency across the endpoints. * Added `operationId` fields to multiple API endpoints, including plugins * Corrected OpenAPI schema references from `ref` to `$ref`: - `verifyEmail` in `email-verification.ts` - `signInSocial` in `sign-in.ts` - `signInEmail` in `sign-in.ts` - `updateUser` in `update-user.ts` - `changeEmail` in `update-user.ts` * Added the parameter definition for the `reset-password/:token` endpoint * Added openapi metadata for the `delete-user` endpoint to fix the required: [] invalid schema * Force include `Session` table in openapi schema * Change OpenAPI type generation for `type: date` to `type: string \n format: date-time` --- <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 20:05:48 -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#21058