Incorrect validation occuring due to property using "enum" as a property name
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
首先,使用所引用的 openapi.yaml 和 PropertyPrototype 示例重现该警告,重点关注属性名为 "enum" 的路径。跟踪 validator 如何解释该路径,并添加一个覆盖此示例的回归用例;完成的标准是该文档不再产生错误的 enum 警告,同时真正的 enum 验证仍然正常工作。
由索引模型根据 Issue 内容生成。
描述
Version: [email protected]
The validator comes back with a warning for the content of some of our example responses:
Message : Enum value "option1" must be "single_select".
Path : paths./tekton_pipelines/{pipeline_id}/properties.post.requestBody.content.application/json.examples.single_select_env_properties.value.enum.0
Line : 1119
This is arising in 9 places in our API yaml. The full yaml file can be seen here
This is one example:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyPrototype'
examples:
single_select_env_properties:
value:
name: "enums"
type: "single_select"
enum: ["option1","option2","option3"]
value: "option1"
Schema for the enum:
enum:
description: Options for `single_select` property type
type: array
minItems: 0
maxItems: 1024
items:
$ref: '#/components/schemas/GeneralString'
It seems like the fact we are using the term enum for one of the properties in our API schema is confusing the validator
- 主要语言
- JavaScript
- 星标
- 635
- 派生
- 98
- 平均合并
- 1 天 5 小时
- 30 天内合并 PR
- 8
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
IBM/openapi-validator 的其他 Issue
-
security
难度 2/5 1-3 小时 新手友好度 52/100
IBM/openapi-validator#875 · 1 条评论 ·
-
`Provided ruleset is not an object` error after upgrading from 1.37.12 to 1.37.13可能重新可做 @diatrcz 于 123 天前认领,目前没有进行中的 PR。 未关闭
IBM/openapi-validator#809 · 5 条评论 · 2 个 reaction · 已指派 1 人 ·
-
难度 3/5 1-2 天 新手友好度 45/100
IBM/openapi-validator#748 · 4 条评论 ·
-
难度 3/5 1-2 天 新手友好度 42/100
IBM/openapi-validator#747 · 2 条评论 · 1 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 32/100
IBM/openapi-validator#643 · 3 条评论 ·
查看 IBM/openapi-validator 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
jonathanong/no-mistakes#3332 ·
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 72/100
githubnext/gh-aw-workshop#5674 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 62/100
awesome-dsh-plugin/awesome-dsh-plugin#14970 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
swc-project/swc-ai-issues#653 ·