habitica icon indicating copy to clipboard operation
habitica copied to clipboard

API Documentation for /notifications/read is incomplete

Open SabreCat opened this issue 2 years ago • 17 comments

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.

SabreCat avatar Feb 03 '23 21:02 SabreCat

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

shivamAmrutia avatar Feb 04 '23 13:02 shivamAmrutia

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

TUdarbe avatar Feb 05 '23 00:02 TUdarbe

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

KipronohVincent avatar Feb 13 '23 13:02 KipronohVincent

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

marnamrs avatar Feb 22 '23 09:02 marnamrs

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: @.***>

KipronohVincent avatar Feb 22 '23 14:02 KipronohVincent

Sure thing, @marnamrs! Thanks!

CuriousMagpie avatar Apr 28 '23 19:04 CuriousMagpie

is this issue resolved?

apoorvapendse avatar May 24 '23 05:05 apoorvapendse

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

apoorvapendse avatar May 24 '23 06:05 apoorvapendse

@SabreCat @CuriousMagpie can i work on this?

apoorvapendse avatar May 26 '23 01:05 apoorvapendse

Sure thing, @apoorvapendse! Thanks!

CuriousMagpie avatar Jun 08 '23 19:06 CuriousMagpie

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

apoorvapendse avatar Jun 10 '23 16:06 apoorvapendse

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

CiceroLino avatar Jul 12 '23 06:07 CiceroLino

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

apoorvapendse avatar Jul 12 '23 14:07 apoorvapendse

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

ducknows avatar Dec 04 '23 08:12 ducknows

@ducknows nope.

apoorvapendse avatar Dec 04 '23 16:12 apoorvapendse

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

nadasuhailAyesh12 avatar Mar 18 '24 08:03 nadasuhailAyesh12

@SabreCat can you review the pr associated with this

anishlukk123 avatar Jul 04 '24 14:07 anishlukk123