http service: /swagger returns 500 because of a mis-indented requestBody schema in the broken site report batch endpoint

Abierto Apto para principiantes
#7,516 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
openapi, python

Línea de trabajo

Encuentra el docstring de batch_prediction_broken_site_report, que documenta POST /<model_name>/predict/broken_site_report/batch. Empieza corrigiendo la indentación de reports: y sus elementos secundarios bajo properties:. Luego llama a /swagger para confirmar que la especificación se carga; añadir una prueba para ese endpoint ayudaría a detectar errores similares.

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

Descripción

The /swagger endpoint of the http service fails with a 500:

  File ".../apispec/ext/marshmallow/schema_resolver.py", line 290, in resolve_schema_dict
    for k, v in schema["properties"].items()
AttributeError: 'NoneType' object has no attribute 'items'

The spec is generated from the docstrings of all routes, and the failing one is batch_prediction_broken_site_report (POST /<model_name>/predict/broken_site_report/batch). In its requestBody schema, reports: is at the same indentation level as properties: instead of being nested under it:

schema:
  type: object
  properties:
  reports:
    type: array
    ...

so properties is parsed as null. It dates back to bb54c090 (#3846). Since a single bad route makes the whole spec fail, /swagger (and the /doc page using it) are broken for every endpoint.

Fix: indent reports: (and its children) under properties:. A test calling /swagger would catch similar docstring mistakes in the future.

Lenguaje dominante
Python
Estrellas
579
Forks
369
Merge medio
3 d 5 h
PR fusionados (30 d)
139

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 mozilla/bugbug

Todos los issues de mozilla/bugbug

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.