@atlassian/bitbucket-server

{ "api": { "getApplicationProperties": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "q": { "in": "query", "type": "object" } }, "url": "/rest/api/1.0/application-properties" }, "getUser": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "q": { "in": "query", "type": "object" }, "userSlug": { "in": "path", "required": true, "type": "string" } }, "returns": "User", "url": "/rest/api/1.0/users/{userSlug}" }, "getUsers": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "limit": { "in": "query", "type": "integer" }, "q": { "in": "query", "type": "any" }, "start": { "in": "query", "type": "integer" } }, "returns": "PaginatedUsers", "url": "/rest/api/1.0/users" }, "preview": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "body": { "in": "body", "required": true, "schema": "PreviewRequest", "type": "any" }, "q": { "in": "query", "type": "object" } }, "url": "/rest/api/1.0/markup/preview" } }, "comments": { "getComment": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "commentId": { "in": "path", "required": true, "type": "integer" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}" }, "updateComment": { "headers": { "accept": "application/json" }, "method": "PUT", "params": { "body": { "in": "body", "required": true, "schema": "UpdateCommentRequest", "type": "any" }, "commentId": { "in": "path", "required": true, "type": "integer" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}" } }, "commits": { "getPullRequests": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "commitId": { "in": "path", "required": true, "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/pull-requests" } }, "participants": { "updateStatus": { "headers": { "accept": "application/json" }, "method": "PUT", "params": { "body": { "in": "body", "required": true, "schema": "UpdateStatusRequest", "type": "any" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "userSlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}" } }, "pullRequests": { "approve": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve" }, "canMerge": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge" }, "createComment": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "body": { "in": "body", "required": true, "schema": "CreateCommentRequest", "type": "any" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments" }, "decline": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "version": { "in": "query", "type": "integer" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline" }, "get": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}" }, "getActivities": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "fromId": { "in": "query", "type": "integer" }, "fromType": { "in": "query", "type": "string" }, "limit": { "in": "query", "type": "integer" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "any" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "start": { "in": "query", "type": "integer" } }, "returns": "PaginatedPullRequestActivities", "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities" }, "getComments": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "anchorState": { "in": "query", "type": "string" }, "diffType": { "in": "query", "type": "string" }, "fromHash": { "in": "query", "type": "string" }, "path": { "in": "query", "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "toHash": { "in": "query", "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments" }, "getCommits": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "withCounts": { "in": "query", "type": "boolean" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits" }, "getPullRequestSettings": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "scmId": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}" }, "getTaskCount": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks/count" }, "listParticipants": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "limit": { "in": "query", "type": "integer" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "any" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "start": { "in": "query", "type": "integer" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants" }, "merge": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "version": { "in": "query", "type": "integer" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge" }, "reopen": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "version": { "in": "query", "type": "integer" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen" }, "streamChanges": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "changeScope": { "in": "query", "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "sinceId": { "in": "query", "type": "string" }, "untilId": { "in": "query", "type": "string" }, "withComments": { "in": "query", "type": "boolean" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes" }, "update": { "headers": { "accept": "application/json" }, "method": "PUT", "params": { "body": { "in": "body", "required": true, "schema": "UpdateRequest", "type": "any" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "pullRequestId": { "in": "path", "required": true, "type": "integer" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}" } }, "repos": { "createPullRequest": { "headers": { "accept": "application/json" }, "method": "POST", "params": { "body": { "in": "body", "required": true, "schema": "CreateRequest", "type": "any" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests" }, "getBranches": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "base": { "in": "query", "type": "string" }, "details": { "in": "query", "type": "boolean" }, "filterText": { "in": "query", "type": "string" }, "orderBy": { "in": "query", "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches" }, "getBranchModel": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/branch-utils/1.0/projects/{projectKey}/repos/{repositorySlug}/branchmodel" }, "getCommits": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "followRenames": { "in": "query", "type": "boolean" }, "ignoreMissing": { "in": "query", "type": "boolean" }, "merges": { "in": "query", "type": "string" }, "path": { "in": "query", "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "since": { "in": "query", "type": "string" }, "until": { "in": "query", "type": "string" }, "withCounts": { "in": "query", "type": "boolean" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits" }, "getDefaultBranch": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default" }, "getDefaultReviewers": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "limit": { "in": "query", "type": "integer" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "any" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "sourceRefId": { "in": "query", "required": true, "type": "string" }, "sourceRepoId": { "in": "query", "required": true, "type": "number" }, "start": { "in": "query", "type": "integer" }, "targetRefId": { "in": "query", "required": true, "type": "string" }, "targetRepoId": { "in": "query", "required": true, "type": "number" } }, "returns": "PaginatedUsers", "url": "/rest/default-reviewers/1.0/projects/{projectKey}/repos/{repositorySlug}/reviewers" }, "getPullRequests": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "at": { "in": "query", "type": "string" }, "direction": { "in": "query", "type": "string" }, "limit": { "in": "query", "type": "integer" }, "order": { "in": "query", "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "any" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "start": { "in": "query", "type": "integer" }, "state": { "in": "query", "type": "string" }, "withAttributes": { "in": "query", "type": "boolean" }, "withProperties": { "in": "query", "type": "boolean" } }, "returns": "PaginatedPullRequests", "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests" }, "getRepository": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}" }, "search": { "headers": { "accept": "application/json" }, "method": "GET", "params": { "direction": { "in": "query", "type": "string" }, "filter": { "in": "query", "type": "string" }, "projectKey": { "in": "path", "required": true, "type": "string" }, "q": { "in": "query", "type": "object" }, "repositorySlug": { "in": "path", "required": true, "type": "string" }, "role": { "in": "query", "type": "string" } }, "url": "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/participants" } } }