Skip to content

Latest commit

 

History

History
227 lines (212 loc) · 34.6 KB

README.md

File metadata and controls

227 lines (212 loc) · 34.6 KB

Go API client for Bitbucket (bitbucket-server V1)

Build Status GoDoc codecov

Overview

API client for Atlassian's Bitbucket Server (former stash). 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/

Class Method HTTP request Description
DefaultApi AddGroupToUser Post /api/1.0/admin/users/add-group
DefaultApi AddUserToGroup Post /api/1.0/admin/groups/add-user
DefaultApi AddUserToGroups Post /api/1.0/admin/users/add-groups
DefaultApi AddUsersToGroup Post /api/1.0/admin/groups/add-users
DefaultApi Approve Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve
DefaultApi AssignParticipantRole Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
DefaultApi CanMerge Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge
DefaultApi ClearSenderAddress Delete /api/1.0/admin/mail-server/sender-address
DefaultApi ClearUserCaptchaChallenge Delete /api/1.0/admin/users/captcha
DefaultApi CountPullRequestTasks Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks/count
DefaultApi Create Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests
DefaultApi CreateBranch Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches
DefaultApi CreateComment Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments
DefaultApi CreateComment_0 Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments
DefaultApi CreateGroup Post /api/1.0/admin/groups
DefaultApi CreateProject Post /api/1.0/projects
DefaultApi CreateRepository Post /api/1.0/projects/{projectKey}/repos
DefaultApi CreateTag Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags
DefaultApi CreateTask Post /api/1.0/tasks
DefaultApi CreateUser Post /api/1.0/admin/users
DefaultApi CreateWebhook Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks
DefaultApi Decline Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline
DefaultApi Delete Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApi DeleteAvatar Delete /api/1.0/users/{userSlug}/avatar.png
DefaultApi DeleteComment Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DefaultApi DeleteComment_0 Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApi DeleteGroup Delete /api/1.0/admin/groups
DefaultApi DeleteMailConfig Delete /api/1.0/admin/mail-server
DefaultApi DeleteProject Delete /api/1.0/projects/{projectKey}
DefaultApi DeleteRepository Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApi DeleteRepositoryHook Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}
DefaultApi DeleteTask Delete /api/1.0/tasks/{taskId}
DefaultApi DeleteUser Delete /api/1.0/admin/users
DefaultApi DeleteWebhook Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DefaultApi DisableHook Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled
DefaultApi DisableHook_0 Delete /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/enabled
DefaultApi EditFile Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse/{path}
DefaultApi EnableHook Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled
DefaultApi EnableHook_0 Put /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/enabled
DefaultApi FindGroupsForUser Get /api/1.0/admin/users/more-members
DefaultApi FindOtherGroupsForUser Get /api/1.0/admin/users/more-non-members
DefaultApi FindUsersInGroup Get /api/1.0/admin/groups/more-members
DefaultApi FindUsersNotInGroup Get /api/1.0/admin/groups/more-non-members
DefaultApi FindWebhooks Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks
DefaultApi ForkRepository Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApi Get Get /api/1.0/admin/license
DefaultApi GetActivities Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities
DefaultApi GetApplicationProperties Get /api/1.0/application-properties
DefaultApi GetArchive Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/archive
DefaultApi GetAvatar Get /api/1.0/hooks/{hookKey}/avatar
DefaultApi GetBranches Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches
DefaultApi GetChanges Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/changes
DefaultApi GetChanges_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/changes
DefaultApi GetComment Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DefaultApi GetComment_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApi GetComments Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments
DefaultApi GetComments_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments
DefaultApi GetCommit Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}
DefaultApi GetCommits Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits
DefaultApi GetCommits_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits
DefaultApi GetContent Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse
DefaultApi GetContent_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse/{path}
DefaultApi GetContent_1 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/raw
DefaultApi GetContent_2 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/raw/{path}
DefaultApi GetDefaultBranch Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default
DefaultApi GetForkedRepositories Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/forks
DefaultApi GetGroups Get /api/1.0/admin/groups
DefaultApi GetGroupsWithAnyPermission Get /api/1.0/admin/permissions/groups
DefaultApi GetGroupsWithAnyPermission_0 Get /api/1.0/projects/{projectKey}/permissions/groups
DefaultApi GetGroupsWithAnyPermission_1 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
DefaultApi GetGroupsWithoutAnyPermission Get /api/1.0/admin/permissions/groups/none
DefaultApi GetGroupsWithoutAnyPermission_0 Get /api/1.0/projects/{projectKey}/permissions/groups/none
DefaultApi GetGroupsWithoutAnyPermission_1 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none
DefaultApi GetGroups_0 Get /api/1.0/groups
DefaultApi GetInformation Get /api/1.0/admin/cluster
DefaultApi GetLatestInvocation Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest
DefaultApi GetLevel Get /api/1.0/logs/logger/{loggerName}
DefaultApi GetMailConfig Get /api/1.0/admin/mail-server
DefaultApi GetMergeConfig Get /api/1.0/admin/pull-requests/{scmId}
DefaultApi GetPage Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests
DefaultApi GetProject Get /api/1.0/projects/{projectKey}
DefaultApi GetProjectAvatar Get /api/1.0/projects/{projectKey}/avatar.png
DefaultApi GetProjects Get /api/1.0/projects
DefaultApi GetPullRequestCount Get /api/1.0/inbox/pull-requests/count
DefaultApi GetPullRequestSettings Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests
DefaultApi GetPullRequestSettings_0 Get /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}
DefaultApi GetPullRequestSuggestions Get /api/1.0/dashboard/pull-request-suggestions
DefaultApi GetPullRequestTasks Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks
DefaultApi GetPullRequests Get /api/1.0/dashboard/pull-requests
DefaultApi GetPullRequests_0 Get /api/1.0/inbox/pull-requests
DefaultApi GetRelatedRepositories Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/related
DefaultApi GetRepositories Get /api/1.0/projects/{projectKey}/repos
DefaultApi GetRepositoriesRecentlyAccessed Get /api/1.0/profile/recent/repos
DefaultApi GetRepositories_0 Get /api/1.0/repos
DefaultApi GetRepository Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApi GetRepositoryHook Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}
DefaultApi GetRepositoryHook_0 Get /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}
DefaultApi GetRepositoryHooks Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks
DefaultApi GetRepositoryHooks_0 Get /api/1.0/projects/{projectKey}/settings/hooks
DefaultApi GetRootLevel Get /api/1.0/logs/rootLogger
DefaultApi GetSenderAddress Get /api/1.0/admin/mail-server/sender-address
DefaultApi GetSettings Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings
DefaultApi GetSettings_0 Get /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/settings
DefaultApi GetStatistics Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics
DefaultApi GetStatisticsSummary Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary
DefaultApi GetTag Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags/{name}
DefaultApi GetTags Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags
DefaultApi GetTask Get /api/1.0/tasks/{taskId}
DefaultApi GetUser Get /api/1.0/users/{userSlug}
DefaultApi GetUserSettings Get /api/1.0/users/{userSlug}/settings
DefaultApi GetUsers Get /api/1.0/admin/users
DefaultApi GetUsersWithAnyPermission Get /api/1.0/admin/permissions/users
DefaultApi GetUsersWithAnyPermission_0 Get /api/1.0/projects/{projectKey}/permissions/users
DefaultApi GetUsersWithAnyPermission_1 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
DefaultApi GetUsersWithoutAnyPermission Get /api/1.0/admin/permissions/users/none
DefaultApi GetUsersWithoutPermission Get /api/1.0/projects/{projectKey}/permissions/users/none
DefaultApi GetUsersWithoutPermission_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none
DefaultApi GetUsers_0 Get /api/1.0/users
DefaultApi GetWebhook Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DefaultApi Get_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApi HasAllUserPermission Get /api/1.0/projects/{projectKey}/permissions/{permission}/all
DefaultApi ListParticipants Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
DefaultApi Merge Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge
DefaultApi ModifyAllUserPermission Post /api/1.0/projects/{projectKey}/permissions/{permission}/all
DefaultApi Preview Post /api/1.0/markup/preview
DefaultApi RemoveGroupFromUser Post /api/1.0/admin/users/remove-group
DefaultApi RemoveUserFromGroup Post /api/1.0/admin/groups/remove-user
DefaultApi RenameUser Post /api/1.0/admin/users/rename
DefaultApi Reopen Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen
DefaultApi RetryCreateRepository Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/recreate
DefaultApi RevokePermissionsForGroup Delete /api/1.0/admin/permissions/groups
DefaultApi RevokePermissionsForGroup_0 Delete /api/1.0/projects/{projectKey}/permissions/groups
DefaultApi RevokePermissionsForGroup_1 Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
DefaultApi RevokePermissionsForUser Delete /api/1.0/admin/permissions/users
DefaultApi RevokePermissionsForUser_0 Delete /api/1.0/projects/{projectKey}/permissions/users
DefaultApi RevokePermissionsForUser_1 Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
DefaultApi Search Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/participants
DefaultApi SetDefaultBranch Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default
DefaultApi SetLevel Put /api/1.0/logs/logger/{loggerName}/{levelName}
DefaultApi SetMailConfig Put /api/1.0/admin/mail-server
DefaultApi SetMergeConfig Post /api/1.0/admin/pull-requests/{scmId}
DefaultApi SetPermissionForGroup Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
DefaultApi SetPermissionForGroups Put /api/1.0/admin/permissions/groups
DefaultApi SetPermissionForGroups_0 Put /api/1.0/projects/{projectKey}/permissions/groups
DefaultApi SetPermissionForUser Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
DefaultApi SetPermissionForUsers Put /api/1.0/admin/permissions/users
DefaultApi SetPermissionForUsers_0 Put /api/1.0/projects/{projectKey}/permissions/users
DefaultApi SetRootLevel Put /api/1.0/logs/rootLogger/{levelName}
DefaultApi SetSenderAddress Put /api/1.0/admin/mail-server/sender-address
DefaultApi SetSettings Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings
DefaultApi SetSettings_0 Put /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/settings
DefaultApi Stream Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/last-modified
DefaultApi StreamChanges Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/changes
DefaultApi StreamChanges_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes
DefaultApi StreamCommits Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/commits
DefaultApi StreamDiff Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff
DefaultApi StreamDiff_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}
DefaultApi StreamDiff_1 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}
DefaultApi StreamDiff_2 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/diff
DefaultApi StreamDiff_3 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/diff/{path}
DefaultApi StreamDiff_4 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff
DefaultApi StreamDiff_5 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}
DefaultApi StreamFiles Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/files
DefaultApi StreamFiles_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/files/{path}
DefaultApi Stream_0 Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}
DefaultApi TestWebhook Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/test
DefaultApi UnassignParticipantRole Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
DefaultApi UnassignParticipantRole_0 Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}
DefaultApi Unwatch Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch
DefaultApi Unwatch_0 Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch
DefaultApi Update Post /api/1.0/admin/license
DefaultApi UpdateComment Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DefaultApi UpdateComment_0 Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApi UpdateProject Put /api/1.0/projects/{projectKey}
DefaultApi UpdatePullRequestSettings Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests
DefaultApi UpdatePullRequest Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApi UpdatePullRequestComment Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DefaultApi UpdatePullRequestSettings_0 Post /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}
DefaultApi UpdateRepository Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DefaultApi UpdateSettings Post /api/1.0/users/{userSlug}/settings
DefaultApi UpdateStatus Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}
DefaultApi UpdateTask Put /api/1.0/tasks/{taskId}
DefaultApi UpdateUserDetails Put /api/1.0/admin/users
DefaultApi UpdateUserDetails_0 Put /api/1.0/users
DefaultApi UpdateUserPassword Put /api/1.0/admin/users/credentials
DefaultApi UpdateUserPassword_0 Put /api/1.0/users/credentials
DefaultApi UpdateWebhook Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DefaultApi Update_0 Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DefaultApi UploadAvatar Post /api/1.0/projects/{projectKey}/avatar.png
DefaultApi UploadAvatar_0 Post /api/1.0/users/{userSlug}/avatar.png
DefaultApi Watch Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch
DefaultApi Watch_0 Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch
DefaultApi WithdrawApproval Delete /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