Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#2,199 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
openapi, rust
Domaine
api, documentation

Piste de recherche

Lisez products/casework/scripts/generate_openapi.py et examinez response() ; comparez sa sortie au comportement de la route existante dans crates/registry-casework/src/http.rs:get_review_result et au traitement côté client dans crates/registry-review-client/src/client.rs. Mettez à jour les descriptions et la documentation des corps vides pour 202, 404 et 410, régénérez products/casework/generated/registry-casework.openapi.json et vérifiez que le contrôle de dérive réussit.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Rust
Étoiles
2
Forks
0
Merge moyen
9 h 43 min
PR mergées (30 j)
268

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de registrystack/registry-stack

Toutes les issues de registrystack/registry-stack

Issues similaires

Plus d'issues Rust

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.