{ "opencollection": "1.0.0", "info": { "name": "Bitbucket Addon Commit statuses API", "version": "2.0" }, "items": [ { "info": { "name": "Commit statuses", "type": "folder" }, "items": [ { "info": { "name": "List commit statuses for a commit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repositories/:workspace/:repo_slug/commit/:commit/statuses", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The commit's SHA1." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "refname", "value": "", "type": "query", "description": "If specified, only return commit status objects that were either\ncreated without a refname, or were created with the specified refname\n" }, { "name": "q", "value": "", "type": "query", "description": "Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\nDefaults to `created_on`.\n" } ] }, "docs": "Returns all statuses (e.g. build results) for a specific commit." }, { "info": { "name": "Create a build status for a commit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/repositories/:workspace/:repo_slug/commit/:commit/statuses/build", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The commit's SHA1." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ] }, "docs": "Creates a new build status against the specified commit.\n\nIf the specified key already exists, the existing status object will\nbe overwritten.\n\nExample:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/e10dae226959c2194f2b07b077c07762d93821cf/statuses/build/ -X POST -u jdoe -H 'Content-Type: application/json' -d '{\n \"key\": \"MY-BUILD\",\n \"state\": \"SUCCESSFUL\",\n \"description\": \"42 tests passed\",\n \"url\": \"https://www.example.org/my-buil" }, { "info": { "name": "Get a build status for a commit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repositories/:workspace/:repo_slug/commit/:commit/statuses/build/:key", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The commit's SHA1." }, { "name": "key", "value": "", "type": "path", "description": "The build status' unique key" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ] }, "docs": "Returns the specified build status for a commit." }, { "info": { "name": "Update a build status for a commit", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/repositories/:workspace/:repo_slug/commit/:commit/statuses/build/:key", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The commit's SHA1." }, { "name": "key", "value": "", "type": "path", "description": "The build status' unique key" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ] }, "docs": "Used to update the current status of a build status object on the\nspecific commit.\n\nThis operation can also be used to change other properties of the\nbuild status:\n\n* `state`\n* `name`\n* `description`\n* `url`\n* `refname`\n\nThe `key` cannot be changed." }, { "info": { "name": "List commit statuses for a pull request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/statuses", "params": [ { "name": "pull_request_id", "value": "", "type": "path", "description": "The id of the pull request." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "q", "value": "", "type": "query", "description": "Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n" }, { "name": "sort", "value": "", "type": "query", "description": "Field by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\nDefaults to `created_on`.\n" } ] }, "docs": "Returns all statuses (e.g. build results) for the given pull\nrequest." } ] } ], "bundled": true }