[BUG] Document missing audit endpoints and specify deprecation details
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 48/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- handlebars
- 領域
- api, documentation
調査の方向性
issue #39 で追加された API ドキュメントから始め、セキュリティアドバイザリの一括エンドポイントがどのように文書化されているかを確認します。参照されている 2 つのエンドポイント、/-/npm/v1/security/advisories と /-/npm/v1/security/advisories/quick を、リンク先のエコシステムレポートと照合します。両方のエンドポイントが一覧に含まれ、確認済みの brownout または非推奨化に関する詳細が文書化されているか、公開発表向けに明確に特定されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- Handlebars
- スター
- 4
- フォーク
- 5
- 平均マージ
- 9日 10時間
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
npm/api-documentation のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
npm/api-documentation#74 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 10/100
npm/api-documentation#50 ·
-
[BUG] <title>オープン
難易度 5/5 1週間以上 初心者へのやさしさ 10/100
npm/api-documentation#49 ·
npm/api-documentation の issue をすべて見る
似ている issue
-
docs(api): openapi.yaml still documents gif-tools optimize colors as 2-256 instead of 2, 4, 16, 256オープンarea: backend documentation priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
snapotter-hq/SnapOtter#2919 ·
メンテナーはふだん 1 日以内に返信
-
good first issue gpu serve
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
メンテナーはふだん 1 日以内に返信
-
bug deferred domain:ci P1
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
docling-project/docling-mcp#147 ·