Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Casework OpenAPI: describe the review result read's 202, 404 and 410 as pending, not found and expired

オープン 初心者向け
  • 何か問題がありますか？
#2,199 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
openapi, rust
領域
api, documentation

調査の方向性

products/casework/scripts/generate_openapi.pyを読み、response()を調べます。その出力を、crates/registry-casework/src/http.rs:get_review_resultにある既存のルートの動作、およびcrates/registry-review-client/src/client.rsでのクライアント側の処理と比較します。202、404、410の説明と空のレスポンスボディに関するドキュメントを更新し、products/casework/generated/registry-casework.openapi.jsonを再生成して、差分チェックが通ることを確認します。

索引モデルが issue の本文から書いたものです。

説明

area:casework bug criticality:p2 triage:needs-implementation
What Happened

In the generated Casework OpenAPI document, GET /v1/review-requests/{request_id}/result describes four responses as "Success": 200, 202, 404 and 410. The runtime answers 202 while the review is pending, 404 when the request is unknown or concealed from the caller, and 410 when the result has expired, each with an empty body. The review client treats those as Pending, ConcealedOrUnknown and Expired and refuses a body on them. A reader or a code generator working from the document treats a missing or expired result as success. The document also does not say these three responses carry no problem body, while every other refusal on the route is application/problem+json.

Expected Behavior

The document describes 202 as pending (no body), 404 as unknown or not visible to the caller (no body), and 410 as result expired (no body), and the committed OpenAPI is regenerated so the drift check holds it.

Reproduction
jq '.paths["/v1/review-requests/{request_id}/result"].get.responses | map_values(.description)' \
  products/casework/generated/registry-casework.openapi.json
Where

products/casework/scripts/generate_openapi.py (response() default description); products/casework/generated/registry-casework.openapi.json; behaviour in crates/registry-casework/src/http.rs:get_review_result and crates/registry-review-client/src/client.rs.

Environment

Registry Stack 0.42.0, main as of 2026-10-18.

主要言語
Rust
スター
2
フォーク
0
平均マージ
10時間 45分
マージ済み PR（30日）
259

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

registrystack/registry-stack のほかの issue

registrystack/registry-stack の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。