diff --git a/API-WebHook.md b/API-WebHook.md index 0cf748d..698f09a 100644 --- a/API-WebHook.md +++ b/API-WebHook.md @@ -1,4 +1,4 @@ -The GitBucket api/webhook is designed for compatibility with [GitHub's implementation](https://developer.github.com/v3/). +The GitBucket api/webhook is designed for compatibility with [GitHub's implementation](https://docs.github.com/en/free-pro-team@latest/rest). The API endpoints are reachable under: `http(s)://yourgitbucket/api/v3` @@ -6,113 +6,113 @@ GitBucket does not fully implement the GitHub API/webhook and respects only a su ## Authentication - * [x] [personal OAUTH token in header](https://developer.github.com/v3/#oauth2-token-sent-in-a-header) + * [x] [personal OAUTH token in header](https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#oauth2-token-sent-in-a-header) * The tokens can be created via the UI, by going into the "Account Settings" menu and selecting the "Applications" tab. - * [x] [Basic Authentication](https://developer.github.com/v3/#basic-authentication) (since v4.3) - * [x] [OAuth2 Token (sent as a parameter)](https://developer.github.com/v3/#oauth2-token-sent-as-a-parameter) (since v4.31.0) - * [ ] [OAuth2 Key/Secret](https://developer.github.com/v3/#oauth2-keysecret) not supported yet. + * [x] [Basic Authentication](https://docs.github.com/en/free-pro-team@latest/rest/overview/other-authentication-methods#basic-authentication) (since v4.3) + * [x] [OAuth2 Token (sent as a parameter)](https://docs.github.com/en/free-pro-team@latest/developers/apps/authorizing-oauth-apps) (since v4.31.0) + * [ ] [OAuth2 Key/Secret](https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#oauth2-keysecret) not supported yet. ## API * Root Endpoint - * [List endpoints](https://developer.github.com/v3/#root-endpoint) (since v4.3, Only rate-limit endpoint explained) + * [List endpoints](https://web.archive.org/web/20160625135719/https://developer.github.com/v3/#root-endpoint) (since v4.3, Only rate-limit endpoint explained) * Issues - * [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) (since v4.9) - * [Get a single issue](https://developer.github.com/v3/issues/#get-a-single-issue) (since v4.8) - * [Create an issue](https://developer.github.com/v3/issues/#create-an-issue) (since v4.9) + * [List issues for a repository](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-issues-for-a-repository) (since v4.9) + * [Get an issue](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#get-an-issue) (since v4.8) + * [Create an issue](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#create-an-issue) (since v4.9) * Comments - * [List comments on an issue](https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue) + * [List issue comments](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-issue-comments) * [Get an issue comment](https://docs.github.com/en/rest/reference/issues#get-an-issue-comment) (since v4.35.0) * [Update an issue comment](https://docs.github.com/en/rest/reference/issues#update-an-issue-comment) (since v4.35.0) - * [Create A Comment](https://developer.github.com/v3/issues/comments/#create-a-comment) + * [Create an issue Comment](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#create-an-issue-comment) * [Delete an issue comment](https://docs.github.com/en/rest/reference/issues#delete-an-issue-comment) (since v4.35.0) * Labels - * [List all labels for this repository](https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository) (since v3.11) - * [Get a single label](https://developer.github.com/v3/issues/labels/#get-a-single-label) (since v3.11) - * [Create a label](https://developer.github.com/v3/issues/labels/#create-a-label) (since v3.11) - * [Update a label](https://developer.github.com/v3/issues/labels/#update-a-label) (since v3.11) - * [Delete a label](https://developer.github.com/v3/issues/labels/#delete-a-label) (since v3.11) - * [List labels on an issue](https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue) (since v4.30) - * [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue) (since v4.30) - * [Remove a label from an issue](https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue) (since v4.30) - * [Replace all labels for an issue](https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue) (since v4.30) - * [Remove all labels from an issue](https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue) (since v4.30) + * [List labels for a repository](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-labels-for-a-repository) (since v3.11) + * [Get a label](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#get-a-label) (since v3.11) + * [Create a label](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#create-a-label) (since v3.11) + * [Update a label](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#update-a-label) (since v3.11) + * [Delete a label](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#delete-a-label) (since v3.11) + * [List labels for an issue](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-labels-for-an-issue) (since v4.30) + * [Add labels to an issue](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#add-labels-to-an-issue) (since v4.30) + * [Remove a label from an issue](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#remove-a-label-from-an-issue) (since v4.30) + * [Replace all labels for an issue](https://github.com/octokit/plugin-enterprise-compatibility.js/issues/61) (since v4.30) + * [Remove all labels from an issue](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#remove-all-labels-from-an-issue) (since v4.30) * Milestones - * [List milestones](https://docs.github.com/en/rest/reference/issues#list-milestones) (since v4.35.0) - * [Create a milestone](https://docs.github.com/en/rest/reference/issues#create-a-milestone) (since v4.35.0) - * [Get a milestone](https://docs.github.com/en/rest/reference/issues#get-a-milestone) (since v4.35.0) - * [Update a milestone](https://docs.github.com/en/rest/reference/issues#update-a-milestone) (since v4.35.0) - * [Delete a milestone](https://docs.github.com/en/rest/reference/issues#delete-a-milestone) (since v4.35.0) + * [List milestones](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-milestones) (since v4.35.0) + * [Create a milestone](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#create-a-milestone) (since v4.35.0) + * [Get a milestone](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#get-a-milestone) (since v4.35.0) + * [Update a milestone](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#update-a-milestone) (since v4.35.0) + * [Delete a milestone](https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#delete-a-milestone) (since v4.35.0) * Pull Requests - * [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) - * [Create a pull request](https://developer.github.com/v3/pulls/#create-a-pull-request) (since v4.30) - * [Get a single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) - * [Update a pull request](https://docs.github.com/en/rest/reference/pulls#update-a-pull-request) (since v4.35.0) - * [List commits on a pull request](https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request) - * [Get if a pull request has been merged](https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged) (since v4.30) - * [Merge a pull request](https://docs.github.com/en/rest/reference/pulls#merge-a-pull-request) (since v4.35.0) + * [List pull requests](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#list-pull-requests) + * [Create a pull request](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#create-a-pull-request) (since v4.30) + * [Get a pull request](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#get-a-pull-request) + * [Update a pull request](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#update-a-pull-request) (since v4.35.0) + * [List commits on a pull request](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#list-commits-on-a-pull-request) + * [Check if a pull request has been merged](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (since v4.30) + * [Merge a pull request](https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#merge-a-pull-request) (since v4.35.0) * Repositories - * [List public repositories](https://developer.github.com/v3/repos/#list-public-repositories) (since v4.35.0) - * [List repositories for the authenticated user](https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user) - * [List repositories for a user](https://developer.github.com/v3/repos/#list-repositories-for-a-user) - * [List organization repositories](https://developer.github.com/v3/repos/#list-organization-repositories) - * [List repository tags](https://docs.github.com/en/rest/reference/repos#list-repository-tags) (since v4.35.0) - * [Get](https://developer.github.com/v3/repos/#get) - * [Create](https://developer.github.com/v3/repos/#create) - * [Enabling and disabling branch protection](https://developer.github.com/v3/repos/#enabling-and-disabling-branch-protection) (since v3.11) + * [List public repositories](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-public-repositories) (since v4.35.0) + * [List repositories for the authenticated user](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-repositories-for-the-authenticated-user) + * [List repositories for a user](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-repositories-for-a-user) + * [List organization repositories](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-organization-repositories) + * [List repository tags](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-repository-tags) (since v4.35.0) + * [Get a repository](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-a-repository) + * [Create a repository for the authenticated user](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-repository-for-the-authenticated-user) + * [Create an organization-repository](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-an-organization-repository) + * [Enabling and disabling branch protection](https://web.archive.org/web/20160216211709/https://developer.github.com/v3/repos/#enabling-and-disabling-branch-protection) (since v3.11) * Status - * [Create a Status](https://developer.github.com/v3/repos/statuses/#create-a-status) - * [List Statuses for a specific Ref](https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref) - * [Get the combined Status for a specific Ref](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref) + * [Create a commit Status](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-commit-status) + * [List Statuses for a specific Ref](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-commit-statuses-for-a-reference) + * [Get the combined Status for a specific Ref](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-the-combined-status-for-a-specific-reference) * Branches - * [List all branches for this repository](https://developer.github.com/v3/repos/branches/#list-branches) (since v4.3) - * [Get branch](https://developer.github.com/v3/repos/branches/#get-branch) (since v4.30) - * [Get branch protection](https://docs.github.com/en/rest/reference/repos#get-branch-protection) (since v4.35.0) - * [Delete branch protection](https://docs.github.com/en/rest/reference/repos#delete-branch-protection) (since v4.35.0) - * [Get status checks protection](https://docs.github.com/en/rest/reference/repos#get-status-checks-protection) (since v4.35.0) - * [Get all status check contexts](https://docs.github.com/en/rest/reference/repos#get-all-status-check-contexts) (since v4.35.0) + * [List all branches for this repository](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-branches) (since v4.3) + * [Get a branch](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-a-branch) (since v4.30) + * [Get branch protection](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-branch-protection) (since v4.35.0) + * [Delete branch protection](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#delete-branch-protection) (since v4.35.0) + * [Get status checks protection](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-status-checks-protection) (since v4.35.0) + * [Get all status check contexts](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-all-status-check-contexts) (since v4.35.0) * Commits - * [List commits](https://developer.github.com/v3/repos/commits/#list-commits) (since v4.34) - * [List branches for HEAD commit](https://docs.github.com/en/rest/reference/repos#list-branches-for-head-commit) (since v4.35.0) - * [Get a single commit](https://developer.github.com/v3/repos/commits/#get-a-single-commit) (since v4.17) + * [List commits](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-commits) (since v4.34) + * [List branches for HEAD commit](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-branches-for-head-commit) (since v4.35.0) + * [Get a commit](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-a-commit) (since v4.17) * Contents - * [Get a repository README](https://docs.github.com/en/rest/reference/repos#get-a-repository-readme) (since v4.35.0) - * [List all contents of a file or directory in this repository](https://developer.github.com/v3/repos/contents/#get-contents) (since v4.3) - * [Create a file](https://developer.github.com/v3/repos/contents/#create-a-file) (since v4.31) - * [Update a file](https://developer.github.com/v3/repos/contents/#update-a-file) (since v4.31) + * [Get a repository README](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-a-repository-readme) (since v4.35.0) + * [Get repository content](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-repository-content) (since v4.3) + * [Create or update file contents](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-or-update-file-contents) (since v4.31) * Reference - * [Get a reference](https://developer.github.com/v3/git/refs/#get-a-reference) (since v4.3) + * [Get a reference](https://docs.github.com/en/free-pro-team@latest/rest/reference/git#get-a-reference) (since v4.3) * [Create a reference](https://docs.github.com/en/free-pro-team@latest/rest/reference/git#create-a-reference) (since v4.35.0) * [Update a reference](https://docs.github.com/en/free-pro-team@latest/rest/reference/git#update-a-reference) (since v4.35.0) * [Delete a reference](https://docs.github.com/en/free-pro-team@latest/rest/reference/git#delete-a-reference) (since v4.35.0) * Collaborators - * [List collaborators](https://developer.github.com/v3/repos/collaborators/#list-collaborators) (since v4.3) - * [Check if a user is a repository collaborator](https://docs.github.com/en/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) (since v4.35.0) - * [Add user as a collaborator](https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator) (since v4.30) - * [Remove user as a collaborator](https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator) (since v4.30) - * [Get repository permissions for a user](https://docs.github.com/en/rest/reference/repos#get-repository-permissions-for-a-user) (since v4.35.0) + * [List repository collaborators](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-repository-collaborators) (since v4.3) + * [Check if a user is a repository collaborator](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#check-if-a-user-is-a-repository-collaborator) (since v4.35.0) + * [Add user as a collaborator](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#add-a-repository-collaborator) (since v4.30) + * [Remove user as a collaborator](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#remove-a-repository-collaborator) (since v4.30) + * [Get repository permissions for a user](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-repository-permissions-for-a-user) (since v4.35.0) * Webhooks - * [List repository webhooks](https://docs.github.com/en/rest/reference/repos#list-repository-tags) (since v4.35.0) - * [Create a repository webhook](https://docs.github.com/en/rest/reference/repos#create-a-repository-webhook) (since v4.35.0) - * [Get a repository webhook](https://docs.github.com/en/rest/reference/repos#get-a-repository-webhook) (since v4.35.0) - * [Update a repository webhook](https://docs.github.com/en/rest/reference/repos#update-a-repository-webhook) (since v4.35.0) - * [Delete a repository webhook](https://docs.github.com/en/rest/reference/repos#delete-a-repository-webhook) (since v4.35.0) + * [List repository webhooks](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-repository-webhooks) (since v4.35.0) + * [Create a repository webhook](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#create-a-repository-webhook) (since v4.35.0) + * [Get a repository webhook](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#get-a-repository-webhook) (since v4.35.0) + * [Update a repository webhook](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#update-a-repository-webhook) (since v4.35.0) + * [Delete a repository webhook](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#delete-a-repository-webhook) (since v4.35.0) * Users - * [Get a single user](https://developer.github.com/v3/users/#get-a-single-user) - * [Get the authenticated user](https://developer.github.com/v3/users/#get-the-authenticated-user) - * [Update the authenticated user](https://developer.github.com/v3/users/#update-the-authenticated-user) (since v4.30) - * [Get all users](https://developer.github.com/v3/users/#get-all-users) (since v4.30) - * [List repositories for this user](https://developer.github.com/v3/repos/#list-user-repositories) (since v4.3) - * [Create a new user](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#create-a-new-user) (since v4.30) - * [Suspend a user](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#suspend-a-user) (since v4.30) - * [Unsuspend a user](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#unsuspend-a-user) (v4.30) + * [Get a user](https://docs.github.com/en/free-pro-team@latest/rest/reference/users#get-a-user) + * [Get the authenticated user](https://docs.github.com/en/free-pro-team@latest/rest/reference/users#get-the-authenticated-user) + * [Update the authenticated user](https://docs.github.com/en/free-pro-team@latest/rest/reference/users#update-the-authenticated-user) (since v4.30) + * [Get all users](https://docs.github.com/en/free-pro-team@latest/rest/reference/users#list-users) (since v4.30) + * [List repositories for a user](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-repositories-for-a-user) (since v4.3) + * [Create a new user](https://docs.github.com/en/enterprise-server@2.21/rest/reference/enterprise-admin#create-a-user) (since v4.30) + * [Suspend a user](https://docs.github.com/en/enterprise-server@2.21/rest/reference/enterprise-admin#suspend-a-user) (since v4.30) + * [Unsuspend a user](https://docs.github.com/en/enterprise-server@2.21/rest/reference/enterprise-admin#unsuspend-a-user) (v4.30) * Groups - * [List your groups](https://developer.github.com/v3/orgs/#list-your-organizations) (since v4.30) - * [List all groups](https://developer.github.com/v3/orgs/#list-all-organizations) (since v4.30) - * [Get a single group](https://developer.github.com/v3/orgs/#get-an-organization) (since v4.3) - * [List repositories for this group](https://developer.github.com/v3/repos/#list-organization-repositories) (since v4.3) - * [Create a new group](https://developer.github.com/enterprise/v3/enterprise-admin/orgs/#create-an-organization) (since v4.31.0) + * [List your groups](https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs#list-organizations-for-a-user) (since v4.30) + * [List all groups](https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs#list-organizations) (since v4.30) + * [Get an group](https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs#get-an-organization) (since v4.3) + * [List repositories for this group](https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#list-organization-repositories) (since v4.3) + * [Create a new group](https://docs.github.com/en/enterprise-server@2.21/rest/reference/enterprise-admin#create-an-organization) (since v4.31.0) ### Example @@ -131,10 +131,10 @@ answers ## WebHook Events - * [CreateEvent](https://developer.github.com/v3/activity/events/types/#createevent) - * [IssuesEvent](https://developer.github.com/v3/activity/events/types/#issuesevent) - * [IssueCommentEvent](https://developer.github.com/v3/activity/events/types/#issuecommentevent) - * [PullRequestReviewCommentEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent) - * [PullRequestEvent](https://developer.github.com/v3/activity/events/types/#pullrequestevent) - * [PushEvent](https://developer.github.com/v3/activity/events/types/#pushevent) - * [GollumEvent](https://developer.github.com/v3/activity/events/types/#gollumevent) \ No newline at end of file + * [CreateEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#create) + * [IssuesEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issues) + * [IssueCommentEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment) + * [PullRequestReviewCommentEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment) + * [PullRequestEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#pull_request) + * [PushEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#push) + * [GollumEvent](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#gollum) \ No newline at end of file