HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Open

#14.484 aberto em 3 de fev. de 2023

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

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

Pilha de tecnologia
javascriptrest api
Domain
documentationapi
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic MarkdownAPI concepts
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
Identify the API documentation file for the 'Mark notifications as read' endpoint. The required parameter `notificationIds` needs to be added to the request body description. Check the existing documentation generation setup (e.g., apidoc) and ensure the update is consistent with other endpoint docs.