Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[Schema Inaccuracy] Dependabot Alert "relationship" enum is incomplete

未关闭
#4,727 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
openapi
领域
api

调研方向

从 organization Dependabot alerts endpoint 文档和 dependabot-alert-with-repository 响应 schema 开始。定位 dependency.relationship enum,并验证 API 可能的值,包括 inconclusive。当 schema 列出所有有效值且所有相关的 schema 验证检查都通过时,即视为完成。

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

描述

documentation

Schema Inaccuracy

The Response Schema for the dependabot alert endpoint (for organizations) defines 3 valid values for relationship. When using this endpoint we sometimes get the value "inconclusive" which is not listed.

"dependabot-alert-with-repository": {
        "type": "object",
        "description": "A Dependabot alert.",
        "properties": {
          "number": {
            "$ref": "#/components/schemas/alert-number"
          },
          "state": {
            ...
          },
          "dependency": {
            "type": "object",
            "description": "Details for the vulnerable dependency.",
            "readOnly": true,
            "properties": {
              ...
              "relationship": {
                "type": "string",
                "description": "...",
                "readOnly": true,
                "nullable": true,
                "enum": [
                  "unknown",
                  "direct",
                  "transitive"
                ]
              }
            }
          },

Expected

The schema should include all values

"dependabot-alert-with-repository": {
        "type": "object",
        "description": "A Dependabot alert.",
        "properties": {
          "number": {
            "$ref": "#/components/schemas/alert-number"
          },
          "state": {
            ...
          },
          "dependency": {
            "type": "object",
            "description": "Details for the vulnerable dependency.",
            "readOnly": true,
            "properties": {
              ...
              "relationship": {
                "type": "string",
                "description": "...",
                "readOnly": true,
                "nullable": true,
                "enum": [
                  "unknown",
                  "direct",
                  "transitive",
                  "inconclusive"
                ]
              }
            }
          },

Reproduction Steps

Due to the sensitive nature of alerts I cannot provide an explicit example.

主要语言
没有语言数据
星标
1.6k
派生
345
平均合并
6 小时
30 天内合并 PR
82

环境准备

从这里开始

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

github/rest-api-description 的其他 Issue

查看 github/rest-api-description 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

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