Skip to content

[Schema Inaccuracy] Webhook auto merge for rebase commits #2491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zegl opened this issue Apr 21, 2023 · 0 comments
Open

[Schema Inaccuracy] Webhook auto merge for rebase commits #2491

zegl opened this issue Apr 21, 2023 · 0 comments

Comments

@zegl
Copy link

zegl commented Apr 21, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants