Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#2,199 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
openapi, rust
Área
api, documentation

Línea de trabajo

Lee products/casework/scripts/generate_openapi.py e inspecciona response(); compara su salida con el comportamiento de la ruta existente en crates/registry-casework/src/http.rs:get_review_result y el manejo del cliente en crates/registry-review-client/src/client.rs. Actualiza las descripciones y la documentación de los cuerpos vacíos para 202, 404 y 410, vuelve a generar products/casework/generated/registry-casework.openapi.json y verifica que pase la comprobación de divergencias.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Rust
Estrellas
2
Forks
0
Merge medio
10 h 32 min
PR fusionados (30 d)
269

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de registrystack/registry-stack

Todos los issues de registrystack/registry-stack

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.