devnote-dev / devnote-dev/ptero-notes

Authentication endpoints coverage

Aberta
#10 0 comentários 0 reações 0 responsáveis Ver no GitHub
coverage enhancement help wanted
Linguagem predominante
Sem dados de linguagem
Estrelas
37
Forks
6
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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)

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
php
Domínio
authentication, documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.