devnote-dev / devnote-dev/ptero-notes

Authentication endpoints coverage

未關閉
#10 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
coverage enhancement help wanted
主要語言
沒有語言資料
星號
37
分支
6
PR 合併指標
30 天內沒有已合併 PR

描述

Documentation should be provided for the `/auth` endpoints which are responsible for user authentication in the panel. It is not part of any specific API and is not classed as it's own separate one, so I think it would be best placed under `/pterodactyl/auth`. This should also include information and usage of session tokens.

### Sources
* [routes/auth.php](https://github.com/pterodactyl/panel/blob/b23f3114e4cb71406e6de17d0dca0d88205f56c1/routes/auth.php)
* [app/Http/Requests/Auth](https://github.com/pterodactyl/panel/tree/1.0-develop/app/Http/Requests/Auth)
* [app/Http/Controllers/Auth](https://github.com/pterodactyl/panel/tree/b23f3114e4cb71406e6de17d0dca0d88205f56c1/app/Http/Controllers/Auth)

貢獻指南

開啟貢獻指南

研究方向

Start with routes/auth.php, then review app/Http/Requests/Auth and app/Http/Controllers/Auth to identify the authentication endpoints and their request handling. Add documentation under /pterodactyl/auth covering each endpoint and session-token usage; the work is done when the /auth coverage is complete and the documented behavior matches those sources.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
php
領域
authentication, documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。