[PR #836] [MERGED] docs: fix user API auth and add admin delete API docs #796

New issue

Closed

opened 2026-02-26 21:32:59 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 21:32:59 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/dreamhunter2333/cloudflare_temp_email/pull/836
Author: @dreamhunter2333
Created: 2/16/2026
Status: ✅ Merged
Merged: 2/16/2026
Merged by: @dreamhunter2333

Base: main ← Head: feature/email

📝 Commits (2)

ae9139e docs: fix user API auth and add admin delete API docs
b5e8599 chore: upgrade dependencies

📊 Changes

11 files changed (+1209 additions, -1545 deletions)

View changed files

📝 CHANGELOG.md (+5 -0)
📝 CHANGELOG_EN.md (+5 -0)
📝 frontend/package.json (+6 -6)
📝 frontend/pnpm-lock.yaml (+347 -734)
📝 pages/package.json (+1 -1)
📝 vitepress-docs/docs/en/guide/feature/mail-api.md (+69 -1)
📝 vitepress-docs/docs/zh/guide/feature/mail-api.md (+69 -1)
📝 vitepress-docs/package.json (+2 -2)
📝 vitepress-docs/pnpm-lock.yaml (+351 -351)
📝 worker/package.json (+7 -7)
📝 worker/pnpm-lock.yaml (+347 -442)

📄 Description

User description

Changes

Fix User Mail API documentation incorrectly using x-admin-auth header, changed to correct x-user-token (zh/en)
Add Admin API documentation for delete mail, delete address, clear inbox, and clear sent items (zh/en)
Update CHANGELOG for v1.4.0 with email regex validation feature and documentation fixes (zh/en)

修复 User Mail API 文档中错误使用 x-admin-auth 的问题，改为正确的 x-user-token（中英文）
新增 Admin 删除邮件、删除邮箱地址、清空收件箱、清空发件箱 API 文档（中英文）
更新 v1.4.0 CHANGELOG，补充邮箱正则校验功能和文档修复记录（中英文）

PR Type

Documentation, Enhancement

Description

Fixed incorrect x-admin-auth header in User Mail API documentation.
Added Admin API documentation for delete mail, delete address, clear inbox, and clear sent items.
Updated CHANGELOG with email regex validation feature and documentation fixes.
Provided both English and Chinese documentation updates for consistency.

Diagram Walkthrough

flowchart LR
  FixAuth["Fix User Mail API auth header"] --> UpdateDocs["Update User Mail API docs"]
  AddAdminAPIs["Add Admin API documentation"] --> UpdateDocs
  UpdateDocs --> UpdateChangelog["Update CHANGELOG with recent changes"]

File Walkthrough

Relevant files

Documentation

CHANGELOG.md `Updated CHANGELOG with features and fixes.` CHANGELOG.md Added entry for email regex validation feature. Documented fixes for User Mail API auth header. Added Admin API documentation entries.	+5/-0
CHANGELOG_EN.md `Updated English CHANGELOG with features and fixes.` CHANGELOG_EN.md Added entry for email regex validation feature. Documented fixes for User Mail API auth header. Added Admin API documentation entries.	+5/-0
mail-api.md `Updated English Mail API documentation with fixes and new Admin APIs.` vitepress-docs/docs/en/guide/feature/mail-api.md Fixed incorrect `x-admin-auth` header to `x-user-token`. Added Admin API documentation for delete mail, delete address, clear inbox, and clear sent items.	+69/-1
mail-api.md `Updated Chinese Mail API documentation with fixes and new Admin APIs.` vitepress-docs/docs/zh/guide/feature/mail-api.md Fixed incorrect `x-admin-auth` header to `x-user-token`. Added Admin API documentation for delete mail, delete address, clear inbox, and clear sent items.	+69/-1

_{🔄 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/dreamhunter2333/cloudflare_temp_email/pull/836 **Author:** [@dreamhunter2333](https://github.com/dreamhunter2333) **Created:** 2/16/2026 **Status:** ✅ Merged **Merged:** 2/16/2026 **Merged by:** [@dreamhunter2333](https://github.com/dreamhunter2333) **Base:** `main` ← **Head:** `feature/email` --- ### 📝 Commits (2) - [`ae9139e`](https://github.com/dreamhunter2333/cloudflare_temp_email/commit/ae9139eccc437baef7bdd72f536f2f4e1aebfcee) docs: fix user API auth and add admin delete API docs - [`b5e8599`](https://github.com/dreamhunter2333/cloudflare_temp_email/commit/b5e8599b3fa4224e6618d36a32add9b2f8e7eb45) chore: upgrade dependencies ### 📊 Changes **11 files changed** (+1209 additions, -1545 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+5 -0) 📝 `CHANGELOG_EN.md` (+5 -0) 📝 `frontend/package.json` (+6 -6) 📝 `frontend/pnpm-lock.yaml` (+347 -734) 📝 `pages/package.json` (+1 -1) 📝 `vitepress-docs/docs/en/guide/feature/mail-api.md` (+69 -1) 📝 `vitepress-docs/docs/zh/guide/feature/mail-api.md` (+69 -1) 📝 `vitepress-docs/package.json` (+2 -2) 📝 `vitepress-docs/pnpm-lock.yaml` (+351 -351) 📝 `worker/package.json` (+7 -7) 📝 `worker/pnpm-lock.yaml` (+347 -442) </details> ### 📄 Description ### **User description** ## Changes - Fix User Mail API documentation incorrectly using `x-admin-auth` header, changed to correct `x-user-token` (zh/en) - Add Admin API documentation for delete mail, delete address, clear inbox, and clear sent items (zh/en) - Update CHANGELOG for v1.4.0 with email regex validation feature and documentation fixes (zh/en) 修复 User Mail API 文档中错误使用 `x-admin-auth` 的问题，改为正确的 `x-user-token`（中英文）新增 Admin 删除邮件、删除邮箱地址、清空收件箱、清空发件箱 API 文档（中英文）更新 v1.4.0 CHANGELOG，补充邮箱正则校验功能和文档修复记录（中英文） ___ ### **PR Type** Documentation, Enhancement ___ ### **Description** - Fixed incorrect `x-admin-auth` header in User Mail API documentation. - Added Admin API documentation for delete mail, delete address, clear inbox, and clear sent items. - Updated CHANGELOG with email regex validation feature and documentation fixes. - Provided both English and Chinese documentation updates for consistency. ___ ### Diagram Walkthrough ```mermaid flowchart LR FixAuth["Fix User Mail API auth header"] --> UpdateDocs["Update User Mail API docs"] AddAdminAPIs["Add Admin API documentation"] --> UpdateDocs UpdateDocs --> UpdateChangelog["Update CHANGELOG with recent changes"] ``` <details> <summary><h3> File Walkthrough</h3></summary> <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table> <tr> <td> <details> <summary><strong>CHANGELOG.md</strong><dd><code>Updated CHANGELOG with features and fixes.</code>                              </dd></summary> <hr> CHANGELOG.md <ul><li>Added entry for email regex validation feature.<br> <li> Documented fixes for User Mail API auth header.<br> <li> Added Admin API documentation entries.</ul> </details> </td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/836/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed">+5/-0</a>      </td> </tr> <tr> <td> <details> <summary><strong>CHANGELOG_EN.md</strong><dd><code>Updated English CHANGELOG with features and fixes.</code>              </dd></summary> <hr> CHANGELOG_EN.md <ul><li>Added entry for email regex validation feature.<br> <li> Documented fixes for User Mail API auth header.<br> <li> Added Admin API documentation entries.</ul> </details> </td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/836/files#diff-77d2276dbbf8eb648363b81ea97049986b18e2cf1e90bd20fb5133ed5ff4fcae">+5/-0</a>      </td> </tr> <tr> <td> <details> <summary><strong>mail-api.md</strong><dd><code>Updated English Mail API documentation with fixes and new Admin APIs.</code></dd></summary> <hr> vitepress-docs/docs/en/guide/feature/mail-api.md <ul><li>Fixed incorrect <code>x-admin-auth</code> header to <code>x-user-token</code>.<br> <li> Added Admin API documentation for delete mail, delete address, clear <br>inbox, and clear sent items.</ul> </details> </td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/836/files#diff-4f99106a49786d7fe64cf221bc1665491c1bfbdad2524e50aa6c59f0a7b3bf57">+69/-1</a>    </td> </tr> <tr> <td> <details> <summary><strong>mail-api.md</strong><dd><code>Updated Chinese Mail API documentation with fixes and new Admin APIs.</code></dd></summary> <hr> vitepress-docs/docs/zh/guide/feature/mail-api.md <ul><li>Fixed incorrect <code>x-admin-auth</code> header to <code>x-user-token</code>.<br> <li> Added Admin API documentation for delete mail, delete address, clear <br>inbox, and clear sent items.</ul> </details> </td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/836/files#diff-6c591ac0d4b0ecd75a10ec850fbbd677d9d365fffa9aeddd1b3d9c63898c66bc">+69/-1</a>    </td> </tr> </table></td></tr></tr></tbody></table> </details> ___ --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>