HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Closed

#14,484 opened on Feb 3, 2023

View on GitHub
 (26 comments) (0 reactions) (1 assignee)JavaScript (3,912 forks)batch import
good first issuepriority: minorsection: API

Repository metrics

Stars
 (10,775 stars)
PR merge metrics
 (Avg merge 51d 20h) (3 merged PRs in 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.

Contributor guide

Research direction
Review the API documentation generation tool used (apidoc) and add the missing notificationIds parameter to the /notifications/read endpoint.
Tech stack
javascript
Domain
apibackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitfamiliarity with API documentation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70