跳到主要内容

Get Single Pull Request

GET 
/api/v5/repos/:owner/:repo/pulls/:number

Request​

Path Parameters

    owner stringrequired

    Repository space address (organization or individual's address path)

    repo stringrequired

    Repository path (path)

    number integerrequired

    The ordinal number of the PR in this repository, i.e., which PR it is.

    Example: 0

Query Parameters

    access_token string

    User authorization code

Responses​

Successful Response

Response Headers
    Schema
      idintegerrequired
      html_urlstringrequired
      numberintegerrequired

      Serial number

      statestringrequired

      Status, open/closed/merged

      titlestringrequired

      Title

      urlstringrequired

      api url

      issue_urlstringrequired

      Associated issue API URL

      bodystringrequired

      description

      assignees_numberintegerrequired

      Number of reviewers

      assignees object[]required

      Auditor Information

    • Array [
      • idstring
      loginstring
      namestring
      avatar_urlstring
      html_urlstring
      assigneeboolean
      code_ownerboolean
      acceptboolean
    • ]
      • testers object[]required

      Test Person Information

    • Array [
      • idstring
      loginstring
      namestring
      html_urlstring
      assigneeboolean
      code_ownerboolean
      acceptboolean
    • ]
      • approval_reviewers object[]required

      Reviewer Information

    • Array [
      • idstringrequired
      loginstringrequired
      namestringrequired
      html_urlstringrequired
      assigneebooleanrequired
      code_ownerbooleanrequired
      acceptbooleanrequired
      avatar_urlstring
      accept_statusstringrequired

      Approval Status: true (Approved), reject (Rejected), optional (Pending)

    • ]
      • labels object[]required

      Tag Information

    • Array [
      • idintegerrequired
      colorstringrequired
      namestringrequired
      repository_idintegerrequired
      created_atstringrequired
      updated_atstringrequired
    • ]
      • created_atstringrequired

      creation time

      updated_atstringrequired

      Update time

      closed_atstringrequired

      Close time

      merged_atstringrequired

      Merge Time

      draftbooleanrequired

      Is it a draft

      can_merge_checkbooleanrequired

      Is the merge check passed?

      prune_branchbooleanrequired

      Merge and delete the source branch

      mergeablebooleanrequired

      Is there any conflict

      user objectrequired

      Creator Information

      idstringrequired
      loginstringrequired
      namestringrequired
      avatar_urlstringrequired
      html_urlstringrequired
      head objectrequired

      commit message

      refstringrequired

      Branch Path

      shastringrequired

      commit id

      labelstringrequired

      label

      repo objectrequired

      warehouse information

      pathstringrequired
      namestringrequired
      namespace objectrequired
      pathstringrequired
      full_namestringrequired
      html_urlstringrequired
      user objectrequired
      idstringrequired
      loginstringrequired
      namestringrequired
      avatar_urlstringrequired
      html_urlstringrequired
      base objectrequired

      Target branch information

      refstringrequired

      Branch Path

      shastringrequired

      commit id

      labelstringrequired

      label

      repo objectrequired

      warehouse information

      pathstringrequired
      namestringrequired
      namespace objectrequired
      pathstringrequired
      full_namestringrequired
      html_urlstringrequired
      mergeable_state objectrequired

      Access Control Information

      merge_request_idintegerrequired

      Merge Request ID

      statebooleanrequired

      Status

      status_without_user_authbooleanrequired

      Status without user authorization

      conflict_passedbooleanrequired

      Conflict through

      branch_missing_passedbooleanrequired

      Branch missing through

      non_ff_passedbooleanrequired

      Non-skippable through

      mr_state_passedbooleanrequired

      Merge Request Status Through

      merged_by_user_passedbooleanrequired

      User merged through

      work_in_progress_passedbooleanrequired

      Work progress through

      resolve_discussion_passedbooleanrequired

      Resolve discussion passed

      ci_state_passedbooleanrequired

      CI Status via

      merge_by_self_passedbooleanrequired

      Self-merging through

      can_force_mergebooleanrequired

      Allow force merge.

      approval_reviewers_required_passedbooleanrequired

      Is the code review passed?

      approval_approvers_required_passedbooleanrequired

      Is the code approval passed?

      approval_testers_required_passedbooleanrequired

      Code test passed

      merge_request_switch objectrequired

      Merge Request Switch

      review_modestringrequired

      Approval mode

      merge_methodstringrequired

      Merge Method

      only_allow_merge_if_all_discussions_are_resolvedbooleanrequired

      Only allow merge after all discussions are resolved.

      disable_merge_by_selfbooleanrequired

      Prohibit self-merge.

      only_allow_merge_if_pipeline_succeedsbooleanrequired

      Only allow merge after pipeline succeeds.

      disable_squash_mergebooleanrequired

      Prohibit squash merge.

      squash_merge_with_no_merge_commitbooleanrequired

      Squash merge without a merge commit.

      approval_required_reviewers_countintegerrequired

      Number of approvers requiring approval

      approval_required_reviewers_branchstringrequired

      Branch for approvers requiring approval

      add_notes_after_mergedbooleanrequired

      Add comment after merge.

      mark_auto_merged_mr_as_closedbooleanrequired

      Mark automatically merged MRs as closed.

      can_force_mergebooleanrequired

      Allow force merge.

      can_reopenbooleanrequired

      Allow reopening.

      reason objectrequired

      Reason

      object
      check_tasks_numintegerrequired

      Checked Items Total Number

      all_depend_merge_request_merged_passedbooleanrequired

      All dependent pull requests have been merged and passed.

      approval_approvers_resultintegerrequired
      approval_testers_resultintegerrequired
      milestone objectrequired
      created_atstringrequired
      descriptionstringrequired
      numberintegerrequired
      statestringrequired
      titlestringrequired
      updated_atstringrequired
      visibility_reasonstring

      Visibility, public: Publicly visible, other: Visible to project members only

      merged_by objectrequired

      Merged Person

      idstringrequired
      loginstringrequired
      namestringrequired
      avatar_urlstringrequired
      html_urlstringrequired
      close_related_issueboolean

      Is the associated issue closed when merging?

      squash_mergebooleanrequired

      Squash Merge