创建Pull Request¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "title": {
      "description": "Pull Request标题",
      "type": "string",
      "maxLength": 200
    },
    "head": {
      "description": "Pull Request提交的源分支。格式：branch；如果跨仓PR传：username:branch",
      "type": "string"
    },
    "base": {
      "description": "Pull Request提交目标分支的名称",
      "type": "string"
    },
    "body": {
      "description": "Pull Request内容",
      "type": "string",
      "maxLength": 65535
    },
    "milestone_number": {
      "description": "里程碑序号(id)",
      "type": "integer"
    },
    "labels": {
      "description": "用逗号分开的标签，名称要求长度在 2-20 之间且非特殊字符。如: bug,performance",
      "type": "string"
    },
    "assignees": {
      "description": "审查人员username，可多个，半角逗号分隔，如：(username1,username2)；注意：当仓库代码审查设置中已设置【指派审查人员】则此选项无效",
      "type": "string"
    },
    "testers": {
      "description": "测试人员username，可多个，半角逗号分隔，如：(username1,username2)；注意：当仓库代码审查设置中已设置【指派测试人员】则此选项无效",
      "type": "string"
    },
    "prune_source_branch": {
      "description": "合并PR后是否删除源分支",
      "type": "boolean",
      "default": false
    },
    "draft": {
      "description": "是否设置为草稿",
      "type": "boolean",
      "default": false
    },
    "squash": {
      "description": "接受Pull Request时使用扁平化（Squash）合并",
      "type": "boolean",
      "default": false
    },
    "squash_commit_message": {
      "description": "squash提交信息",
      "type": "string"
    },
    "fork_path": {
      "description": "fork项目路径【owner/repo】，跨仓PR 必填。",
      "type": "string"
    },
    "close_related_issue": {
      "description": "合并后是否关闭关联的 Issue，默认根据仓库配置设置",
      "type": "boolean"
    },
    "inner_issue_nums": {
      "description": "分号分隔的issue_iid，格式如 1;2;3 或 issue1;issue2;issue3；跨仓的 #group/project#1 或 #group/project#issue1",
      "type": "string"
    }
  },
  "required": ["title", "head", "base"]
}

{
  "error": "invalid_request",
  "message": "head或base不能为空"
}

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

curl -X POST 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "测试创建PR",
    "head": "dev",
    "base": "main",
    "body": "update: 更新文件 dev_001.txt"
  }'

// 原生 fetch (Node.js 18+ / 浏览器)
const token = "<YOUR-TOKEN>";
const owner = "<owner>";
const repo = "<repo>";

