Pull Requests

Convert a pull request to a draft

Convert a pull request to a draft. Requires authenticated authority and enforces current resource policy.

post/api/repos/{owner}/{repo}/pulls/{pr}/draft

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: pr:contents:write

Path parameters

ownerstring required
repostring required
prstring required

Request body

expectedVersioninteger required

Response

Response for status 200

idstring required
numberinteger required
titlestring required
state'open' | 'closed' | 'merged' required
draftboolean required
createdAtstring date-time required
sourceBranchstring required
targetBranchstring required
headOidstring nullable required
authorActorIdstring required
updatedAtstring date-time required
versioninteger required
additionsinteger nullable required
deletionsinteger nullable required
changedFilesinteger nullable required
descriptionstring nullable required
repoIdstring required
sourceRepoIdstring required
isCrossForkboolean required
observedBaseOidstring nullable required
mergeSourceOidstring nullable required
mergeTargetOidBeforestring nullable required
mergeResultOidstring nullable required
authorDelegatorActorIdstring required
authorViaInstallationIdstring nullable required
closedByViaInstallationIdstring nullable required
mergedByDelegatorActorIdstring required
mergedByViaInstallationIdstring nullable required
lockedByActorIdstring required
milestoneIdstring nullable required
closedAtstring date-time nullable required
mergedAtstring date-time nullable required
lockedAtstring date-time nullable required
lockReason'off_topic' | 'too_heated' | 'resolved' | 'spam' | 'null' nullable required
closedByActorIdstring required
closedByDelegatorActorIdstring required
mergedByActorIdstring required
mergeRoute'native' | 'provider' | 'unsupported' required
viewerActorIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.