Skip to content

Latest commit

 

History

History
877 lines (550 loc) · 43.7 KB

PullrequestsApi.md

File metadata and controls

877 lines (550 loc) · 43.7 KB
Raw

\PullrequestsApi

All URIs are relative to https://api.bitbucket.org/2.0

Method HTTP request Description
GetPullrequestsForCommit Get /repositories/{username}/{repo_slug}/commit/{commit}/pullrequests Returns a paginated list of all pull requests as part of which this commit was reviewed.
PullrequestsTargetUserGet Get /pullrequests/{target_user}
RepositoriesUsernameRepoSlugDefaultReviewersGet Get /repositories/{username}/{repo_slug}/default-reviewers
RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernameDelete Delete /repositories/{username}/{repo_slug}/default-reviewers/{target_username}
RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernameGet Get /repositories/{username}/{repo_slug}/default-reviewers/{target_username}
RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernamePut Put /repositories/{username}/{repo_slug}/default-reviewers/{target_username}
RepositoriesUsernameRepoSlugPullrequestsActivityGet Get /repositories/{username}/{repo_slug}/pullrequests/activity
RepositoriesUsernameRepoSlugPullrequestsGet Get /repositories/{username}/{repo_slug}/pullrequests
RepositoriesUsernameRepoSlugPullrequestsPost Post /repositories/{username}/{repo_slug}/pullrequests
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdActivityGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/activity
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdApproveDelete Delete /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/approve
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprovePost Post /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/approve
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdDelete Delete /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdPut Put /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsPost Post /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommitsGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/commits
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDeclinePost Post /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/decline
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiffGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/diff
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiffstatGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/diffstat
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdMergePost Post /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/merge
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdPatchGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/patch
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdPut Put /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdStatusesGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/statuses

GetPullrequestsForCommit

PaginatedPullrequests GetPullrequestsForCommit(ctx, username, repoSlug, commit, optional) Returns a paginated list of all pull requests as part of which this commit was reviewed.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string The account; either the UUID in curly braces, or the account_id
repoSlug string The repository; either the UUID in curly braces, or the slug
commit string The SHA1 of the commit
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string The account; either the UUID in curly braces, or the account_id
repoSlug string The repository; either the UUID in curly braces, or the slug
commit string The SHA1 of the commit
page int32 Which page to retrieve [default to 1]
pagelen int32 How many pull requests to retrieve per page [default to 30]

Return type

PaginatedPullrequests

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PullrequestsTargetUserGet

PaginatedPullrequests PullrequestsTargetUserGet(ctx, targetUser, username, optional)

Returns all pull requests authored by the specified user. By default only open pull requests are returned. This can be controlled using the state query parameter. To retrieve pull requests that are in one of multiple states, repeat the state parameter for each individual state. This endpoint also supports filtering and sorting of the results. See filtering and sorting for more details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
targetUser string
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
targetUser string
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
state string Only return pull requests that are in this state. This parameter can be repeated.

Return type

PaginatedPullrequests

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugDefaultReviewersGet

RepositoriesUsernameRepoSlugDefaultReviewersGet(ctx, username, repoSlug)

Returns the repository's default reviewers. These are the users that are automatically added as reviewers on every new pull request that is created.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernameDelete

ModelError RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernameDelete(ctx, username, repoSlug, targetUsername)

