HabitRPG/habitica

API Documentation for /notifications/read is incomplete

Closed

#14.484 aperta il 3 feb 2023

Vedi su GitHub
 (26 commenti) (0 reazioni) (1 assegnatario)JavaScript (3912 fork)batch import
good first issuepriority: minorsection: API

Metriche repository

Star
 (10.775 star)
Metriche merge PR
 (Merge medio 51g 20h) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina lo strumento di generazione della documentazione API utilizzato (apidoc) e aggiungi il parametro mancante notificationIds all'endpoint /notifications/read.
Tech stack
javascript
Dominio
apibackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitfamiliarity with API documentation tools
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70