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

Ouverte Adaptée aux débutants
#7,516 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 3 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
78/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
openapi, python

Piste de recherche

Trouvez le docstring de batch_prediction_broken_site_report, qui documente POST /<model_name>/predict/broken_site_report/batch. Commencez par corriger l’indentation de reports: et de ses éléments enfants sous properties:. Appelez ensuite /swagger pour confirmer que la spécification se charge ; ajouter un test pour cet endpoint aiderait à détecter des erreurs similaires.

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

Description

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.

Langage dominant
Python
Étoiles
579
Forks
369
Merge moyen
3 j 5 h
PR mergées (30 j)
139

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

Toutes les issues de mozilla/bugbug

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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