const response = await fetch(
  `https://api.atomgit.com/api/v5/repos/${owner}/${repo}/pulls?access_token=${token}`,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      title: "测试创建PR",
      head: "dev",
      base: "main",
      body: "update: 更新文件 dev_001.txt",
    }),
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls",
    params={"access_token": "<token>"},
    json={
        "title": "测试创建PR",
        "head": "dev",
        "base": "main",
        "body": "update: 更新文件 dev_001.txt",
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

{
  "id": 11264998,
  "url": "https://api.atomgit.com/api/v5/repos/zzero/demo/pulls/6",
  "html_url": "https://api.atomgit.com/zzero/demo/pulls/6",
  "diff_url": "https://api.atomgit.com/zzero/demo/pulls/6.diff",
  "patch_url": "https://api.atomgit.com/zzero/demo/pulls/6.patch",
  "issue_url": "https://api.atomgit.com/api/v5/repos/zzero/demo/pulls/6/issues",
  "commits_url": "https://api.atomgit.com/api/v5/repos/zzero/demo/pulls/6/commits",
  "review_comments_url": "https://api.atomgit.com/api/v5/repos/zzero/demo/pulls/comments/{/number}",
  "review_comment_url": "https://api.atomgit.com/api/v5/repos/zzero/demo/pulls/comments",
  "comments_url": "https://api.atomgit.com/api/v5/repos/zzero/demo/pulls/6/comments",
  "number": 6,
  "title": "测试创建PR",
  "description": "update: 更新文件 dev_001.txt \nupdate: 更新文件 dev_001.txt ",
  "state": "opened",
  "created_at": "2024-04-14T20:53:13.185+08:00",
  "updated_at": "2024-04-14T20:53:22.634+08:00",
  "merged_by": null,
  "merged_at": null,
  "closed_by": null,
  "closed_at": null,
  "title_html": null,
  "description_html": null,
  "target_branch": "test_b5",
  "source_branch": "dev",
  "squash_commit_message": null,
  "user_notes_count": 0,
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 494,
    "name": "csdntest13",
    "username": "csdntest13",
    "iam_id": "d8b3e018b2364546b946886a669d50fc",
    "nick_name": "csdntest13_gitcode",
    "state": "active",
    "avatar_url": "https://api.atomgit.com/avatar.png",
    "avatar_path": null,
    "email": "csdntest13@noreply.atomgit.com",
    "name_cn": "csdntest13",
    "web_url": "https://api.atomgit.com/csdntest13",
    "tenant_name": null,
    "is_member": null
  },
  "assignee": null,
  "source_project_id": 243377,
  "target_project_id": 243377,
  "labels": [
    {
      "id": 381445,
      "name": "help wanted",
      "color": "#008672",
      "created_at": "2024-04-14T20:53:23.021+08:00",
      "updated_at": "2024-04-14T20:53:23.021+08:00"
    }
  ],
  "work_in_progress": false,
  "milestone": null,
  "merge_when_pipeline_succeeds": false,
  "merge_status": "unchecked",
  "sha": "8da7a5c35e71deeb0bf1d9ecae70449c574749f2",
  "merge_commit_sha": null,
  "discussion_locked": null,
  "should_remove_source_branch": false,
  "force_remove_source_branch": false,
  "allow_collaboration": null,
  "allow_maintainer_to_push": null,
  "web_url": "https://api.atomgit.com/One/One/pulls/53",
  "time_stats": {
    "time_estimate": null,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  },
  "squash": false,
  "merge_request_type": "MergeRequest",
  "has_pre_merge_ref": false,
  "review_mode": "approval",
  "is_source_branch_exist": true,
  "approval_merge_request_reviewers": [
    {
      "id": 43,
      "username": "green",
      "name": "green",
      "nick_name": null,
      "name_cn": "green",
      "email": null,
      "state": "optional",
      "is_codeowner": false,
      "updated_at": "2024-04-14T20:53:23.021+08:00",
      "avatar_url": "https://api.atomgit.com/avatar.png"
    }
  ],
  "approval_merge_request_approvers": [
    {
      "id": 277,
      "username": "renww",
      "name": "renww",
      "nick_name": null,
      "name_cn": "renww",
      "email": null,
      "state": "optional",
      "is_codeowner": false,
      "updated_at": "2024-04-14T20:53:23.751+08:00",
      "avatar_url": "https://api.atomgit.com/avatar.png"
    }
  ],
  "approval_merge_request_testers": [
    {
      "id": 43,
      "username": "green",
      "name": "green",
      "nick_name": null,
      "name_cn": "green",
      "email": null,
      "state": "optional",
      "is_codeowner": false,
      "updated_at": "2024-04-14T20:53:23.755+08:00",
      "avatar_url": "https://api.atomgit.com/avatar.png"
    }
  ],
  "source_project": {
    "id": 243377,
    "description": "csdntest13的第一个项目(公开)",
    "name": "One",
    "name_with_namespace": "One / One",
    "path": "One",
    "path_with_namespace": "One/One",
    "develop_mode": "normal",
    "created_at": "2024-03-19T16:24:01.197+08:00",
    "updated_at": "2024-03-19T16:42:34.834+08:00",
    "archived": false,
    "is_kia": false,
    "ssh_url_to_repo": "ssh://git@atomgit.com:2222/One/One.git",
    "http_url_to_repo": "https://api.atomgit.com/One/One.git",
    "web_url": "https://api.atomgit.com/One/One",
    "readme_url": "https://api.atomgit.com/One/One/blob/main/README.md",
    "product_id": "28f96caf52004e81ab0bc38d60d11940",
    "product_name": null,
    "member_mgnt_mode": 3,
    "default_branch": "main",
    "tag_list": [],
    "license_url": null,
    "license": {
      "key": "Apache_License_v2.0",
      "name": null,
      "nickname": null,
      "html_url": null,
      "source_url": null
    },
    "avatar_url": null,
    "star_count": 1,
    "forks_count": 0,
    "open_issues_count": 108,
    "open_merge_requests_count": 32,
    "open_change_requests_count": null,
    "watch_count": 1,
    "last_activity_at": "2024-04-14T20:43:58.602+08:00",
    "namespace": {
      "id": 136909,
      "name": "One",
      "path": "One",
      "develop_mode": "normal",
      "region": null,
      "cell": "default",
      "kind": "group",
      "full_path": "One",
      "full_name": "One ",
      "parent_id": null,
      "visibility_level": 20,
      "enable_file_control": null,
      "owner_id": null
    },
    "empty_repo": false,
    "starred": false,
    "visibility": "public",
    "security": "internal",
    "has_updated_kia": false,
    "network_type": "green",
    "owner": null,
    "creator": {
      "id": 494,
      "name": "csdntest13",
      "username": "csdntest13",
      "iam_id": "d8b3e018b2364546b946886a669d50fc",
      "nick_name": "csdntest13_gitcode",
      "state": "active",
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "avatar_path": null,
      "email": "csdntest13@noreply.atomgit.com",
      "name_cn": "csdntest13",
      "web_url": "https://api.atomgit.com/csdntest13",
      "tenant_name": null,
      "is_member": null
    },
    "creator_id": 494,
    "forked_from_project": null,
    "item_type": "Project",
    "main_repository_language": ["Text", "#cccccc"],
    "mirror_project_data": null,
    "statistics": null,
    "branch_count": null,
    "tag_count": null,
    "member_count": null,
    "repo_replica_urls": null,
    "open_external_wiki": true,
    "release_count": null
  },
  "target_project": {
    "id": 243377,
    "description": "csdntest13的第一个项目(公开)",
    "name": "One",
    "name_with_namespace": "One / One",
    "path": "One",
    "path_with_namespace": "One/One",
    "develop_mode": "normal",
    "created_at": "2024-03-19T16:24:01.197+08:00",
    "updated_at": "2024-03-19T16:42:34.834+08:00",
    "archived": false,
    "is_kia": false,
    "ssh_url_to_repo": "ssh://git@atomgit.com:2222/One/One.git",
    "http_url_to_repo": "https://api.atomgit.com/One/One.git",
    "web_url": "https://api.atomgit.com/One/One",
    "readme_url": "https://api.atomgit.com/One/One/blob/main/README.md",
    "product_id": "28f96caf52004e81ab0bc38d60d11940",
    "product_name": null,
    "member_mgnt_mode": 3,
    "default_branch": "main",
    "tag_list": [],
    "license_url": null,
    "license": {
      "key": "Apache_License_v2.0",
      "name": null,
      "nickname": null,
      "html_url": null,
      "source_url": null
    },
    "avatar_url": null,
    "star_count": 1,
    "forks_count": 0,
    "open_issues_count": 108,
    "open_merge_requests_count": 32,
    "open_change_requests_count": null,
    "watch_count": 1,
    "last_activity_at": "2024-04-14T20:43:58.602+08:00",
    "namespace": {
      "id": 136909,
      "name": "One",
      "path": "One",
      "develop_mode": "normal",
      "region": null,
      "cell": "default",
      "kind": "group",
      "full_path": "One",
      "full_name": "One ",
      "parent_id": null,
      "visibility_level": 20,
      "enable_file_control": null,
      "owner_id": null
    },
    "empty_repo": false,
    "starred": false,
    "visibility": "public",
    "security": "internal",
    "has_updated_kia": false,
    "network_type": "green",
    "owner": null,
    "creator": {
      "id": 494,
      "name": "csdntest13",
      "username": "csdntest13",
      "iam_id": "d8b3e018b2364546b946886a669d50fc",
      "nick_name": "csdntest13_gitcode",
      "state": "active",
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "avatar_path": null,
      "email": "csdntest13@noreply.atomgit.com",
      "name_cn": "csdntest13",
      "web_url": "https://api.atomgit.com/csdntest13",
      "tenant_name": null,
      "is_member": null
    },
    "creator_id": 494,
    "forked_from_project": null,
    "item_type": "Project",
    "main_repository_language": ["Text", "#cccccc"],
    "mirror_project_data": null,
    "statistics": null,
    "branch_count": null,
    "tag_count": null,
    "member_count": null,
    "repo_replica_urls": null,
    "open_external_wiki": true,
    "release_count": null
  },
  "added_lines": 19860,
  "removed_lines": 1,
  "subscribed": true,
  "changes_count": "6",
  "latest_build_started_at": null,
  "latest_build_finished_at": null,
  "first_deployed_to_production_at": null,
  "pipeline": null,
  "diff_refs": {
    "base_sha": "0c02dd57f8945791460a141f155dd2f4bd5dea86",
    "head_sha": "8da7a5c35e71deeb0bf1d9ecae70449c574749f2",
    "start_sha": "fb6495834d1bf7a39dfdb44ad25e6f83c7136310"
  },
  "merge_error": null,
  "json_merge_error": null,
  "rebase_in_progress": null,
  "diverged_commits_count": null,
  "merge_request_assignee_list": [],
  "merge_request_reviewer_list": [],
  "user": {
    "can_merge": true
  },
  "merge_request_review_count": 0,
  "merge_request_reviewers_count": 0,
  "notes": 0,
  "unresolved_discussions_count": 0,
  "e2e_issues": [
    {
      "id": 13588,
      "issue_type": 7,
      "linked_issue_type": null,
      "issue_num": "issue100",
      "commit_id": null,
      "merge_request_id": 68253,
      "check_fail_reason": "",
      "check_result": true,
      "issue_link": "https://api.atomgit.com/One/One/issues/100",
      "created_at": "2024-04-14T20:53:23.772+08:00",
      "mks_id": null,
      "pbi_id": null,
      "pbi_name": null,
      "source": null,
      "issue_project_id": 243377,
      "title": "第45个issue",
      "issue_project": null,
      "auto_c_when_mr_merged": false
    }
  ],
  "gate_check": true,
  "head_pipeline_id": null,
  "pipeline_status": "",
  "codequality_status": "success",
  "pipeline_status_with_code_quality": "",
  "from_forked_project": false,
  "forked_project_name": null,
  "can_delete_source_branch": true,
  "required_reviewers": [],
  "omega_mode": false,
  "root_mr_locked_detail": null,
  "source_git_url": "ssh://git@atomgit.com:2222/One/One.git",
  "auto_merge": null
}