HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Closed

#14.484 aberto em 3 de fev. de 2023

Ver no GitHub
 (26 comments) (0 reactions) (1 assignee)JavaScript (3.912 forks)batch import
good first issuepriority: minorsection: API

Métricas do repositório

Stars
 (10.775 stars)
Métricas de merge de PR
 (Mesclagem média 51d 20h) (3 fundiu PRs em 30d)

Description

The API documentation for "Mark multiple notifications as read" is inaccurate.

There is a required parameter in the request body, notificationIds, specifying what notifications to mark as read, which doesn't show up in apidoc as yet. We don't currently have a blanket API route to dismiss all notifs without listing them.

Guia do colaborador

Direção de pesquisa
Revise a ferramenta de geração de documentação da API usada (apidoc) e adicione o parâmetro notificationIds ausente ao endpoint /notifications/read.
Pilha de tecnologia
javascript
Domain
apibackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitfamiliarity with API documentation tools
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70