HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Open

#14,484 opened on Feb 3, 2023

View on 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.

Contributor guide

Tech stack
javascriptrest api
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic MarkdownAPI concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.