Skip to content

Latest commit

 

History

History
188 lines (120 loc) · 10.3 KB

CommitstatusesApi.md

File metadata and controls

188 lines (120 loc) · 10.3 KB
Raw

\CommitstatusesApi

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

Method HTTP request Description
RepositoriesUsernameRepoSlugCommitNodeStatusesBuildKeyGet Get /repositories/{username}/{repo_slug}/commit/{node}/statuses/build/{key}
RepositoriesUsernameRepoSlugCommitNodeStatusesBuildKeyPut Put /repositories/{username}/{repo_slug}/commit/{node}/statuses/build/{key}
RepositoriesUsernameRepoSlugCommitNodeStatusesBuildPost Post /repositories/{username}/{repo_slug}/commit/{node}/statuses/build
RepositoriesUsernameRepoSlugCommitNodeStatusesGet Get /repositories/{username}/{repo_slug}/commit/{node}/statuses
RepositoriesUsernameRepoSlugPullrequestsPullRequestIdStatusesGet Get /repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/statuses

RepositoriesUsernameRepoSlugCommitNodeStatusesBuildKeyGet

Commitstatus RepositoriesUsernameRepoSlugCommitNodeStatusesBuildKeyGet(ctx, username, node, key, repoSlug)

Returns the specified build status for a commit.

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.
node string The commit's SHA1.
key string The build status' unique key
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

Commitstatus

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]

RepositoriesUsernameRepoSlugCommitNodeStatusesBuildKeyPut

Commitstatus RepositoriesUsernameRepoSlugCommitNodeStatusesBuildKeyPut(ctx, username, node, key, repoSlug, optional)

Used to update the current status of a build status object on the specific commit. This operation can also be used to change other properties of the build status: * state * name * description * url * refname The key cannot be changed.

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.
node string The commit's SHA1.
key string The build status' unique key
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.
node string The commit's SHA1.
key string The build status' unique key
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
body Commitstatus The updated build status object

Return type

Commitstatus

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]

RepositoriesUsernameRepoSlugCommitNodeStatusesBuildPost

Commitstatus RepositoriesUsernameRepoSlugCommitNodeStatusesBuildPost(ctx, username, node, repoSlug, optional)

Creates a new build status against the specified commit. If the specified key already exists, the existing status object will be overwritten. When creating a new commit status, you can use a URI template for the URL. Templates are URLs that contain variable names that Bitbucket will evaluate at runtime whenever the URL is displayed anywhere similar to parameter substitution in Bitbucket Connect. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time. The context variables available are repository and commit.

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.
node string The commit's SHA1.
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.
node string The commit's SHA1.
repoSlug string This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
body Commitstatus The new commit status object.

Return type

Commitstatus

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]

RepositoriesUsernameRepoSlugCommitNodeStatusesGet

PaginatedCommitstatuses RepositoriesUsernameRepoSlugCommitNodeStatusesGet(ctx, username, node, repoSlug)

Returns all statuses (e.g. build results) for a specific commit.

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.
node string The commit's SHA1.
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]

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]