HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Open

#14.484 geöffnet am 3. Feb. 2023

Auf GitHub ansehen
 (26 Kommentare) (0 Reaktionen) (1 zugewiesene Person)JavaScript (10.775 Stars) (3.912 Forks)batch import
good first issuepriority: minorsection: API

Beschreibung

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.

Contributor Guide

Tech Stack
javascriptrest api
Domain
documentationapi
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic MarkdownAPI concepts
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.