HabitRPG / habitica

A habit tracker app which treats your goals like a Role Playing Game.
https://habitica.com
Other
11.63k stars 4.04k forks source link

API Documentation for /notifications/read is incomplete #14484

Open SabreCat opened 1 year ago

SabreCat commented 1 year ago

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.

shivamAmrutia commented 1 year ago

This is my first issue and i have no clue how to get started, can you please tell me how can i help ?

TUdarbe commented 1 year ago

Hi! I would like to pick up and work on this issue.

KipronohVincent commented 1 year ago

Hello I'm requesting for guidance on how to tackle this issue

marnamrs commented 1 year ago

Hi! I have looked into controller files and saw the missing @apiParam, I can pick this up and add the annotation.

KipronohVincent commented 1 year ago

sure

On Wed, Feb 22, 2023 at 12:28 PM marnamrs @.***> wrote:

Hi! I have looked into controller files and saw the missing @apiParam, I can pick this up and add the annotation.

— Reply to this email directly, view it on GitHub https://github.com/HabitRPG/habitica/issues/14484#issuecomment-1439691644, or unsubscribe https://github.com/notifications/unsubscribe-auth/AVJAGT2QZJ2KZWSO66ITHXDWYXL3NANCNFSM6AAAAAAUQXLGCA . You are receiving this because you commented.Message ID: @.***>

CuriousMagpie commented 1 year ago

Sure thing, @marnamrs! Thanks!

apoorvapendse commented 1 year ago

is this issue resolved?

apoorvapendse commented 1 year ago

image Do you want it to look like this? @SabreCat @CuriousMagpie

apoorvapendse commented 1 year ago

@SabreCat @CuriousMagpie can i work on this?

CuriousMagpie commented 1 year ago

Sure thing, @apoorvapendse! Thanks!

apoorvapendse commented 1 year ago

@CuriousMagpie Thanks for assigning, do you also need the same change for marking multiple notifications as seen?

CiceroLino commented 1 year ago

is this issue resolved? if not, can I work on this?

apoorvapendse commented 1 year ago

@CiceroLino I have created a pull request for the same, waiting for it to be reviewed.

ducknows commented 7 months ago

does anyone got an update on this issue if got reviewed or not?

apoorvapendse commented 7 months ago

@ducknows nope.

nadasuhailAyesh12 commented 4 months ago

Can I work on this issue, could you assign me please

anishlukk123 commented 1 week ago

@SabreCat can you review the pr associated with this