OpenAPI 3：缺少属性“$ref”

发布于 2025-01-12 08:48:03 字数 568 浏览 1 评论 0原文

我正在 VSCode 中使用 OpenAPI 3 编写 API 文档，扩展名为 OpenAPI (Swagger) Editor v4.9.1。直到今天它都运行得很好 - 突然我的文档充满了所有模式声明中“属性”的错误。错误如下：

Missing property "$ref". yaml-schema: Validation schema for OpenAPI Specification 3.0.X.

显然，这个错误根本没有任何意义，因为根据 OpenAPI 规范，$ref 在任何地方都不是必填字段。
此外，我仍然可以使用 swagger 的默认渲染器预览该文档，或者使用其 CodeGen 工具链生成代码，这表明该文档没有实际错误。
那么发生了什么事？是 OpenAPI 语言服务器中的错误吗？

原文

I'm writing an API document using OpenAPI 3 in VSCode with the extension OpenAPI (Swagger) Editor v4.9.1. It works pretty well until today - suddenly my document is filled with errors on "properties" within all schema declarations. The error goes:

Missing property "$ref". yaml-schema: Validation schema for OpenAPI Specification 3.0.X.

Obviously, this error makes no sense at all, since $ref is never a required field in any place according to OpenAPI Specification.
Besides, I could still preview this document with swagger's default renderer, or generate code using its CodeGen toolchain, which indicates that this document has no actual error.
So what's happening? Is it a bug in the OpenAPI language server?

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

命比纸薄 2025-01-19 08:48:03

我今天开始面临同样的问题，更新你的 openapi 版本可能是一个临时解决方案。

openapi：“3.1.0”

回复收藏 0 原文

墨小墨 2025-01-19 08:48:03

您必须指定参数的架构。
例如：

parameters:
        - in: header
          name: X-Request-ID
          schema:
            type: string
            format: uuid
          required: true

You must specify schema for the parameter.
Ex:

parameters:
        - in: header
          name: X-Request-ID
          schema:
            type: string
            format: uuid
          required: true

more details https://swagger.io/docs/specification/describing-parameters/

回复收藏 0 原文

~没有更多了~