全量更新一个拉取请求

PUT

https://open.pingcode.com/v1/scm/products/{scm_product_id}/repositories/{scm_product_repository_id}/pull_requests/{scm_pull_request_id}

最后修改时间：2024-01-22 09:22:01

责任人：未设置

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

scm_product_id

string

必需

示例值:

scm_product_repository_id

string

必需

示例值:

scm_pull_request_id

string

必需

示例值:

Body 参数application/json

title

string

必需

number

必需

creator_name

string

必需

description

string

可选

source_branch_id

string

可选

target_branch_id

string

可选

status

string

可选

merged_at

number

可选

merged_commit_sha

string

可选

merged_by_name

string

可选

comments_count

number

可选

review_comments_count

number

可选

commits_count

number

可选

additions_count

number

可选

deletions_count

number

可选

changed_files_count

number

可选

work_item_identifiers

array[string]

必需

示例

{
    "title": "fix(doc): #PLM-001 fix document title",
    "number": 1,
    "creator_name": "terry",
    "description": "Please give some great suggestions",
    "source_branch_id": "564587fe700d43b81b080767",
    "target_branch_id": "564587fe700d43b81b080776",
    "status": "merged",
    "merged_at": 1473018919,
    "merged_commit_sha": "96a024347146ebdc5f481f45e6e6871e0c43af5f",
    "merged_by_name": "terry",
    "comments_count": 2,
    "review_comments_count": 2,
    "commits_count": 2,
    "additions_count": 0,
    "deletions_count": 0,
    "changed_files_count": 3,
    "work_item_identifiers": [
        "PLM-001"
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PUT 'https://open.pingcode.com/v1/scm/products/{{scm_product_id}}/repositories/{{scm_product_repository_id}}/pull_requests/{{scm_pull_request_id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "fix(doc): #PLM-001 fix document title",
    "number": 1,
    "creator_name": "terry",
    "description": "Please give some great suggestions",
    "source_branch_id": "564587fe700d43b81b080767",
    "target_branch_id": "564587fe700d43b81b080776",
    "status": "merged",
    "merged_at": 1473018919,
    "merged_commit_sha": "96a024347146ebdc5f481f45e6e6871e0c43af5f",
    "merged_by_name": "terry",
    "comments_count": 2,
    "review_comments_count": 2,
    "commits_count": 2,
    "additions_count": 0,
    "deletions_count": 0,
    "changed_files_count": 3,
    "work_item_identifiers": [
        "PLM-001"
    ]
}'

返回响应

🟠400请求有误

application/json

Body

string

必需

url

string

必需

product

object

必需

string

必需

url

string

必需

name

string

必需

type

string

必需

repository

object

必需

string

必需

url

string

必需

name

string

必需

full_name

string

必需

created_at

integer

必需

title

string

必需

number

integer

必需

status

string

必需

description

string

必需

author

object

必需

string

必需

url

string

必需

name

string

必需

source_branch

object

必需

string

必需

url

string

必需

name

string

必需

create_at

integer

必需

target_branch

object

必需

string

必需

url

string

必需

name

string

必需

create_at

integer

必需

created_at

integer

必需

merged_at

integer

必需

merged_commit_sha

string

必需

merged_by

object

必需

string

必需

url

string

必需

name

string

必需

comments_count

integer

必需

review_comments_count

integer

必需

commits_count

integer

必需

additions_count

integer

必需

deletions_count

integer

必需

changed_files_count

integer

必需

work_items

array [object {8}]

必需

string

可选

url

string

可选

identifier

string

可选

title

string

可选

type

string

可选

start_at

integer

可选

end_at

integer

可选

parent_id

string

可选

示例

{
    "id": "594587fe700d43b81b080789",
    "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765/repositories/564587fe700d43b81b080766/pull_requests/594587fe700d43b81b080789",
    "product": {
        "id": "564587fe700d43b81b080765",
        "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765",
        "name": "Github",
        "type": "github"
    },
    "repository": {
        "id": "564587fe700d43b81b080766",
        "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765/repositories/564587fe700d43b81b080766",
        "name": "ngx-planet",
        "full_name": "worktile/ngx-planet",
        "created_at": 1403018919
    },
    "title": "fix(doc): #PLM-001 fix document title",
    "number": 1,
    "status": "merged",
    "description": "Please give some great suggestions",
    "author": {
        "id": "5666aea91f99e33cb7c44964",
        "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765/users/5666aea91f99e33cb7c44964",
        "name": "terry"
    },
    "source_branch": {
        "id": "564587fe700d43b81b080767",
        "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765/repositories/564587fe700d43b81b080766/branches/564587fe700d43b81b080767",
        "name": "terry/#PLM-001",
        "create_at": 1403018919
    },
    "target_branch": {
        "id": "564587fe700d43b81b080776",
        "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765/repositories/564587fe700d43b81b080766/branches/564587fe700d43b81b080776",
        "name": "develop",
        "create_at": 1402018919
    },
    "created_at": 1403014000,
    "merged_at": 1473018919,
    "merged_commit_sha": "96a024347146ebdc5f481f45e6e6871e0c43af5f",
    "merged_by": {
        "id": "5666aea91f99e33cb7c44968",
        "url": "https://rest_api_root/v1/scm/products/564587fe700d43b81b080765/users/5666aea91f99e33cb7c44964",
        "name": "terry"
    },
    "comments_count": 2,
    "review_comments_count": 2,
    "commits_count": 2,
    "additions_count": 0,
    "deletions_count": 0,
    "changed_files_count": 3,
    "work_items": [
        {
            "id": "564587fe700d43b81b080ab8",
            "url": "https://rest_api_root/v1/project/work_items/564587fe700d43b81b080ab8",
            "identifier": "PLM-001",
            "title": "这是一个用户故事",
            "type": "story",
            "start_at": 1583290309,
            "end_at": 1583290347,
            "parent_id": "5edca524cad2fa112b06105c"
        }
    ]
}

创建一个拉取请求

部分更新一个拉取请求