Skip to main content

Module pull_request

Module pull_request 

Source
Expand description

Pull request endpoints.

Verified against the GitFox API v1.3.0 OpenAPI document:

OperationEndpoint
listGET /api/v1/repos/{repo_ref}/pullreq
viewGET /api/v1/repos/{repo_ref}/pullreq/{pullreq_number}
createPOST /api/v1/repos/{repo_ref}/pullreq
editPATCH …/pullreq/{pullreq_number} (title and description only)
mergePOST …/pullreq/{pullreq_number}/merge
delete branchDELETE …/pullreq/{pullreq_number}/branch
close/reopenPOST …/pullreq/{pullreq_number}/state
draft/readyPOST …/pullreq/{pullreq_number}/state with is_draft
diffGET …/pullreq/{pullreq_number}/diff
checksGET …/pullreq/{pullreq_number}/checks
commitsGET …/pullreq/{pullreq_number}/commits
timelineGET …/pullreq/{pullreq_number}/activities
commentPOST …/pullreq/{pullreq_number}/comments
edit commentPATCH …/comments/{pullreq_comment_id}
delete commentDELETE …/comments/{pullreq_comment_id}
reviewPOST …/pullreq/{pullreq_number}/reviews
reviewersGET / PUT …/reviewers, DELETE …/reviewers/{id}
labelsGET / PUT …/labels, DELETE …/labels/{label_id}

The space-wide listing (GET /spaces/{space_ref}/pullreq) is in the document too, but answers 500 on the instances this was checked against, so nothing here depends on it.

The diff endpoint content-negotiates: application/json yields per-file entries, text/plain a raw unified diff. gf pr diff picks by output mode.

Structs§

PullRequestFilter
Filters for PullRequestsApi::list.
PullRequestsApi