Categorygithub.com/yareda/go-bitbucket-v1
modulepackage
0.0.0-20200501151036-bb9f179acf75
Repository: https://github.com/yareda/go-bitbucket-v1.git
Documentation: pkg.go.dev

# README

Go API client for Bitbucket (bitbucket-server V1)

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version:
  • Package version: 1.0.0

Documentation for API Endpoints

All URIs are relative to http://example.com/rest/

ClassMethodHTTP requestDescription
DefaultApiAddGroupToUserPost /api/1.0/admin/users/add-group
DefaultApiAddUserToGroupPost /api/1.0/admin/groups/add-user
DefaultApiAddUserToGroupsPost /api/1.0/admin/users/add-groups
DefaultApiAddUsersToGroupPost /api/1.0/admin/groups/add-users
DefaultApiApprovePost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve
DefaultApiAssignParticipantRolePost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
DefaultApiCanMergeGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge
DefaultApiClearSenderAddressDelete /api/1.0/admin/mail-server/sender-address
DefaultApiClearUserCaptchaChallengeDelete /api/1.0/admin/users/captcha
DefaultApiCountPullRequestTasksGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks/count
DefaultApiCreatePost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests
DefaultApiCreateBranchPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches
DefaultApiCreateCommentPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments
DefaultApiCreateComment_0Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments
DefaultApiCreateGroupPost /api/1.0/admin/groups
DefaultApiCreateProjectPost /api/1.0/projects
DefaultApiCreateRepositoryPost /api/1.0/projects/{projectKey}/repos
DefaultApiCreateTagPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags
DefaultApiCreateTaskPost /api/1.0/tasks
DefaultApiCreateUserPost /api/1.0/admin/users
DefaultApiCreateWebhookPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks
DefaultApiDeclinePost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline
DefaultApiDeleteDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApiDeleteAvatarDelete /api/1.0/users/{userSlug}/avatar.png
DefaultApiDeleteCommentDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DefaultApiDeleteComment_0Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApiDeleteGroupDelete /api/1.0/admin/groups
DefaultApiDeleteMailConfigDelete /api/1.0/admin/mail-server
DefaultApiDeleteProjectDelete /api/1.0/projects/{projectKey}
DefaultApiDeleteRepositoryDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApiDeleteRepositoryHookDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}
DefaultApiDeleteTaskDelete /api/1.0/tasks/{taskId}
DefaultApiDeleteUserDelete /api/1.0/admin/users
DefaultApiDeleteWebhookDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DefaultApiDisableHookDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled
DefaultApiDisableHook_0Delete /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/enabled
DefaultApiEditFilePut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse/{path}
DefaultApiEnableHookPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled
DefaultApiEnableHook_0Put /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/enabled
DefaultApiFindGroupsForUserGet /api/1.0/admin/users/more-members
DefaultApiFindOtherGroupsForUserGet /api/1.0/admin/users/more-non-members
DefaultApiFindUsersInGroupGet /api/1.0/admin/groups/more-members
DefaultApiFindUsersNotInGroupGet /api/1.0/admin/groups/more-non-members
DefaultApiFindWebhooksGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks
DefaultApiForkRepositoryPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApiGetGet /api/1.0/admin/license
DefaultApiGetActivitiesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities
DefaultApiGetApplicationPropertiesGet /api/1.0/application-properties
DefaultApiGetArchiveGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/archive
DefaultApiGetAvatarGet /api/1.0/hooks/{hookKey}/avatar
DefaultApiGetBranchesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches
DefaultApiGetChangesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/changes
DefaultApiGetChanges_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/changes
DefaultApiGetCommentGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DefaultApiGetComment_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApiGetCommentsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments
DefaultApiGetComments_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments
DefaultApiGetCommitGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}
DefaultApiGetCommitsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits
DefaultApiGetCommits_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits
DefaultApiGetContentGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse
DefaultApiGetContent_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse/{path}
DefaultApiGetContent_1Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/raw
DefaultApiGetContent_2Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/raw/{path}
DefaultApiGetDefaultBranchGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default
DefaultApiGetForkedRepositoriesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/forks
DefaultApiGetGroupsGet /api/1.0/admin/groups
DefaultApiGetGroupsWithAnyPermissionGet /api/1.0/admin/permissions/groups
DefaultApiGetGroupsWithAnyPermission_0Get /api/1.0/projects/{projectKey}/permissions/groups
DefaultApiGetGroupsWithAnyPermission_1Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
DefaultApiGetGroupsWithoutAnyPermissionGet /api/1.0/admin/permissions/groups/none
DefaultApiGetGroupsWithoutAnyPermission_0Get /api/1.0/projects/{projectKey}/permissions/groups/none
DefaultApiGetGroupsWithoutAnyPermission_1Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none
DefaultApiGetGroups_0Get /api/1.0/groups
DefaultApiGetInformationGet /api/1.0/admin/cluster
DefaultApiGetLatestInvocationGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest
DefaultApiGetLevelGet /api/1.0/logs/logger/{loggerName}
DefaultApiGetMailConfigGet /api/1.0/admin/mail-server
DefaultApiGetMergeConfigGet /api/1.0/admin/pull-requests/{scmId}
DefaultApiGetPageGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests
DefaultApiGetProjectGet /api/1.0/projects/{projectKey}
DefaultApiGetProjectAvatarGet /api/1.0/projects/{projectKey}/avatar.png
DefaultApiGetProjectsGet /api/1.0/projects
DefaultApiGetPullRequestCountGet /api/1.0/inbox/pull-requests/count
DefaultApiGetPullRequestSettingsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests
DefaultApiGetPullRequestSettings_0Get /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}
DefaultApiGetPullRequestSuggestionsGet /api/1.0/dashboard/pull-request-suggestions
DefaultApiGetPullRequestTasksGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks
DefaultApiGetPullRequestsGet /api/1.0/dashboard/pull-requests
DefaultApiGetPullRequests_0Get /api/1.0/inbox/pull-requests
DefaultApiGetRelatedRepositoriesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/related
DefaultApiGetRepositoriesGet /api/1.0/projects/{projectKey}/repos
DefaultApiGetRepositoriesRecentlyAccessedGet /api/1.0/profile/recent/repos
DefaultApiGetRepositories_0Get /api/1.0/repos
DefaultApiGetRepositoryGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApiGetRepositoryHookGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}
DefaultApiGetRepositoryHook_0Get /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}
DefaultApiGetRepositoryHooksGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks
DefaultApiGetRepositoryHooks_0Get /api/1.0/projects/{projectKey}/settings/hooks
DefaultApiGetRootLevelGet /api/1.0/logs/rootLogger
DefaultApiGetSenderAddressGet /api/1.0/admin/mail-server/sender-address
DefaultApiGetSettingsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings
DefaultApiGetSettings_0Get /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/settings
DefaultApiGetStatisticsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics
DefaultApiGetStatisticsSummaryGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary
DefaultApiGetTagGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags/{name}
DefaultApiGetTagsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags
DefaultApiGetTaskGet /api/1.0/tasks/{taskId}
DefaultApiGetUserGet /api/1.0/users/{userSlug}
DefaultApiGetUserSettingsGet /api/1.0/users/{userSlug}/settings
DefaultApiGetUsersGet /api/1.0/admin/users
DefaultApiGetUsersWithAnyPermissionGet /api/1.0/admin/permissions/users
DefaultApiGetUsersWithAnyPermission_0Get /api/1.0/projects/{projectKey}/permissions/users
DefaultApiGetUsersWithAnyPermission_1Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
DefaultApiGetUsersWithoutAnyPermissionGet /api/1.0/admin/permissions/users/none
DefaultApiGetUsersWithoutPermissionGet /api/1.0/projects/{projectKey}/permissions/users/none
DefaultApiGetUsersWithoutPermission_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none
DefaultApiGetUsers_0Get /api/1.0/users
DefaultApiGetWebhookGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DefaultApiGet_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApiHasAllUserPermissionGet /api/1.0/projects/{projectKey}/permissions/{permission}/all
DefaultApiListParticipantsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
DefaultApiMergePost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge
DefaultApiModifyAllUserPermissionPost /api/1.0/projects/{projectKey}/permissions/{permission}/all
DefaultApiPreviewPost /api/1.0/markup/preview
DefaultApiRemoveGroupFromUserPost /api/1.0/admin/users/remove-group
DefaultApiRemoveUserFromGroupPost /api/1.0/admin/groups/remove-user
DefaultApiRenameUserPost /api/1.0/admin/users/rename
DefaultApiReopenPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen
DefaultApiRetryCreateRepositoryPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/recreate
DefaultApiRevokePermissionsForGroupDelete /api/1.0/admin/permissions/groups
DefaultApiRevokePermissionsForGroup_0Delete /api/1.0/projects/{projectKey}/permissions/groups
DefaultApiRevokePermissionsForGroup_1Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
DefaultApiRevokePermissionsForUserDelete /api/1.0/admin/permissions/users
DefaultApiRevokePermissionsForUser_0Delete /api/1.0/projects/{projectKey}/permissions/users
DefaultApiRevokePermissionsForUser_1Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
DefaultApiSearchGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/participants
DefaultApiSetDefaultBranchPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default
DefaultApiSetLevelPut /api/1.0/logs/logger/{loggerName}/{levelName}
DefaultApiSetMailConfigPut /api/1.0/admin/mail-server
DefaultApiSetMergeConfigPost /api/1.0/admin/pull-requests/{scmId}
DefaultApiSetPermissionForGroupPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
DefaultApiSetPermissionForGroupsPut /api/1.0/admin/permissions/groups
DefaultApiSetPermissionForGroups_0Put /api/1.0/projects/{projectKey}/permissions/groups
DefaultApiSetPermissionForUserPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
DefaultApiSetPermissionForUsersPut /api/1.0/admin/permissions/users
DefaultApiSetPermissionForUsers_0Put /api/1.0/projects/{projectKey}/permissions/users
DefaultApiSetRootLevelPut /api/1.0/logs/rootLogger/{levelName}
DefaultApiSetSenderAddressPut /api/1.0/admin/mail-server/sender-address
DefaultApiSetSettingsPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings
DefaultApiSetSettings_0Put /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/settings
DefaultApiStreamGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/last-modified
DefaultApiStreamChangesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/changes
DefaultApiStreamChanges_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes
DefaultApiStreamCommitsGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/commits
DefaultApiStreamDiffGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff
DefaultApiStreamDiff_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}
DefaultApiStreamDiff_1Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}
DefaultApiStreamDiff_2Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/diff
DefaultApiStreamDiff_3Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/diff/{path}
DefaultApiStreamDiff_4Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff
DefaultApiStreamDiff_5Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}
DefaultApiStreamFilesGet /api/1.0/projects/{projectKey}/repos/{repositorySlug}/files
DefaultApiStreamFiles_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/files/{path}
DefaultApiStream_0Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}
DefaultApiTestWebhookPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/test
DefaultApiUnassignParticipantRoleDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
DefaultApiUnassignParticipantRole_0Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}
DefaultApiUnwatchDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch
DefaultApiUnwatch_0Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch
DefaultApiUpdatePost /api/1.0/admin/license
DefaultApiUpdateCommentPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DefaultApiUpdateComment_0Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApiUpdateProjectPut /api/1.0/projects/{projectKey}
DefaultApiUpdatePullRequestSettingsPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests
DefaultApiUpdatePullRequestSettings_0Post /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}
DefaultApiUpdateRepositoryPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApiUpdateSettingsPost /api/1.0/users/{userSlug}/settings
DefaultApiUpdateStatusPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}
DefaultApiUpdateTaskPut /api/1.0/tasks/{taskId}
DefaultApiUpdateUserDetailsPut /api/1.0/admin/users
DefaultApiUpdateUserDetails_0Put /api/1.0/users
DefaultApiUpdateUserPasswordPut /api/1.0/admin/users/credentials
DefaultApiUpdateUserPassword_0Put /api/1.0/users/credentials
DefaultApiUpdateWebhookPut /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DefaultApiUpdate_0Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApiUploadAvatarPost /api/1.0/projects/{projectKey}/avatar.png
DefaultApiUploadAvatar_0Post /api/1.0/users/{userSlug}/avatar.png
DefaultApiWatchPost /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch
DefaultApiWatch_0Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch
DefaultApiWithdrawApprovalDelete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Authors

George Fleury

Sanket Patel

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
GetBranchesResponse cast Tags into structure.
GetCommitsResponse cast Commits into structure.
GetContentResponse cast Content into structure.
GetDiffResponse cast Diff into structure.
GetPullRequestResponse cast PullRequest into structure.
GetRepositoriesResponse cast Repositories into structure.
GetRepositoryResponse cast Repositories into structure.
GetSSHKeysResponse cast SSHKeys into structure.
GetTagsResponse cast Tags into structure.
GetWebhooksResponse cast Webhooks into structure.
NewAPIClient creates a new API client.
NewAPIResponse create new APIResponse from http.Response.
NewAPIResponseWithError create new erroneous API response from http.response and error.
NewBitbucketAPIResponse create new API response from http.response.
NewConfiguration create new configuration.
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the API v In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse contains generic data from API Response.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Branch contains git Branch information.
No description provided by the author
No description provided by the author
Commit contains data from a commit in BitBucket.
Configuration provides the configuration to connect.
Content contains repository content information (and files content).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Repository contains data from a BitBucket Repository.
No description provided by the author
SSHKey contains data from a SSHKey in the BitBucket Server.
Tag contaings git Tag information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

DefaultAPIService default service.