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.