Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta Adatta ai principianti
  • Qualcosa non va?
#2,199 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
openapi, rust
Ambito
api, documentation

Direzione di ricerca

Leggi products/casework/scripts/generate_openapi.py ed esamina response(); confrontane l'output con il comportamento della route esistente in crates/registry-casework/src/http.rs:get_review_result e con la gestione lato client in crates/registry-review-client/src/client.rs. Aggiorna le descrizioni e la documentazione dei body vuoti per 202, 404 e 410, rigenera products/casework/generated/registry-casework.openapi.json e verifica che il controllo delle differenze passi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Rust
Stelle
2
Fork
0
Merge medio
10h 32m
PR unite (30g)
269

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di registrystack/registry-stack

Tutte le issue di registrystack/registry-stack

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.