pull-request-controller
get/api/pullrequests

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/pullrequests
  • Auth: none declared

Query parameters

pageinteger
sizeinteger
sortFieldstring
sortDirectionstring
filterType'ALL' | 'OPEN' | 'OPEN_READY_FOR_REVIEW' | 'DRAFT' | 'MERGED' | 'CLOSED' | 'USER_AUTHORED' | 'ASSIGNED_TO_USER' | 'REVIEW_REQUESTED'
searchTermstring
authorstring
assigneestring
noAssigneeboolean
labelIdinteger
noLabelboolean
reviewState'NONE' | 'REQUIRED'
requestedReviewerstring

Response

OK

pageNumberinteger
pageSizeinteger
totalNonPinnedinteger
totalPagesinteger

Example response

{
  "pinned": [
    {
      "labels": [
        {
          "name": "bug",
          "color": "ff0000"
        }
      ]
    }
  ],
  "page": [
    {
      "labels": [
        {
          "name": "bug",
          "color": "ff0000"
        }
      ]
    }
  ]
}

Changes

    • ▲

      for the query request parameter filterType, default value OPEN was added

    • ○

      added the new optional query request parameter assignee

    • ○

      added the new optional query request parameter author

    • ○

      added the new optional query request parameter labelId

    • ○

      added the new optional query request parameter noAssignee

    • ○

      added the new optional query request parameter noLabel

    • ○

      added the new optional query request parameter requestedReviewer

    • ○

      added the new optional query request parameter reviewState

    • ▲

      the response's body type changed from array to object for status

    • ○

      api operation id getAllPullRequests removed and replaced with getPullRequests

    • ○

      added the new optional query request parameter filterType

    • ○

      added the new optional query request parameter page

    • ○

      added the new optional query request parameter searchTerm

    • ○

      added the new optional query request parameter size

    • ○

      added the new optional query request parameter sortDirection

    • ○

      added the new optional query request parameter sortField

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status