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

未关闭 适合新手
#7,516 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 3 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
78/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
openapi, python

调研方向

找到 batch_prediction_broken_site_report 的 docstring,它记录了 POST /<model_name>/predict/broken_site_report/batch。先修正 properties: 下 reports: 及其子项的缩进。然后调用 /swagger 确认规范能够加载;为该 endpoint 添加测试有助于发现类似错误。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
579
派生
369
平均合并
3 天 5 小时
30 天内合并 PR
139

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

mozilla/bugbug 的其他 Issue

查看 mozilla/bugbug 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。