# README
Go API client for bitbucket
Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 2.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://support.atlassian.com/bitbucket-cloud/
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import bitbucket "github.com/finiteinfinity/bitbucket-openapi-go"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), bitbucket.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), bitbucket.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), bitbucket.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), bitbucket.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to https://api.bitbucket.org/2.0
Class | Method | HTTP request | Description |
---|---|---|---|
AddonApi | AddonDelete | Delete /addon | Delete an app |
AddonApi | AddonLinkersGet | Get /addon/linkers | List linkers for an app |
AddonApi | AddonLinkersLinkerKeyGet | Get /addon/linkers/{linker_key} | Get a linker for an app |
AddonApi | AddonLinkersLinkerKeyValuesDelete | Delete /addon/linkers/{linker_key}/values | Delete all linker values |
AddonApi | AddonLinkersLinkerKeyValuesGet | Get /addon/linkers/{linker_key}/values | List linker values for a linker |
AddonApi | AddonLinkersLinkerKeyValuesPost | Post /addon/linkers/{linker_key}/values | Create a linker value |
AddonApi | AddonLinkersLinkerKeyValuesPut | Put /addon/linkers/{linker_key}/values | Update a linker value |
AddonApi | AddonLinkersLinkerKeyValuesValueIdDelete | Delete /addon/linkers/{linker_key}/values/{value_id} | Delete a linker value |
AddonApi | AddonLinkersLinkerKeyValuesValueIdGet | Get /addon/linkers/{linker_key}/values/{value_id} | Get a linker value |
AddonApi | AddonPut | Put /addon | Update an installed app |
BranchRestrictionsApi | RepositoriesWorkspaceRepoSlugBranchRestrictionsGet | Get /repositories/{workspace}/{repo_slug}/branch-restrictions | List branch restrictions |
BranchRestrictionsApi | RepositoriesWorkspaceRepoSlugBranchRestrictionsIdDelete | Delete /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} | Delete a branch restriction rule |
BranchRestrictionsApi | RepositoriesWorkspaceRepoSlugBranchRestrictionsIdGet | Get /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} | Get a branch restriction rule |
BranchRestrictionsApi | RepositoriesWorkspaceRepoSlugBranchRestrictionsIdPut | Put /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} | Update a branch restriction rule |
BranchRestrictionsApi | RepositoriesWorkspaceRepoSlugBranchRestrictionsPost | Post /repositories/{workspace}/{repo_slug}/branch-restrictions | Create a branch restriction rule |
BranchingModelApi | RepositoriesWorkspaceRepoSlugBranchingModelGet | Get /repositories/{workspace}/{repo_slug}/branching-model | Get the branching model for a repository |
BranchingModelApi | RepositoriesWorkspaceRepoSlugBranchingModelSettingsGet | Get /repositories/{workspace}/{repo_slug}/branching-model/settings | Get the branching model config for a repository |
BranchingModelApi | RepositoriesWorkspaceRepoSlugBranchingModelSettingsPut | Put /repositories/{workspace}/{repo_slug}/branching-model/settings | Update the branching model config for a repository |
CommitStatusesApi | RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyGet | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key} | Get a build status for a commit |
CommitStatusesApi | RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyPut | Put /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key} | Update a build status for a commit |
CommitStatusesApi | RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildPost | Post /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build | Create a build status for a commit |
CommitStatusesApi | RepositoriesWorkspaceRepoSlugCommitCommitStatusesGet | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses | List commit statuses for a commit |
CommitStatusesApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses | List commit statuses for a pull request |
CommitsApi | BulkCreateOrUpdateAnnotations | Post /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations | Bulk create or update annotations |
CommitsApi | CreateOrUpdateAnnotation | Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} | Create or update an annotation |
CommitsApi | CreateOrUpdateReport | Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} | Create or update a report |
CommitsApi | DeleteAnnotation | Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} | Delete an annotation |
CommitsApi | DeleteReport | Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} | Delete a report |
CommitsApi | GetAnnotation | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} | Get an annotation |
CommitsApi | GetAnnotationsForReport | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations | List annotations |
CommitsApi | GetReport | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} | Get a report |
CommitsApi | GetReportsForCommit | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports | List reports |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitCommitApproveDelete | Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/approve | Unapprove a commit |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitCommitApprovePost | Post /repositories/{workspace}/{repo_slug}/commit/{commit}/approve | Approve a commit |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitCommitCommentsCommentIdGet | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id} | Get a commit comment |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitCommitCommentsGet | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/comments | List a commit's comments |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitCommitCommentsPost | Post /repositories/{workspace}/{repo_slug}/commit/{commit}/comments | Create comment for a commit |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitCommitGet | Get /repositories/{workspace}/{repo_slug}/commit/{commit} | Get a commit |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitsGet | Get /repositories/{workspace}/{repo_slug}/commits | List commits |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitsPost | Post /repositories/{workspace}/{repo_slug}/commits | List commits with include/exclude |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitsRevisionGet | Get /repositories/{workspace}/{repo_slug}/commits/{revision} | List commits for revision |
CommitsApi | RepositoriesWorkspaceRepoSlugCommitsRevisionPost | Post /repositories/{workspace}/{repo_slug}/commits/{revision} | List commits for revision using include/exclude |
CommitsApi | RepositoriesWorkspaceRepoSlugDiffSpecGet | Get /repositories/{workspace}/{repo_slug}/diff/{spec} | Compare two commits |
CommitsApi | RepositoriesWorkspaceRepoSlugDiffstatSpecGet | Get /repositories/{workspace}/{repo_slug}/diffstat/{spec} | Compare two commit diff stats |
CommitsApi | RepositoriesWorkspaceRepoSlugMergeBaseRevspecGet | Get /repositories/{workspace}/{repo_slug}/merge-base/{revspec} | Get the common ancestor between two commits |
CommitsApi | RepositoriesWorkspaceRepoSlugPatchSpecGet | Get /repositories/{workspace}/{repo_slug}/patch/{spec} | Get a patch for two commits |
DeploymentsApi | CreateEnvironment | Post /repositories/{workspace}/{repo_slug}/environments/ | Create an environment |
DeploymentsApi | DeleteEnvironmentForRepository | Delete /repositories/{workspace}/{repo_slug}/environments/{environment_uuid} | Delete an environment |
DeploymentsApi | GetDeploymentForRepository | Get /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid} | Get a deployment |
DeploymentsApi | GetDeploymentsForRepository | Get /repositories/{workspace}/{repo_slug}/deployments/ | List deployments |
DeploymentsApi | GetEnvironmentForRepository | Get /repositories/{workspace}/{repo_slug}/environments/{environment_uuid} | Get an environment |
DeploymentsApi | GetEnvironmentsForRepository | Get /repositories/{workspace}/{repo_slug}/environments/ | List environments |
DeploymentsApi | RepositoriesWorkspaceRepoSlugDeployKeysGet | Get /repositories/{workspace}/{repo_slug}/deploy-keys | List deploy keys |
DeploymentsApi | RepositoriesWorkspaceRepoSlugDeployKeysKeyIdDelete | Delete /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id} | Delete a deploy key |
DeploymentsApi | RepositoriesWorkspaceRepoSlugDeployKeysKeyIdGet | Get /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id} | Get a deploy key |
DeploymentsApi | RepositoriesWorkspaceRepoSlugDeployKeysKeyIdPut | Put /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id} | Update a deploy key |
DeploymentsApi | RepositoriesWorkspaceRepoSlugDeployKeysPost | Post /repositories/{workspace}/{repo_slug}/deploy-keys | Add a deploy key |
DeploymentsApi | UpdateEnvironmentForRepository | Post /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes/ | Update an environment |
DownloadsApi | RepositoriesWorkspaceRepoSlugDownloadsFilenameDelete | Delete /repositories/{workspace}/{repo_slug}/downloads/{filename} | Delete a download artifact |
DownloadsApi | RepositoriesWorkspaceRepoSlugDownloadsFilenameGet | Get /repositories/{workspace}/{repo_slug}/downloads/{filename} | Get a download artifact link |
DownloadsApi | RepositoriesWorkspaceRepoSlugDownloadsGet | Get /repositories/{workspace}/{repo_slug}/downloads | List download artifacts |
DownloadsApi | RepositoriesWorkspaceRepoSlugDownloadsPost | Post /repositories/{workspace}/{repo_slug}/downloads | Upload a download artifact |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugComponentsComponentIdGet | Get /repositories/{workspace}/{repo_slug}/components/{component_id} | Get a component for issues |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugComponentsGet | Get /repositories/{workspace}/{repo_slug}/components | List components |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesExportPost | Post /repositories/{workspace}/{repo_slug}/issues/export | Export issues |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesExportRepoNameIssuesTaskIdZipGet | Get /repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip | Check issue export status |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesGet | Get /repositories/{workspace}/{repo_slug}/issues | List issues |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesImportGet | Get /repositories/{workspace}/{repo_slug}/issues/import | Check issue import status |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesImportPost | Post /repositories/{workspace}/{repo_slug}/issues/import | Import issues |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments | List attachments for an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path} | Delete an attachment for an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path} | Get attachment for an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPost | Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments | Upload an attachment to an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesChangeIdGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id} | Get issue change object |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes | List changes on an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesPost | Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes | Modify the state of an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} | Delete a comment on an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} | Get a comment on an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdPut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id} | Update a comment on an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments | List comments on an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsPost | Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments | Create a comment on an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id} | Delete an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id} | Get an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdPut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id} | Update an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote | Remove vote for an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote | Check if current user voted for an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdVotePut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote | Vote for an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchDelete | Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch | Stop watching an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchGet | Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch | Check if current user is watching a issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchPut | Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch | Watch an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugIssuesPost | Post /repositories/{workspace}/{repo_slug}/issues | Create an issue |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugMilestonesGet | Get /repositories/{workspace}/{repo_slug}/milestones | List milestones |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugMilestonesMilestoneIdGet | Get /repositories/{workspace}/{repo_slug}/milestones/{milestone_id} | Get a milestone |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugVersionsGet | Get /repositories/{workspace}/{repo_slug}/versions | List defined versions for issues |
IssueTrackerApi | RepositoriesWorkspaceRepoSlugVersionsVersionIdGet | Get /repositories/{workspace}/{repo_slug}/versions/{version_id} | Get a defined version for issues |
PipelinesApi | CreateDeploymentVariable | Post /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables | Create a variable for an environment |
PipelinesApi | CreatePipelineForRepository | Post /repositories/{workspace}/{repo_slug}/pipelines/ | Run a pipeline |
PipelinesApi | CreatePipelineVariableForTeam | Post /teams/{username}/pipelines_config/variables/ | Create a variable for a user |
PipelinesApi | CreatePipelineVariableForUser | Post /users/{selected_user}/pipelines_config/variables/ | Create a variable for a user |
PipelinesApi | CreatePipelineVariableForWorkspace | Post /workspaces/{workspace}/pipelines-config/variables | Create a variable for a workspace |
PipelinesApi | CreateRepositoryPipelineKnownHost | Post /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/ | Create a known host |
PipelinesApi | CreateRepositoryPipelineSchedule | Post /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/ | Create a schedule |
PipelinesApi | CreateRepositoryPipelineVariable | Post /repositories/{workspace}/{repo_slug}/pipelines_config/variables/ | Create a variable for a repository |
PipelinesApi | DeleteDeploymentVariable | Delete /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} | Delete a variable for an environment |
PipelinesApi | DeletePipelineVariableForTeam | Delete /teams/{username}/pipelines_config/variables/{variable_uuid} | Delete a variable for a team |
PipelinesApi | DeletePipelineVariableForUser | Delete /users/{selected_user}/pipelines_config/variables/{variable_uuid} | Delete a variable for a user |
PipelinesApi | DeletePipelineVariableForWorkspace | Delete /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} | Delete a variable for a workspace |
PipelinesApi | DeleteRepositoryPipelineCache | Delete /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid} | Delete a cache |
PipelinesApi | DeleteRepositoryPipelineKeyPair | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair | Delete SSH key pair |
PipelinesApi | DeleteRepositoryPipelineKnownHost | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} | Delete a known host |
PipelinesApi | DeleteRepositoryPipelineSchedule | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} | Delete a schedule |
PipelinesApi | DeleteRepositoryPipelineVariable | Delete /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} | Delete a variable for a repository |
PipelinesApi | GetDeploymentVariables | Get /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables | List variables for an environment |
PipelinesApi | GetOIDCConfiguration | Get /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration | Get OpenID configuration for OIDC in Pipelines |
PipelinesApi | GetOIDCKeys | Get /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json | Get keys for OIDC in Pipelines |
PipelinesApi | GetPipelineContainerLog | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid} | Get the logs for the build container or a service container for a given step of a pipeline. |
PipelinesApi | GetPipelineForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid} | Get a pipeline |
PipelinesApi | GetPipelineStepForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid} | Get a step of a pipeline |
PipelinesApi | GetPipelineStepLogForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log | Get log file for a step |
PipelinesApi | GetPipelineStepsForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/ | List steps for a pipeline |
PipelinesApi | GetPipelineTestReportTestCaseReasons | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons | Get test case reasons (output) for a given test case in a step of a pipeline. |
PipelinesApi | GetPipelineTestReportTestCases | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases | Get test cases for a given step of a pipeline. |
PipelinesApi | GetPipelineTestReports | Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports | Get a summary of test reports for a given step of a pipeline. |
PipelinesApi | GetPipelineVariableForTeam | Get /teams/{username}/pipelines_config/variables/{variable_uuid} | Get a variable for a team |
PipelinesApi | GetPipelineVariableForUser | Get /users/{selected_user}/pipelines_config/variables/{variable_uuid} | Get a variable for a user |
PipelinesApi | GetPipelineVariableForWorkspace | Get /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} | Get variable for a workspace |
PipelinesApi | GetPipelineVariablesForTeam | Get /teams/{username}/pipelines_config/variables/ | List variables for an account |
PipelinesApi | GetPipelineVariablesForUser | Get /users/{selected_user}/pipelines_config/variables/ | List variables for a user |
PipelinesApi | GetPipelineVariablesForWorkspace | Get /workspaces/{workspace}/pipelines-config/variables | List variables for a workspace |
PipelinesApi | GetPipelinesForRepository | Get /repositories/{workspace}/{repo_slug}/pipelines/ | List pipelines |
PipelinesApi | GetRepositoryPipelineCacheContentURI | Get /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri | Get cache content URI |
PipelinesApi | GetRepositoryPipelineCaches | Get /repositories/{workspace}/{repo_slug}/pipelines-config/caches/ | List caches |
PipelinesApi | GetRepositoryPipelineConfig | Get /repositories/{workspace}/{repo_slug}/pipelines_config | Get configuration |
PipelinesApi | GetRepositoryPipelineKnownHost | Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} | Get a known host |
PipelinesApi | GetRepositoryPipelineKnownHosts | Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/ | List known hosts |
PipelinesApi | GetRepositoryPipelineSchedule | Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} | Get a schedule |
PipelinesApi | GetRepositoryPipelineScheduleExecutions | Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions/ | List executions of a schedule |
PipelinesApi | GetRepositoryPipelineSchedules | Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/ | List schedules |
PipelinesApi | GetRepositoryPipelineSshKeyPair | Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair | Get SSH key pair |
PipelinesApi | GetRepositoryPipelineVariable | Get /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} | Get a variable for a repository |
PipelinesApi | GetRepositoryPipelineVariables | Get /repositories/{workspace}/{repo_slug}/pipelines_config/variables/ | List variables for a repository |
PipelinesApi | StopPipeline | Post /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline | Stop a pipeline |
PipelinesApi | UpdateDeploymentVariable | Put /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} | Update a variable for an environment |
PipelinesApi | UpdatePipelineVariableForTeam | Put /teams/{username}/pipelines_config/variables/{variable_uuid} | Update a variable for a team |
PipelinesApi | UpdatePipelineVariableForUser | Put /users/{selected_user}/pipelines_config/variables/{variable_uuid} | Update a variable for a user |
PipelinesApi | UpdatePipelineVariableForWorkspace | Put /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} | Update variable for a workspace |
PipelinesApi | UpdateRepositoryBuildNumber | Put /repositories/{workspace}/{repo_slug}/pipelines_config/build_number | Update the next build number |
PipelinesApi | UpdateRepositoryPipelineConfig | Put /repositories/{workspace}/{repo_slug}/pipelines_config | Update configuration |
PipelinesApi | UpdateRepositoryPipelineKeyPair | Put /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair | Update SSH key pair |
PipelinesApi | UpdateRepositoryPipelineKnownHost | Put /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} | Update a known host |
PipelinesApi | UpdateRepositoryPipelineSchedule | Put /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} | Update a schedule |
PipelinesApi | UpdateRepositoryPipelineVariable | Put /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} | Update a variable for a repository |
ProjectsApi | TeamsUsernameProjectsGet | Get /teams/{username}/projects/ | List a projects for a team |
ProjectsApi | TeamsUsernameProjectsPost | Post /teams/{username}/projects/ | Create a project for a team |
ProjectsApi | TeamsUsernameProjectsProjectKeyDelete | Delete /teams/{username}/projects/{project_key} | Delete a project |
ProjectsApi | TeamsUsernameProjectsProjectKeyGet | Get /teams/{username}/projects/{project_key} | Get a project |
ProjectsApi | TeamsUsernameProjectsProjectKeyPut | Put /teams/{username}/projects/{project_key} | Update a project |
ProjectsApi | WorkspacesWorkspaceProjectsPost | Post /workspaces/{workspace}/projects | Create a project in a workspace |
ProjectsApi | WorkspacesWorkspaceProjectsProjectKeyDelete | Delete /workspaces/{workspace}/projects/{project_key} | Delete a project for a workspace |
ProjectsApi | WorkspacesWorkspaceProjectsProjectKeyGet | Get /workspaces/{workspace}/projects/{project_key} | Get a project for a workspace |
ProjectsApi | WorkspacesWorkspaceProjectsProjectKeyPut | Put /workspaces/{workspace}/projects/{project_key} | Update a project for a workspace |
PropertiesApi | DeleteCommitHostedPropertyValue | Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} | Delete a commit application property |
PropertiesApi | DeletePullRequestHostedPropertyValue | Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} | Delete a pull request application property |
PropertiesApi | DeleteRepositoryHostedPropertyValue | Delete /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} | Delete a repository application property |
PropertiesApi | DeleteUserHostedPropertyValue | Delete /users/{selected_user}/properties/{app_key}/{property_name} | Delete a user application property |
PropertiesApi | GetCommitHostedPropertyValue | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} | Get a commit application property |
PropertiesApi | GetPullRequestHostedPropertyValue | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} | Get a pull request application property |
PropertiesApi | GetRepositoryHostedPropertyValue | Get /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} | Get a repository application property |
PropertiesApi | RetrieveUserHostedPropertyValue | Get /users/{selected_user}/properties/{app_key}/{property_name} | Get a user application property |
PropertiesApi | UpdateCommitHostedPropertyValue | Put /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} | Update a commit application property |
PropertiesApi | UpdatePullRequestHostedPropertyValue | Put /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} | Update a pull request application property |
PropertiesApi | UpdateRepositoryHostedPropertyValue | Put /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} | Update a repository application property |
PropertiesApi | UpdateUserHostedPropertyValue | Put /users/{selected_user}/properties/{app_key}/{property_name} | Update a user application property |
PullrequestsApi | GetPullrequestsForCommit | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests | List pull requests that contain a commit |
PullrequestsApi | PullrequestsSelectedUserGet | Get /pullrequests/{selected_user} | List pull requests for a user |
PullrequestsApi | RepositoriesWorkspaceRepoSlugDefaultReviewersGet | Get /repositories/{workspace}/{repo_slug}/default-reviewers | List default reviewers |
PullrequestsApi | RepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernameDelete | Delete /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username} | Remove a user from the default reviewers |
PullrequestsApi | RepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernameGet | Get /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username} | Get a default reviewer |
PullrequestsApi | RepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernamePut | Put /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username} | Add a user to the default reviewers |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsActivityGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/activity | List a pull request activity log |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsGet | Get /repositories/{workspace}/{repo_slug}/pullrequests | List pull requests |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPost | Post /repositories/{workspace}/{repo_slug}/pullrequests | Create a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdActivityGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity | List a pull request activity log |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdApproveDelete | Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve | Unapprove a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdApprovePost | Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve | Approve a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdDelete | Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id} | Delete a comment on a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id} | Get a comment on a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdPut | Put /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id} | Update a comment on a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments | List comments on a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsPost | Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments | Create a comment on a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommitsGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits | List commits on a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDeclinePost | Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline | Decline a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDiffGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff | List changes in a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDiffstatGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat | Get the diff stat for a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id} | Get a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdMergePost | Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge | Merge a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdMergeTaskStatusTaskIdGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id} | Get the merge task status for a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdPatchGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch | Get the patch for a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdPut | Put /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id} | Update a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdRequestChangesDelete | Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes | Remove change request for a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdRequestChangesPost | Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes | Request changes for a pull request |
PullrequestsApi | RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGet | Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses | List commit statuses for a pull request |
RefsApi | RepositoriesWorkspaceRepoSlugRefsBranchesGet | Get /repositories/{workspace}/{repo_slug}/refs/branches | List open branches |
RefsApi | RepositoriesWorkspaceRepoSlugRefsBranchesNameDelete | Delete /repositories/{workspace}/{repo_slug}/refs/branches/{name} | Delete a branch |
RefsApi | RepositoriesWorkspaceRepoSlugRefsBranchesNameGet | Get /repositories/{workspace}/{repo_slug}/refs/branches/{name} | Get a branch |
RefsApi | RepositoriesWorkspaceRepoSlugRefsBranchesPost | Post /repositories/{workspace}/{repo_slug}/refs/branches | Create a branch |
RefsApi | RepositoriesWorkspaceRepoSlugRefsGet | Get /repositories/{workspace}/{repo_slug}/refs | List branches and tags |
RefsApi | RepositoriesWorkspaceRepoSlugRefsTagsGet | Get /repositories/{workspace}/{repo_slug}/refs/tags | List tags |
RefsApi | RepositoriesWorkspaceRepoSlugRefsTagsNameDelete | Delete /repositories/{workspace}/{repo_slug}/refs/tags/{name} | Delete a tag |
RefsApi | RepositoriesWorkspaceRepoSlugRefsTagsNameGet | Get /repositories/{workspace}/{repo_slug}/refs/tags/{name} | Get a tag |
RefsApi | RepositoriesWorkspaceRepoSlugRefsTagsPost | Post /repositories/{workspace}/{repo_slug}/refs/tags | Create a tag |
ReportsApi | BulkCreateOrUpdateAnnotations | Post /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations | Bulk create or update annotations |
ReportsApi | CreateOrUpdateAnnotation | Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} | Create or update an annotation |
ReportsApi | CreateOrUpdateReport | Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} | Create or update a report |
ReportsApi | DeleteAnnotation | Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} | Delete an annotation |
ReportsApi | DeleteReport | Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} | Delete a report |
ReportsApi | GetAnnotation | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId} | Get an annotation |
ReportsApi | GetAnnotationsForReport | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations | List annotations |
ReportsApi | GetReport | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId} | Get a report |
ReportsApi | GetReportsForCommit | Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports | List reports |
RepositoriesApi | RepositoriesGet | Get /repositories | List public repositories |
RepositoriesApi | RepositoriesWorkspaceGet | Get /repositories/{workspace} | List repositories in a workspace |
RepositoriesApi | RepositoriesWorkspaceRepoSlugDelete | Delete /repositories/{workspace}/{repo_slug} | Delete a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugFilehistoryCommitPathGet | Get /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path} | List commits that modified a file |
RepositoriesApi | RepositoriesWorkspaceRepoSlugForksGet | Get /repositories/{workspace}/{repo_slug}/forks | List repository forks |
RepositoriesApi | RepositoriesWorkspaceRepoSlugForksPost | Post /repositories/{workspace}/{repo_slug}/forks | Fork a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugGet | Get /repositories/{workspace}/{repo_slug} | Get a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugHooksGet | Get /repositories/{workspace}/{repo_slug}/hooks | List webhooks for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugHooksPost | Post /repositories/{workspace}/{repo_slug}/hooks | Create a webhook for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugHooksUidDelete | Delete /repositories/{workspace}/{repo_slug}/hooks/{uid} | Delete a webhook for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugHooksUidGet | Get /repositories/{workspace}/{repo_slug}/hooks/{uid} | Get a webhook for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugHooksUidPut | Put /repositories/{workspace}/{repo_slug}/hooks/{uid} | Update a webhook for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGet | Get /repositories/{workspace}/{repo_slug}/permissions-config/groups | List explicit group permissions for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGroupSlugDelete | Delete /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug} | Delete an explicit group permission for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGroupSlugGet | Get /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug} | Get an explicit group permission for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGroupSlugPut | Put /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug} | Update an explicit group permission for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigUsersGet | Get /repositories/{workspace}/{repo_slug}/permissions-config/users | List explicit user permissions for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigUsersSelectedUserIdDelete | Delete /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id} | Delete an explicit user permission for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigUsersSelectedUserIdGet | Get /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id} | Get an explicit user permission for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPermissionsConfigUsersSelectedUserIdPut | Put /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id} | Update an explicit user permission for a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPost | Post /repositories/{workspace}/{repo_slug} | Create a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugPut | Put /repositories/{workspace}/{repo_slug} | Update a repository |
RepositoriesApi | RepositoriesWorkspaceRepoSlugSrcCommitPathGet | Get /repositories/{workspace}/{repo_slug}/src/{commit}/{path} | Get file or directory contents |
RepositoriesApi | RepositoriesWorkspaceRepoSlugSrcGet | Get /repositories/{workspace}/{repo_slug}/src | Get the root directory of the main branch |
RepositoriesApi | RepositoriesWorkspaceRepoSlugSrcPost | Post /repositories/{workspace}/{repo_slug}/src | Create a commit by uploading a file |
RepositoriesApi | RepositoriesWorkspaceRepoSlugWatchersGet | Get /repositories/{workspace}/{repo_slug}/watchers | List repositories watchers |
RepositoriesApi | UserPermissionsRepositoriesGet | Get /user/permissions/repositories | List repository permissions for a user |
SearchApi | SearchAccount | Get /users/{selected_user}/search/code | Search for code in a user's repositories |
SearchApi | SearchTeam | Get /teams/{username}/search/code | Search for code in a team's repositories |
SearchApi | SearchWorkspace | Get /workspaces/{workspace}/search/code | Search for code in a workspace |
SnippetsApi | SnippetsGet | Get /snippets | List snippets |
SnippetsApi | SnippetsPost | Post /snippets | Create a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdCommentsCommentIdDelete | Delete /snippets/{workspace}/{encoded_id}/comments/{comment_id} | Delete a comment on a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdCommentsCommentIdGet | Get /snippets/{workspace}/{encoded_id}/comments/{comment_id} | Get a comment on a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdCommentsCommentIdPut | Put /snippets/{workspace}/{encoded_id}/comments/{comment_id} | Update a comment on a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdCommentsGet | Get /snippets/{workspace}/{encoded_id}/comments | List comments on a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdCommentsPost | Post /snippets/{workspace}/{encoded_id}/comments | Create a comment on a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdCommitsGet | Get /snippets/{workspace}/{encoded_id}/commits | List snippet changes |
SnippetsApi | SnippetsWorkspaceEncodedIdCommitsRevisionGet | Get /snippets/{workspace}/{encoded_id}/commits/{revision} | Get a previous snippet change |
SnippetsApi | SnippetsWorkspaceEncodedIdDelete | Delete /snippets/{workspace}/{encoded_id} | Delete a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdFilesPathGet | Get /snippets/{workspace}/{encoded_id}/files/{path} | Get a snippet's raw file at HEAD |
SnippetsApi | SnippetsWorkspaceEncodedIdGet | Get /snippets/{workspace}/{encoded_id} | Get a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdNodeIdDelete | Delete /snippets/{workspace}/{encoded_id}/{node_id} | Delete a previous revision of a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdNodeIdFilesPathGet | Get /snippets/{workspace}/{encoded_id}/{node_id}/files/{path} | Get a snippet's raw file |
SnippetsApi | SnippetsWorkspaceEncodedIdNodeIdGet | Get /snippets/{workspace}/{encoded_id}/{node_id} | Get a previous revision of a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdNodeIdPut | Put /snippets/{workspace}/{encoded_id}/{node_id} | Update a previous revision of a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdPut | Put /snippets/{workspace}/{encoded_id} | Update a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdRevisionDiffGet | Get /snippets/{workspace}/{encoded_id}/{revision}/diff | Get snippet changes between versions |
SnippetsApi | SnippetsWorkspaceEncodedIdRevisionPatchGet | Get /snippets/{workspace}/{encoded_id}/{revision}/patch | Get snippet patch between versions |
SnippetsApi | SnippetsWorkspaceEncodedIdWatchDelete | Delete /snippets/{workspace}/{encoded_id}/watch | Stop watching a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdWatchGet | Get /snippets/{workspace}/{encoded_id}/watch | Check if the current user is watching a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdWatchPut | Put /snippets/{workspace}/{encoded_id}/watch | Watch a snippet |
SnippetsApi | SnippetsWorkspaceEncodedIdWatchersGet | Get /snippets/{workspace}/{encoded_id}/watchers | List users watching a snippet |
SnippetsApi | SnippetsWorkspaceGet | Get /snippets/{workspace} | List snippets in a workspace |
SnippetsApi | SnippetsWorkspacePost | Post /snippets/{workspace} | Create a snippet for a workspace |
SourceApi | RepositoriesWorkspaceRepoSlugFilehistoryCommitPathGet | Get /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path} | List commits that modified a file |
SourceApi | RepositoriesWorkspaceRepoSlugSrcCommitPathGet | Get /repositories/{workspace}/{repo_slug}/src/{commit}/{path} | Get file or directory contents |
SourceApi | RepositoriesWorkspaceRepoSlugSrcGet | Get /repositories/{workspace}/{repo_slug}/src | Get the root directory of the main branch |
SourceApi | RepositoriesWorkspaceRepoSlugSrcPost | Post /repositories/{workspace}/{repo_slug}/src | Create a commit by uploading a file |
SshApi | UsersSelectedUserSshKeysGet | Get /users/{selected_user}/ssh-keys | List SSH keys |
SshApi | UsersSelectedUserSshKeysKeyIdDelete | Delete /users/{selected_user}/ssh-keys/{key_id} | Delete a SSH key |
SshApi | UsersSelectedUserSshKeysKeyIdGet | Get /users/{selected_user}/ssh-keys/{key_id} | Get a SSH key |
SshApi | UsersSelectedUserSshKeysKeyIdPut | Put /users/{selected_user}/ssh-keys/{key_id} | Update a SSH key |
SshApi | UsersSelectedUserSshKeysPost | Post /users/{selected_user}/ssh-keys | Add a new SSH key |
TeamsApi | TeamsGet | Get /teams | List teams a user is part of |
TeamsApi | TeamsUsernameFollowersGet | Get /teams/{username}/followers | List team followers |
TeamsApi | TeamsUsernameFollowingGet | Get /teams/{username}/following | List accounts a team is following |
TeamsApi | TeamsUsernameGet | Get /teams/{username} | Get a team |
TeamsApi | TeamsUsernameMembersGet | Get /teams/{username}/members | List team members |
TeamsApi | TeamsUsernamePermissionsGet | Get /teams/{username}/permissions | List team permissions for a user |
TeamsApi | TeamsUsernamePermissionsRepositoriesGet | Get /teams/{username}/permissions/repositories | List repository permissions for a team |
TeamsApi | TeamsUsernamePermissionsRepositoriesRepoSlugGet | Get /teams/{username}/permissions/repositories/{repo_slug} | List repository permissions for a team |
TeamsApi | TeamsWorkspaceRepositoriesGet | Get /teams/{workspace}/repositories | List workspace repositories |
TeamsApi | UserPermissionsTeamsGet | Get /user/permissions/teams | List team permissions for the user |
TeamsApi | UsersWorkspaceRepositoriesGet | Get /users/{workspace}/repositories | List workspace repositories |
UsersApi | TeamsWorkspaceRepositoriesGet | Get /teams/{workspace}/repositories | List workspace repositories |
UsersApi | UserEmailsEmailGet | Get /user/emails/{email} | Get an email address for current user |
UsersApi | UserEmailsGet | Get /user/emails | List email addresses for current user |
UsersApi | UserGet | Get /user | Get current user |
UsersApi | UsersSelectedUserGet | Get /users/{selected_user} | Get a user |
UsersApi | UsersUsernameMembersGet | Get /users/{username}/members | List team users |
UsersApi | UsersWorkspaceRepositoriesGet | Get /users/{workspace}/repositories | List workspace repositories |
WebhooksApi | HookEventsGet | Get /hook_events | Get a webhook resource |
WebhooksApi | HookEventsSubjectTypeGet | Get /hook_events/{subject_type} | List subscribable webhook types |
WebhooksApi | RepositoriesWorkspaceRepoSlugHooksGet | Get /repositories/{workspace}/{repo_slug}/hooks | List webhooks for a repository |
WebhooksApi | RepositoriesWorkspaceRepoSlugHooksPost | Post /repositories/{workspace}/{repo_slug}/hooks | Create a webhook for a repository |
WebhooksApi | RepositoriesWorkspaceRepoSlugHooksUidDelete | Delete /repositories/{workspace}/{repo_slug}/hooks/{uid} | Delete a webhook for a repository |
WebhooksApi | RepositoriesWorkspaceRepoSlugHooksUidGet | Get /repositories/{workspace}/{repo_slug}/hooks/{uid} | Get a webhook for a repository |
WebhooksApi | RepositoriesWorkspaceRepoSlugHooksUidPut | Put /repositories/{workspace}/{repo_slug}/hooks/{uid} | Update a webhook for a repository |
WebhooksApi | WorkspacesWorkspaceHooksGet | Get /workspaces/{workspace}/hooks | List webhooks for a workspace |
WebhooksApi | WorkspacesWorkspaceHooksPost | Post /workspaces/{workspace}/hooks | Create a webhook for a workspace |
WebhooksApi | WorkspacesWorkspaceHooksUidDelete | Delete /workspaces/{workspace}/hooks/{uid} | Delete a webhook for a workspace |
WebhooksApi | WorkspacesWorkspaceHooksUidGet | Get /workspaces/{workspace}/hooks/{uid} | Get a webhook for a workspace |
WebhooksApi | WorkspacesWorkspaceHooksUidPut | Put /workspaces/{workspace}/hooks/{uid} | Update a webhook for a workspace |
WorkspacesApi | UserPermissionsWorkspacesGet | Get /user/permissions/workspaces | List workspaces for the current user |
WorkspacesApi | WorkspacesGet | Get /workspaces | List workspaces for user |
WorkspacesApi | WorkspacesWorkspaceGet | Get /workspaces/{workspace} | Get a workspace |
WorkspacesApi | WorkspacesWorkspaceHooksGet | Get /workspaces/{workspace}/hooks | List webhooks for a workspace |
WorkspacesApi | WorkspacesWorkspaceHooksPost | Post /workspaces/{workspace}/hooks | Create a webhook for a workspace |
WorkspacesApi | WorkspacesWorkspaceHooksUidDelete | Delete /workspaces/{workspace}/hooks/{uid} | Delete a webhook for a workspace |
WorkspacesApi | WorkspacesWorkspaceHooksUidGet | Get /workspaces/{workspace}/hooks/{uid} | Get a webhook for a workspace |
WorkspacesApi | WorkspacesWorkspaceHooksUidPut | Put /workspaces/{workspace}/hooks/{uid} | Update a webhook for a workspace |
WorkspacesApi | WorkspacesWorkspaceMembersGet | Get /workspaces/{workspace}/members | List users in a workspace |
WorkspacesApi | WorkspacesWorkspaceMembersMemberGet | Get /workspaces/{workspace}/members/{member} | Get user membership for a workspace |
WorkspacesApi | WorkspacesWorkspacePermissionsGet | Get /workspaces/{workspace}/permissions | List user permissions in a workspace |
WorkspacesApi | WorkspacesWorkspacePermissionsRepositoriesGet | Get /workspaces/{workspace}/permissions/repositories | List all repository permissions for a workspace |
WorkspacesApi | WorkspacesWorkspacePermissionsRepositoriesRepoSlugGet | Get /workspaces/{workspace}/permissions/repositories/{repo_slug} | List a repository permissions for a workspace |
WorkspacesApi | WorkspacesWorkspaceProjectsGet | Get /workspaces/{workspace}/projects | List projects in a workspace |
WorkspacesApi | WorkspacesWorkspaceProjectsProjectKeyGet | Get /workspaces/{workspace}/projects/{project_key} | Get a project for a workspace |
Documentation For Models
- Account
- AccountLinks
- ApplicationProperty
- Author
- BaseCommit
- Branch
- BranchRestriction
- BranchingModel
- BranchingModelBranchTypes
- BranchingModelDevelopment
- BranchingModelSettings
- BranchingModelSettingsBranchTypes
- BranchingModelSettingsDevelopment
- BranchingModelSettingsProduction
- Branchrestriction
- Comment
- CommentInline
- CommentLinks
- Commit
- CommitComment
- CommitFile
- CommitReport
- CommitStatus
- CommitStatusLinks
- Commitstatus
- Component
- DdevReport
- DeployKey
- Deployment
- DeploymentEnvironment
- DeploymentEnvironmentLock
- DeploymentRelease
- DeploymentState
- DeploymentStateCompleted
- DeploymentStateCompletedAllOf
- DeploymentStateCompletedStatus
- DeploymentStateCompletedStatusFailed
- DeploymentStateCompletedStatusFailedAllOf
- DeploymentStateCompletedStatusStopped
- DeploymentStateCompletedStatusStoppedAllOf
- DeploymentStateCompletedStatusSuccessful
- DeploymentStateCompletedStatusSuccessfulAllOf
- DeploymentStateInProgress
- DeploymentStateInProgressAllOf
- DeploymentStateUndeployed
- DeploymentStateUndeployedAllOf
- DeploymentVariable
- DeploymentsDdevDeploymentEnvironment
- DeploymentsDdevDeploymentEnvironmentLock
- DeploymentsDdevPaginatedEnvironments
- DeploymentsStgWestDeploymentEnvironment
- DeploymentsStgWestDeploymentEnvironmentLock
- DeploymentsStgWestPaginatedEnvironments
- Diffstat
- ErrorError
- ExportOptions
- Group
- GroupLinks
- HookEvent
- Issue
- IssueAttachment
- IssueChange
- IssueChangeChanges
- IssueChangeChangesAssignee
- IssueChangeLinks
- IssueComment
- IssueJobStatus
- IssueLinks
- JiraProject
- JiraSite
- Link
- Milestone
- ModelError
- Object
- Page
- PaginatedAnnotations
- PaginatedBranches
- PaginatedBranchrestrictions
- PaginatedChangeset
- PaginatedCommitComments
- PaginatedCommitstatuses
- PaginatedComponents
- PaginatedDeployKeys
- PaginatedDeploymentVariable
- PaginatedDeployments
- PaginatedDiffstats
- PaginatedEnvironments
- PaginatedFiles
- PaginatedHookEvents
- PaginatedIssueAttachments
- PaginatedIssueComments
- PaginatedIssues
- PaginatedLogEntries
- PaginatedMilestones
- PaginatedPipelineCaches
- PaginatedPipelineKnownHosts
- PaginatedPipelineScheduleExecutions
- PaginatedPipelineSchedules
- PaginatedPipelineSteps
- PaginatedPipelineVariables
- PaginatedPipelines
- PaginatedProjects
- PaginatedPullrequestComments
- PaginatedPullrequests
- PaginatedRefs
- PaginatedReports
- PaginatedRepositories
- PaginatedRepositoryGroupPermissions
- PaginatedRepositoryPermissions
- PaginatedRepositoryUserPermissions
- PaginatedSnippetComments
- PaginatedSnippetCommit
- PaginatedSnippets
- PaginatedSshUserKeys
- PaginatedTags
- PaginatedTeamPermissions
- PaginatedTeams
- PaginatedTreeentries
- PaginatedUsers
- PaginatedVersions
- PaginatedWebhookSubscriptions
- PaginatedWorkspaceMemberships
- PaginatedWorkspaces
- Participant
- Pipeline
- PipelineBuildNumber
- PipelineCache
- PipelineCacheContentUri
- PipelineCommand
- PipelineCommitTarget
- PipelineCompletedError
- PipelineCompletedState
- PipelineError
- PipelineImage
- PipelineInProgressState
- PipelineKnownHost
- PipelinePendingState
- PipelineRefTarget
- PipelineSSHKeyPair
- PipelineSSHPublicKey
- PipelineSchedule
- PipelineScheduleExecution
- PipelineScheduleExecutionErrored
- PipelineScheduleExecutionErroredAllOf
- PipelineScheduleExecutionExecuted
- PipelineScheduleExecutionExecutedAllOf
- PipelineSelector
- PipelineSshKeyPair
- PipelineSshPublicKey
- PipelineState
- PipelineStateCompleted
- PipelineStateCompletedError
- PipelineStateCompletedExpired
- PipelineStateCompletedExpiredAllOf
- PipelineStateCompletedFailed
- PipelineStateCompletedFailedAllOf
- PipelineStateCompletedResult
- PipelineStateCompletedStopped
- PipelineStateCompletedStoppedAllOf
- PipelineStateCompletedSuccessful
- PipelineStateCompletedSuccessfulAllOf
- PipelineStateInProgress
- PipelineStateInProgressPaused
- PipelineStateInProgressPausedAllOf
- PipelineStateInProgressRunning
- PipelineStateInProgressRunningAllOf
- PipelineStateInProgressStage
- PipelineStatePending
- PipelineStep
- PipelineStepError
- PipelineStepState
- PipelineStepStateCompleted
- PipelineStepStateCompletedAllOf
- PipelineStepStateCompletedError
- PipelineStepStateCompletedErrorAllOf
- PipelineStepStateCompletedExpired
- PipelineStepStateCompletedExpiredAllOf
- PipelineStepStateCompletedFailed
- PipelineStepStateCompletedFailedAllOf
- PipelineStepStateCompletedNotRun
- PipelineStepStateCompletedNotRunAllOf
- PipelineStepStateCompletedResult
- PipelineStepStateCompletedStopped
- PipelineStepStateCompletedStoppedAllOf
- PipelineStepStateCompletedSuccessful
- PipelineStepStateCompletedSuccessfulAllOf
- PipelineStepStateInProgress
- PipelineStepStateInProgressAllOf
- PipelineStepStatePending
- PipelineStepStatePendingAllOf
- PipelineStepStateReady
- PipelineStepStateReadyAllOf
- PipelineTarget
- PipelineTrigger
- PipelineTriggerManual
- PipelineTriggerPush
- PipelineVariable
- PipelinesConfig
- PipelinesConfiguration
- PipelinesDdevPipelineStep
- PipelinesStgWestPipelineStep
- Project
- ProjectLinks
- PullRequest
- PullRequestBranch
- PullRequestComment
- PullRequestCommit
- PullRequestLinks
- Pullrequest
- PullrequestComment
- PullrequestEndpoint
- PullrequestMergeParameters
- Ref
- RefLinks
- RenderedPullRequestMarkup
- RenderedPullRequestMarkupTitle
- Report
- ReportAnnotation
- ReportData
- Repository
- RepositoryGroupPermission
- RepositoryGroupPermissionLinks
- RepositoryLinks
- RepositoryPermission
- RepositoryUserPermission
- SSHAccountKey
- SSHKey
- SearchCodeSearchResult
- SearchContentMatch
- SearchLine
- SearchResultPage
- SearchSegment
- Snippet
- SnippetComment
- SnippetCommit
- SnippetCommitLinks
- SshAccountKey
- SshKey
- StgWestReport
- SubjectTypes
- SubjectTypesRepository
- Tag
- Team
- TeamPermission
- Treeentry
- User
- Version
- WebhookSubscription
- Workspace
- WorkspaceLinks
- WorkspaceMembership
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey
where the key is: Authorization and passed in as the auth context for each request.
basic
- Type: HTTP basic authentication
Example
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
oauth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://bitbucket.org/site/oauth2/authorize
- Scopes:
- wiki: Read and modify your repositories' wikis
- pullrequest:write: Read and modify your repositories and their pull requests
- runner: Access your workspaces/repositories' runners
- runner:write: Access and edit your workspaces/repositories' runners
- pipeline:variable: Access your repositories' build pipelines and configure their variables
- project:write: Read and modify your workspace's project settings, and read and transfer repositories within your workspace's projects
- pipeline:write: Access and rerun your repositories' build pipelines
- snippet: Read your snippets
- repository:delete: Delete your repositories
- repository:write: Read and modify your repositories
- issue: Read your repositories' issues
- email: Read your account's primary email address
- repository: Read your repositories
- issue:write: Read and modify your repositories' issues
- webhook: Read and modify your repositories' webhooks
- pipeline: Access your repositories' build pipelines
- snippet:write: Read and modify your snippets
- account: Read your account information
- repository:admin: Administer your repositories
- pullrequest: Read your repositories and their pull requests
- project: Read your workspace's project settings and read repositories contained within your workspace's projects
- team: Read your team membership information
- team:write: Read and modify your team membership information
- account:write: Read and modify your account information
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime