Rule "ibm-success-response-example" fails for some operations but not others

未关闭
#643 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
32/100
Issue 类型
缺陷
描述清晰度
需要澄清
活跃度
停滞
技术栈
javascript, openapi
领域
api, tooling

调研方向

首先,使用响应 schema 通过和不通过的操作重现“ibm-success-response-example”规则的行为,然后将这些 schema 与 Swagger UI 生成的示例进行比较。该 issue 没有指定文件或测试,因此第一步是定位规则实现和相关的测试覆盖范围。完成的标准是:明确说明缺少的 schema 要求,或定义 validator 的变更,并通过测试覆盖这些不同的操作。

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

描述

I'd like to understand why the above rule complains for some operations, but not others, even if I haven't explicitly defined examples in any of the api responses.
It seems that in some cases the rule accepts that an example can be generated based on the schema of the response, and in other cases the schema is not enough.

Is there a way to tell what's missing from the inadequate schemas?

Also, Swagger UI shows auto generated examples for all my operations, so it's difficult to understand what's missing from some schemas

主要语言
JavaScript
星标
635
派生
98
平均合并
1 天 5 小时
30 天内合并 PR
8

环境准备

从这里开始

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

IBM/openapi-validator 的其他 Issue

查看 IBM/openapi-validator 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

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