Documentation differs from Implementation for /packageManifests/{id} return codes (204 or 404)
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- csharp
- 領域
- api, documentation
調査の方向性
packageManifests route の documentation/WinGet-1.1.0.yaml と documentation/WinGet-1.4.0.yaml を読み、src/WinGet.RestSource/Helpers/RestSourceTriggerFunctions.cs の 204 の処理と比較してください。パッケージが見つからない場合に意図されている status code を確認し、schema と reference implementation の動作およびドキュメントが一致するように整合させてください。
索引モデルが issue の本文から書いたものです。
説明
Brief description of your issue
Hi,
according to both the 1.1.0 and 1.4.0 REST API schema, the /packageManifests/{PackageIdentifier} route is only supposed to return 200, 404 or another error:
https://github.com/microsoft/winget-cli-restsource/blob/main/documentation/WinGet-1.1.0.yaml#L506-L522
https://github.com/microsoft/winget-cli-restsource/blob/main/documentation/WinGet-1.4.0.yaml#L506-L522
However, the reference implementation also explicitly tests for the undocumented 204 here:
which raises the question - should a REST source return 404 like the schema suggests when a packageIdentifier is not found or should it return 204? I have noticed in testing that winget responds with a red error message when it gets a 404 (which I guess is fine / maybe intended?) but responds with a much more calm "no results found" message when it gets a 204 - so the client seems to handle the undocumented 204 more gracefully, further hinting that that's maybe the intended return code and the schema docs are wrong?
Thanks!
- 主要言語
- C#
- スター
- 317
- フォーク
- 79
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/winget-cli-restsource のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
-
Issue-Feature
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
Font Support オープンIssue-Feature
microsoft/winget-cli-restsource#310 · コメント 1 件 · 担当者 1 名 ·
-
Issue-Bug
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
microsoft/winget-cli-restsource#309 · コメント 2 件 ·
microsoft/winget-cli-restsource の issue をすべて見る
似ている issue
-
core dependencies
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
-
bug frontend good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
Down / Waiting for removal
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100