Azure DevOps · Schema

GitPullRequestCreateRequest

Request to create a new pull request

AgileCI/CDDevOpsProject ManagementVersion Control

Properties

Name Type Description
title string Title for the pull request
description string Description of the changes
sourceRefName string Source branch containing the changes
targetRefName string Target branch for the merge
reviewers array Initial reviewers to assign
isDraft boolean Whether to create as a draft pull request
workItemRefs array Work items to associate with this pull request
labels array Labels to attach to this pull request
View JSON Schema on GitHub

JSON Schema

microsoft-azure-devops-gitpullrequestcreaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GitPullRequestCreateRequest",
  "title": "GitPullRequestCreateRequest",
  "type": "object",
  "description": "Request to create a new pull request",
  "required": [
    "title",
    "sourceRefName",
    "targetRefName"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Title for the pull request"
    },
    "description": {
      "type": "string",
      "description": "Description of the changes"
    },
    "sourceRefName": {
      "type": "string",
      "description": "Source branch containing the changes",
      "example": "refs/heads/feature/my-feature"
    },
    "targetRefName": {
      "type": "string",
      "description": "Target branch for the merge",
      "example": "refs/heads/main"
    },
    "reviewers": {
      "type": "array",
      "description": "Initial reviewers to assign",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    },
    "isDraft": {
      "type": "boolean",
      "description": "Whether to create as a draft pull request",
      "default": false
    },
    "workItemRefs": {
      "type": "array",
      "description": "Work items to associate with this pull request",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      }
    },
    "labels": {
      "type": "array",
      "description": "Labels to attach to this pull request",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}