devnote-dev / devnote-dev/ptero-notes

Authentication endpoints coverage

Aperta
#10 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
coverage enhancement help wanted
Lingua principale
Nessun dato sulla lingua
Stelle
37
Fork
6
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
php
Ambito
authentication, documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.