HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Open

#14 484 ouverte le 3 févr. 2023

Voir sur GitHub
 (26 commentaires) (0 réactions) (1 assigné)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.

Guide contributeur

Stack technique
javascriptrest api
Domaine
documentationapi
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic MarkdownAPI concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.