[Schema Inaccuracy] Webhook auto merge for rebase commits

Đang mở
#2,491 2 bình luận 1 reaction 1 người được giao Xem trên GitHub

@nickfloyd đang làm issue này rồi.

Từ ngày 6/11/2025.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

feature inaccuracy P4

Schema Inaccuracy

auto_merge.commit_title and auto_merge.commit_message are nullable in practice, but not in the schema.

This is a real webhook from GitHub.com on 2023-04-21.

    "auto_merge": {
      "enabled_by": {
        "login": "zegl",
        "id": 47952,
        "node_id": "MDQ6VXNlcjQ3OTUy",
        "avatar_url": "https://avatars.githubusercontent.com/u/47952?v=4",
        "gravatar_id": "",
        "url": "https://api.github.com/users/zegl",
        "html_url": "https://github.com/zegl",
        "followers_url": "https://api.github.com/users/zegl/followers",
        "following_url": "https://api.github.com/users/zegl/following{/other_user}",
        "gists_url": "https://api.github.com/users/zegl/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/zegl/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/zegl/subscriptions",
        "organizations_url": "https://api.github.com/users/zegl/orgs",
        "repos_url": "https://api.github.com/users/zegl/repos",
        "events_url": "https://api.github.com/users/zegl/events{/privacy}",
        "received_events_url": "https://api.github.com/users/zegl/received_events",
        "type": "User",
        "site_admin": false
      },
      "merge_method": "rebase",
      "commit_title": null,
      "commit_message": null
    },

The schema looks like this:

      "auto-merge": {
        "title": "Auto merge",
        "description": "The status of auto merging a pull request.",
        "type": "object",
        "properties": {
          "enabled_by": {
            "$ref": "#/components/schemas/simple-user"
          },
          "merge_method": {
            "type": "string",
            "description": "The merge method to use.",
            "enum": [
              "merge",
              "squash",
              "rebase"
            ]
          },
          "commit_title": {
            "type": "string",
            "description": "Title for the merge commit message."
          },
          "commit_message": {
            "type": "string",
            "description": "Commit message for the merge commit."
          }
        },
        "required": [
          "enabled_by",
          "merge_method",
          "commit_title",
          "commit_message"
        ],
        "nullable": true
      },

This likely also applies to non webhook payloads.

Expected

commit_title and commit_message should be nullable.

Reproduction Steps

Trigger auto-merge with the rebase merge method, and watch the web hooks.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1.6k
Fork
342
Merge trung bình
3 giờ 33 phút
Pull request đã merge (30 ngày)
51

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/rest-api-description

Tất cả issue của github/rest-api-description

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.