devnote-dev / devnote-dev/ptero-notes

Authentication endpoints coverage

Đang mở
#10 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
coverage enhancement help wanted
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
37
Fork
6
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
php
Lĩnh vực
authentication, documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.