[BUG] Document missing audit endpoints and specify deprecation details
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- handlebars
- Ambito
- api, documentation
Direzione di ricerca
Inizia dalla documentazione dell’API aggiunta da issue #39 e individua come è documentato l’endpoint per gli avvisi di sicurezza in blocco. Verifica i due endpoint referenziati, /-/npm/v1/security/advisories e /-/npm/v1/security/advisories/quick, confrontandoli con i report dell’ecosistema collegati. Il lavoro è completato quando entrambi gli endpoint sono elencati e tutti i dettagli confermati relativi a brownout o deprecazione sono documentati o chiaramente identificati per un annuncio pubblico.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is there an existing issue for this?
- I have searched the existing issues
Current Behavior
#39 added details of the bulk security advisories endpoint, but there are at least two more endpoints (/-/npm/v1/security/advisories and /-/npm/v1/security/advisories/quick) that are currently undocumented and appear to have been subject to unannounced brownouts in recent days:
- yarnpkg/yarn#9234
- pnpm/pnpm#11265
- dependency-check/DependencyCheck#8421
Expected Behavior
At the very least, those two endpoints should be listed in the API documentation as they are being used by various tools within the ecosystem.
Preferably, any details about brownouts or deprecations of these endpoints should also be noted in the API documentation or announced in other public forums.
Steps To Reproduce
No response
Environment
No response
- Lingua principale
- Handlebars
- Stelle
- 5
- Fork
- 5
- Merge medio
- 6h 35m
- PR unite (30g)
- 3
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di npm/api-documentation
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
npm/api-documentation#74 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 10/100
npm/api-documentation#50 ·
-
[BUG] <title> Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 10/100
npm/api-documentation#49 ·
Tutte le issue di npm/api-documentation
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
microsoft/magentic-ui#588 ·
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
alexgorbatchev/simple-ptt#3 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
CorrelAid/formtransform#44 ·