Discourse openapi.json 文档未遵循 OpenAPI 3.1.0 spec

我不确定这里是否是提交此类反馈的最佳地点,但相关的 Github 存储库已关闭了 Issue 提交门户,所以我尝试在此处提供反馈。
GitHub - discourse/discourse_api_docs: Discourse API Documentation

GitHub - discourse/discourse_api_docs: Discourse API Documentation 托管的 openapi.json 文件实际上不是一个有效的 openapi 文件。

在此处查看更多信息 Discourse openapi.json generate issue · Issue #277 · mattpolzin/OpenAPIKit · GitHub

TL,DR :backhand_index_pointing_down:

array schema 的 items 键“必须是有效的 JSON Schema”(json-schema.org/draft/2020-12/json-schema-core.html#section-10.3.1.2-1),并且 JSON Schema “必须是一个对象或一个布尔值”(json-schema.org/draft/2020-12/json-schema-core.html#section-4.3-2)。因为 OpenAPI 文档的这一部分受 JSON Schema 规则的约束,所以他们可能不会在 OpenAPI 规范本身中过多提及这些规则。

1 个赞

Discourse 的 openapi.json 是由一个名为 rswag 的工具生成的

这可能是一个上游问题。当上游修复它时,我们应该升级依赖版本并更新相应的文档文件。

2 个赞

PR above ^ was actually addressed downstream here:

1 个赞