Atlassian · Schema

Pull Request Merge Parameters

The metadata that describes a pull request merge.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
type string
message string The commit message that will be used on the resulting commit.
close_source_branch boolean Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False
merge_strategy string The merge strategy that will be used to merge the pull request.
View JSON Schema on GitHub

JSON Schema

atlassian-pullrequest-merge-parameters-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pullrequest_merge_parameters",
  "title": "Pull Request Merge Parameters",
  "type": "object",
  "description": "The metadata that describes a pull request merge.",
  "properties": {
    "type": {
      "type": "string",
      "example": "example_value"
    },
    "message": {
      "type": "string",
      "description": "The commit message that will be used on the resulting commit.",
      "example": "example_value"
    },
    "close_source_branch": {
      "type": "boolean",
      "description": "Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False",
      "example": true
    },
    "merge_strategy": {
      "type": "string",
      "description": "The merge strategy that will be used to merge the pull request.",
      "enum": [
        "merge_commit",
        "squash",
        "fast_forward"
      ],
      "default": "merge_commit",
      "example": "merge_commit"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": true
}