IBM Validator `examples` Keyword as Disallowed in OpenAPI Schema
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript, openapi
调研方向
首先，针对 issue 中的 OpenAPI 3.1.0 文档运行 IBM OpenAPI Validator，并检查报告该错误的 ibm-schema-keywords 规则。确认该规则如何处理 schema 级别的 examples 关键字；完成的标准是：在不破坏现有关键字验证的情况下，该有效文档不再将 examples 报告为不允许使用。
由索引模型根据 Issue 内容生成。
描述
Summary
The IBM OpenAPI Validator reports an error for the examples keyword in the OffsetDateTime schema, stating it is a disallowed keyword. However, the examples keyword is valid in OpenAPI 3.1.0, and its usage in the provided schema appears correct.
Details
When validating the following OpenAPI 3.1.0 schema with the IBM OpenAPI Validator, an error is reported:
Validator Error:
Message: Found disallowed keyword: examples
Rule: ibm-schema-keywords
Path: components.schemas.OffsetDateTime.examples
Line: 33
Full OpenAPI Document:
openapi: 3.1.0
components:
schemas:
TestEntity:
type: object
required:
- alias
- number
properties:
createdAt:
anyOf:
- $ref: "#/components/schemas/OffsetDateTime"
- type: "null"
updatedAt:
anyOf:
- $ref: "#/components/schemas/OffsetDateTime"
- type: "null"
alias:
type: string
number:
type: string
id:
type:
- integer
- "null"
format: int64
maximum: 9223372036854775807
minimum: 1
OffsetDateTime:
type: string
format: date-time
examples:
- 2022-03-10T12:15:50-04:00
paths:
/api/v1/tax/test:
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TestEntity"
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/TestEntity"
tags:
- Test Controller
info:
title: API
version: unspecified
- 主要语言
- 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 条评论 ·
-
难度 4/5 3-5 天 新手友好度 32/100
IBM/openapi-validator#643 · 3 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
IBM/openapi-validator#545 · 1 条评论 ·
查看 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 ·