HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Open

#14,484 建立於 2023年2月3日

在 GitHub 查看
 (26 留言) (0 反應) (1 負責人)JavaScript (10,775 star) (3,912 fork)batch import
good first issuepriority: minorsection: API

描述

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.

貢獻者指南

技術棧
javascriptrest api
領域
documentationapi
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic MarkdownAPI concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.