Removes a default reviewer from the repository.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
targetUsername string This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: `{account UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernameGet

ModelError RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernameGet(ctx, username, repoSlug, targetUsername)

Returns the specified reviewer. This can be used to test whether a user is among the repository's default reviewers list. A 404 indicates that that specified user is not a default reviewer.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
targetUsername string This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: `{account UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernamePut

ModelError RepositoriesUsernameRepoSlugDefaultReviewersTargetUsernamePut(ctx, username, repoSlug, targetUsername)

Adds the specified user to the repository's list of default reviewers. This method is idempotent. Adding a user a second time has no effect.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
targetUsername string This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: `{account UUID}`.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsActivityGet

RepositoriesUsernameRepoSlugPullrequestsActivityGet(ctx, username, repoSlug, pullRequestId)

Returns a paginated list of the pull request's activity log. This includes comments that were made by the reviewers, updates and approvals.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsGet

PaginatedPullrequests RepositoriesUsernameRepoSlugPullrequestsGet(ctx, username, repoSlug, optional)

Returns all pull requests on the specified repository. By default only open pull requests are returned. This can be controlled using the state query parameter. To retrieve pull requests that are in one of multiple states, repeat the state parameter for each individual state. This endpoint also supports filtering and sorting of the results. See filtering and sorting for more details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
state string Only return pull requests that are in this state. This parameter can be repeated.

Return type

PaginatedPullrequests

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPost

Pullrequest RepositoriesUsernameRepoSlugPullrequestsPost(ctx, username, repoSlug, optional)

Creates a new pull request where the destination repository is this repository and the author is the authenticated user. The minimum required fields to create a pull request are title and source, specified by a branch name. curl https://api.bitbucket.org/2.0/repositories/my-username/my-repository/pullrequests \\ -u my-username:my-password \\ --request POST \\ --header 'Content-Type: application/json' \\ --data '{ \"title\": \"My Title\", \"source\": { \"branch\": { \"name\": \"staging\" } } }' If the pull request's destination is not specified, it will default to the repository.mainbranch. To open a pull request to a different branch, say from a feature branch to a staging branch, specify a destination (same format as the source): { \"title\": \"My Title\", \"source\": { \"branch\": { \"name\": \"my-feature-branch\" } }, \"destination\": { \"branch\": { \"name\": \"staging\" } } } Reviewers can be specified by adding an array of user objects as the reviewers property. { \"title\": \"My Title\", \"source\": { \"branch\": { \"name\": \"my-feature-branch\" } }, \"reviewers\": [ { \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\" } ] } Other fields: * description - a string * close_source_branch - boolean that specifies if the source branch should be closed upon merging

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
body Pullrequest The new pull request. The request URL you POST to becomes the destination repository URL. For this reason, you must specify an explicit source repository in the request object if you want to pull from a different repository (fork). Since not all elements are required or even mutable, you only need to include the elements you want to initialize, such as the source branch and the title.

Return type

Pullrequest

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdActivityGet

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdActivityGet(ctx, username, repoSlug, pullRequestId)

Returns a paginated list of the pull request's activity log. This includes comments that were made by the reviewers, updates and approvals.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdApproveDelete

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdApproveDelete(ctx, username, pullRequestId, repoSlug)

Redact the authenticated user's approval of the specified pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprovePost

Participant RepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprovePost(ctx, username, pullRequestId, repoSlug)

Approve the specified pull request as the authenticated user.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

Participant

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdDelete

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdDelete(ctx, username, pullRequestId, commentId, repoSlug)

Deletes a specific pull request comment.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
commentId string
repoSlug string

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdGet

PullrequestComment RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdGet(ctx, username, pullRequestId, commentId, repoSlug)

Returns a specific pull request comment.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
commentId string
repoSlug string

Return type

PullrequestComment

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdPut

PullrequestComment RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentIdPut(ctx, username, pullRequestId, commentId, repoSlug, body)

Updates a specific pull request comment.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
commentId string
repoSlug string
body PullrequestComment The contents of the updated comment.

Return type

PullrequestComment

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsGet

PaginatedPullrequestComments RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsGet(ctx, username, repoSlug, pullRequestId)

Returns a paginated list of the pull request's comments. This includes both global, inline comments and replies. The default sorting is oldest to newest and can be overridden with the sort query parameter. This endpoint also supports filtering and sorting of the results. See filtering and sorting for more details.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.

Return type

PaginatedPullrequestComments

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsPost

PullrequestComment RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsPost(ctx, username, repoSlug, pullRequestId, body)

Creates a new pull request comment. Returns the newly created pull request comment.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.
body PullrequestComment The comment object.

Return type

PullrequestComment

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommitsGet

ModelError RepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommitsGet(ctx, username, pullRequestId, repoSlug)

Returns a paginated list of the pull request's commits. These are the commits that are being merged into the destination branch when the pull requests gets accepted.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDeclinePost

Pullrequest RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDeclinePost(ctx, username, pullRequestId, repoSlug)

Declines the pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

Pullrequest

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiffGet

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiffGet(ctx, username, pullRequestId, repoSlug)

Redirects to the repository diff with the revspec that corresponds to the pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiffstatGet

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiffstatGet(ctx, username, pullRequestId, repoSlug)

Redirects to the repository diffstat with the revspec that corresponds to the pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdGet

Pullrequest RepositoriesUsernameRepoSlugPullrequestsPullRequestIdGet(ctx, username, repoSlug, pullRequestId)

Returns the specified pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.

Return type

Pullrequest

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdMergePost

Pullrequest RepositoriesUsernameRepoSlugPullrequestsPullRequestIdMergePost(ctx, username, pullRequestId, repoSlug, optional)

Merges the pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string
pullRequestId string
repoSlug string
body PullrequestMergeParameters

Return type

Pullrequest

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdPatchGet

ModelError RepositoriesUsernameRepoSlugPullrequestsPullRequestIdPatchGet(ctx, username, pullRequestId, repoSlug)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string
pullRequestId string
repoSlug string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdPut

Pullrequest RepositoriesUsernameRepoSlugPullrequestsPullRequestIdPut(ctx, username, repoSlug, pullRequestId, optional)

Mutates the specified pull request. This can be used to change the pull request's branches or description. Only open pull requests can be mutated.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
pullRequestId int32 The id of the pull request.
body Pullrequest The pull request that is to be updated.

Return type

Pullrequest

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoriesUsernameRepoSlugPullrequestsPullRequestIdStatusesGet

PaginatedCommitstatuses RepositoriesUsernameRepoSlugPullrequestsPullRequestIdStatusesGet(ctx, username, pullRequestId, repoSlug)

Returns all statuses (e.g. build results) for the given pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
username string This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
pullRequestId int32 The id of the pull request.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.

Return type

PaginatedCommitstatuses

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]