pull-request-webhook

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pull-request-webhook-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pull-request-webhook",
  "title": "pull-request-webhook",
  "allOf": [
    {
      "$ref": "#/components/schemas/pull-request"
    },
    {
      "type": "object",
      "properties": {
        "allow_auto_merge": {
          "description": "Whether to allow auto-merge for pull requests.",
          "type": "boolean",
          "default": false
        },
        "allow_update_branch": {
          "description": "Whether to allow updating the pull request's branch.",
          "type": "boolean"
        },
        "delete_branch_on_merge": {
          "description": "Whether to delete head branches when pull requests are merged.",
          "type": "boolean",
          "default": false
        },
        "merge_commit_message": {
          "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
          "type": "string",
          "enum": [
            "PR_BODY",
            "PR_TITLE",
            "BLANK"
          ]
        },
        "merge_commit_title": {
          "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").",
          "type": "string",
          "enum": [
            "PR_TITLE",
            "MERGE_MESSAGE"
          ]
        },
        "squash_merge_commit_message": {
          "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
          "type": "string",
          "enum": [
            "PR_BODY",
            "COMMIT_MESSAGES",
            "BLANK"
          ]
        },
        "squash_merge_commit_title": {
          "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
          "type": "string",
          "enum": [
            "PR_TITLE",
            "COMMIT_OR_PR_TITLE"
          ]
        },
        "use_squash_pr_title_as_default": {
          "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**",
          "type": "boolean",
          "default": false
        }
      }
    }
  ]
}