[BUG] Document missing audit endpoints and specify deprecation details
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 5
- Forks
- 5
- Avg merge
- 6h 35m
- Merged PRs (30d)
- 3
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API documentation added by issue #39 and locate how the bulk security advisories endpoint is documented. Check the two referenced endpoints, /-/npm/v1/security/advisories and /-/npm/v1/security/advisories/quick, against the linked ecosystem reports. Done means both endpoints are listed and any confirmed brownout or deprecation details are documented or clearly identified for public announcement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- handlebars
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100