{"openapi":"3.0.0","servers":[{"url":"https://api.bitbucket.org/2.0"}],"info":{"contact":{"email":"support@bitbucket.org","name":"Bitbucket Support","url":"https://support.atlassian.com/bitbucket-cloud/"},"description":"Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.","termsOfService":"https://www.atlassian.com/legal/customer-agreement","title":"Bitbucket API","version":"2.0","x-apisguru-categories":["developer_tools","collaboration"],"x-logo":{"url":"https://d301sr5gafysq2.cloudfront.net/0c55837759e5/img/homepage/bitbucket-logo-blue.svg"},"x-origin":[{"format":"openapi","url":"https://bitbucket.org/api/swagger.json","version":"3.0"}],"x-providerName":"bitbucket.org","x-tags":["code repository","code collaboration","git"]},"externalDocs":{"url":"https://bitbucket.org/api"},"tags":[{"description":"The addon resource is intended to use used by Bitbucket Cloud Connect\nApps, and only supports JWT authentication.\n","name":"Addon"},{"description":"Repository owners and administrators can set branch management\nrules on a repository that control what can be pushed by whom.\nThrough these rules, you can enforce a project or team\nworkflow. For example, owners or administrators can:\n\n* Limit push powers\n* Prevent branch deletion\n* Prevent history re-writes (Git only)\n","name":"Branch restrictions"},{"description":"The branching model resource is used to modify the branching model\nfor a repository.\n\nYou can use the branching model to define a branch based workflow\nfor your repositories. When you map your workflow to branch types,\nyou can ensure that branches are named consistently by configuring\nwhich branch types to make available.\n","name":"Branching model"},{"description":"Commit statuses provide a way to tag commits with meta data,\nlike automated build results.\n","name":"Commit statuses"},{"description":"These are the repository's commits. They are paginated and returned in\nreverse chronological order, similar to the output of git log.\n","name":"Commits"},{"description":"Teams are deploying code faster than ever, thanks to continuous\ndelivery practices and tools like Bitbucket Pipelines. Bitbucket\nDeployments gives teams visibility into their deployment\nenvironments and helps teams to track how far changes have\nprogressed in their deployment pipeline.\n","name":"Deployments"},{"description":"Access the list of download links associated with the repository.","name":"Downloads"},{"description":"The issue resources provide functionality for getting information on\nissues in an issue tracker, creating new issues, updating them and deleting\nthem.\n\nYou can access public issues without authentication, but you can't gain access\nto private repositories' issues. By authenticating, you will get the ability\nto create issues, as well as access to updating data or deleting issues you\nhave access to.\n","name":"Issue tracker"},{"description":"Bitbucket Pipelines brings continuous delivery to Bitbucket\nCloud, empowering teams with full branching to deployment\nvisibility and faster feedback loops.\n","name":"Pipelines"},{"description":"Bitbucket Cloud projects make it easier for teams to focus on\na goal, product, or process by organizing their repositories.\n","name":"Projects"},{"description":"Pull requests are a feature that makes it easier for developers\nto collaborate using Bitbucket. They provide a user-friendly web\ninterface for discussing proposed changes before integrating them\ninto the official project.\n","name":"Pullrequests"},{"description":"The refs resource allows you access branches and tags in a repository.\nBy default, results will be in the order the underlying source control\nsystem returns them and identical to the ordering one sees when running\n\"$ git show-ref\". Note that this follows simple lexical ordering of the\n ref names.\n","name":"Refs"},{"description":"Code insights provides reports, annotations, and metrics to help you\nand your team improve code quality in pull requests throughout the code\nreview process. Some of the available code insights are static analysis\nreports, security scan results, artifact links, unit tests, and build\nstatus.\n","name":"Reports"},{"description":"A Git repository is a virtual storage of your project. It\nallows you to save versions of your code, which you can access\nwhen needed. The repo resource allows you to access public repos,\nor repos that belong to a specific workspace.\n","name":"Repositories"},{"description":"Snippets allow you share code segments or files with yourself, members of\nyour workspace, or the world.\n\nLike pull requests, repositories and workspaces, the full set of snippets\nis defined by what the current user has access to. This includes all\nsnippets owned by any of the workspaces the user is a member of, or\nsnippets by other users that the current user is either watching or has\n collaborated on (for instance by commenting on it).\n","name":"Snippets"},{"description":"Browse the source code in the repository and\n create new commits by uploading.","name":"Source"},{"description":"The SSH resource allows you to manage SSH keys.\n","name":"Ssh"},{"description":"The teams resource has been deprecated, and the workspaces\nendpoint should be used instead.\n\nThe teams resource returns all the teams that the authenticated\nuser is associated with.\n","name":"Teams"},{"description":"The users resource allows you to access public information\nassociated with a user account. Most resources in the users\nendpoint have been deprecated in favor of workspaces.\n","name":"Users"},{"description":"Webhooks provide a way to configure Bitbucket Cloud to make requests to\nyour server (or another external service) whenever certain events occur in\nBitbucket Cloud.\n\nA webhook consists of:\n\n* A subject -- The resource that generates the events. Currently, this resource\nis the repository, user account, or team where you create the webhook.\n* One or more event -- The default event is a repository push, but you can\nselect multiple events that can trigger the webhook.\n* A URL -- The endpoint where you want Bitbucket to send the event payloads\nwhen a matching event happens.\n\nThere are two parts to getting a webhook to work: creating the webhook and\ntriggering the webhook. After you create a webhook for an event, every time\nthat event occurs, Bitbucket sends a payload request that describes the event\nto the specified URL. Thus, you can think of webhooks as a kind of\nnotification system.\n\nUse webhooks to integrate applications with Bitbucket Cloud. The following\nuse cases provides examples of when you would want to use webhooks:\n\n* Every time a user pushes commits in a repository, you may want to notify\nyour CI server to start a build.\n* Every time a user pushes commits or creates a pull request, you may want to\ndisplay a notification in your application.\n","name":"Webhooks"},{"description":"The wiki is a simple place to keep documents. Some people use it\nas their project home page. The wiki is a Git repository, so you\ncan clone it and edit it like any other source files.\n","name":"Wiki"},{"description":"A workspace is where you create repositories, collaborate on\nyour code, and organize different streams of work in your Bitbucket\nCloud account. Workspaces replace the use of teams and users in API\ncalls.\n","name":"Workspaces"}],"paths":{"/addon":{"delete":{"description":"Deletes the application for the user.\n\nThis endpoint is intended to be used by Bitbucket Connect apps\nand only supports JWT authentication -- that is how Bitbucket\nidentifies the particular installation of the app. Developers\nwith applications registered in the \"Develop Apps\" section\nof Bitbucket Marketplace need not use this endpoint as\nupdates for those applications can be sent out via the\nUI of that section.\n\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \"\n```","responses":{"204":{"description":"Request has succeeded. The application has been deleted for the user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No authorization."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Improper authentication."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Delete an app","tags":["Addon"]},"parameters":[],"put":{"description":"Updates the application installation for the user.\n\nThis endpoint is intended to be used by Bitbucket Connect apps\nand only supports JWT authentication -- that is how Bitbucket\nidentifies the particular installation of the app. Developers\nwith applications registered in the \"Develop Apps\" section\nof Bitbucket need not use this endpoint as updates for those\napplications can be sent out via the UI of that section.\n\nPassing an empty body will update the installation using the\nexisting descriptor URL.\n\n```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{}'\n```\n\nThe new `descriptor` for the installation can be also provided\nin the body directly.\n\n```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"descriptor\": $NEW_DESCRIPTOR}'\n```\n\nIn both these modes the URL of the descriptor cannot be changed. To\nchange the descriptor location and upgrade an installation\nthe request must be made exclusively with a `descriptor_url`.\n\n ```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"descriptor_url\": $NEW_URL}'\n```\n\nThe `descriptor_url` must exactly match the marketplace registration\nthat Atlassian has for the application. Contact your Atlassian\ndeveloper advocate to update this registration. Once the registration\nhas been updated you may call this resource for each installation.\n\nNote that the scopes of the application cannot be increased\nin the new descriptor nor reduced to none.","responses":{"204":{"description":"Request has succeeded. The installation has been updated to the new descriptor."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Scopes have increased or decreased to none."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No authorization."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Improper authentication."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Update an installed app","tags":["Addon"]}},"/addon/linkers":{"get":{"description":"Gets a list of all [linkers](/cloud/bitbucket/modules/linker/)\nfor the authenticated application.","responses":{"200":{"description":"Successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"List linkers for an app","tags":["Addon"]},"parameters":[]},"/addon/linkers/{linker_key}":{"get":{"description":"Gets a [linker](/cloud/bitbucket/modules/linker/) specified by `linker_key`\nfor the authenticated application.","responses":{"200":{"description":"Successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker does not exist."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Get a linker for an app","tags":["Addon"]},"parameters":[{"description":"The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor.","in":"path","name":"linker_key","required":true,"schema":{"type":"string"}}]},"/addon/linkers/{linker_key}/values":{"delete":{"description":"Delete all [linker](/cloud/bitbucket/modules/linker/) values for the\nspecified linker of the authenticated application.","responses":{"204":{"description":"Successfully deleted the linker values."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker does not exist."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Delete all linker values","tags":["Addon"]},"get":{"description":"Gets a list of all [linker](/cloud/bitbucket/modules/linker/) values for the\nspecified linker of the authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)","responses":{"200":{"description":"Successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker does not exist."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"List linker values for a linker","tags":["Addon"]},"parameters":[{"description":"The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor.","in":"path","name":"linker_key","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a [linker](/cloud/bitbucket/modules/linker/) value for the specified\nlinker of authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)","responses":{"201":{"description":"Successfully created the linker value."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker already has the value being added."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Create a linker value","tags":["Addon"]},"put":{"description":"Bulk update [linker](/cloud/bitbucket/modules/linker/) values for the specified\nlinker of the authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)","responses":{"204":{"description":"Successfully updated the linker values."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Invalid input."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker does not exist."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Update a linker value","tags":["Addon"]}},"/addon/linkers/{linker_key}/values/{value_id}":{"delete":{"description":"Delete a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application.","responses":{"204":{"description":"Successfully deleted the linker value."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker value does not exist."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Delete a linker value","tags":["Addon"]},"get":{"description":"Get a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application.","responses":{"200":{"description":"Successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Authentication must use app JWT"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The linker value does not exist."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Get a linker value","tags":["Addon"]},"parameters":[{"description":"The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor.","in":"path","name":"linker_key","required":true,"schema":{"type":"string"}},{"description":"The numeric ID of the linker value.","in":"path","name":"value_id","required":true,"schema":{"type":"integer"}}]},"/hook_events":{"get":{"description":"Returns the webhook resource or subject types on which webhooks can\nbe registered.\n\nEach resource/subject type contains an `events` link that returns the\npaginated list of specific events each individual subject type can\nemit.\n\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events\n\n{\n \"repository\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/repository\"\n }\n }\n },\n \"workspace\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/workspace\"\n }\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subject_types"}}},"description":"A mapping of resource/subject types pointing to their individual event types."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Get a webhook resource","tags":["Webhooks"]},"parameters":[]},"/hook_events/{subject_type}":{"get":{"description":"Returns a paginated list of all valid webhook events for the\nspecified entity.\n**The team and user webhooks are deprecated, and you should use workspace instead.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nThis is public data that does not require any scopes or authentication.\n\nExample:\n\nNOTE: The following example is a truncated response object for the `workspace` `subject_type`.\nWe return the same structure for the other `subject_type` objects.\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events/workspace\n{\n \"page\": 1,\n \"pagelen\": 30,\n \"size\": 21,\n \"values\": [\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository push occurs\",\n \"event\": \"repo:push\",\n \"label\": \"Push\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository fork occurs\",\n \"event\": \"repo:fork\",\n \"label\": \"Fork\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository import occurs\",\n \"event\": \"repo:imported\",\n \"label\": \"Import\"\n },\n ...\n {\n \"category\":\"Pull Request\",\n \"label\":\"Approved\",\n \"description\":\"When someone has approved a pull request\",\n \"event\":\"pullrequest:approved\"\n },\n ]\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_hook_events"}}},"description":"A paginated list of webhook types available to subscribe on."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If an invalid `{subject_type}` value was specified."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"List subscribable webhook types","tags":["Webhooks"]},"parameters":[{"description":"A resource or subject type.","in":"path","name":"subject_type","required":true,"schema":{"enum":["repository","workspace"],"type":"string"}}]},"/pullrequests/{selected_user}":{"get":{"description":"Returns all pull requests authored by the specified user.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.","parameters":[{"description":"Only return pull requests that are in this state. This parameter can be repeated.","in":"query","name":"state","schema":{"enum":["OPEN","MERGED","DECLINED","SUPERSEDED"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pullrequests"}}},"description":"All pull requests authored by the specified user."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List pull requests for a user","tags":["Pullrequests"]},"parameters":[{"description":"This can either be the username of the pull request author, the author's UUID\nsurrounded by curly-braces, for example: `{account UUID}`, or the author's Atlassian ID.\n","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}}]},"/repositories":{"get":{"description":"Returns a paginated list of all public repositories.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.","parameters":[{"description":"Filter the results to include only repositories created on or\nafter this [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)\n timestamp. Example: `YYYY-MM-DDTHH:mm:ss.sssZ`","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Filters the result based on the authenticated user's role on each repository.\n\n* **member**: returns repositories to which the user has explicit read access\n* **contributor**: returns repositories to which the user has explicit write access\n* **admin**: returns repositories to which the user has explicit administrator access\n* **owner**: returns all repositories owned by the current user\n","in":"query","name":"role","required":false,"schema":{"enum":["admin","contributor","member","owner"],"type":"string"}},{"description":"Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n`role` parameter must also be specified.\n","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repositories"}}},"description":"All public repositories."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List public repositories","tags":["Repositories"]},"parameters":[]},"/repositories/{workspace}":{"get":{"description":"Returns a paginated list of all repositories owned by the specified\nworkspace.\n\nThe result can be narrowed down based on the authenticated user's role.\n\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.","parameters":[{"description":"\nFilters the result based on the authenticated user's role on each repository.\n\n* **member**: returns repositories to which the user has explicit read access\n* **contributor**: returns repositories to which the user has explicit write access\n* **admin**: returns repositories to which the user has explicit administrator access\n* **owner**: returns all repositories owned by the current user\n","in":"query","name":"role","required":false,"schema":{"enum":["admin","contributor","member","owner"],"type":"string"}},{"description":"\nQuery string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nField by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n ","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repositories"}}},"description":"The repositories owned by the specified account."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified account does not exist."},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified account marked as spam."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List repositories in a workspace","tags":["Repositories"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}":{"delete":{"description":"Deletes the repository. This is an irreversible operation.\n\nThis does not affect its forks.","parameters":[{"description":"If a repository has been moved to a new location, use this parameter to\nshow users a friendly message in the Bitbucket UI that the repository\nhas moved to a new location. However, a GET to this endpoint will still\nreturn a 404.\n","in":"query","name":"redirect_to","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Indicates successful deletion."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the caller either does not have admin access to the repository, or the repository is set to read-only."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist."}},"security":[{"oauth2":["repository:delete"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a repository","tags":["Repositories"]},"get":{"description":"Returns the object describing this repository.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"The repository object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have access to it."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If no repository exists at this location."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a repository","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new repository.\n\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nor\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"{ba516952-992a-4c2d-acbd-17d502922f96}\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nThe project must be assigned for all repositories. If the project is not provided,\nthe repository is automatically assigned to the oldest project in the workspace.\n\nNote: In the examples above, the workspace ID `teamsinspace`,\nand/or the repository name `hablanding` can be replaced by UUIDs.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"The repository that is to be created. Note that most object elements are optional. Elements \"owner\" and \"full_name\" are ignored as the URL implies them."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"The newly created repository."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Create a repository","tags":["Repositories"]},"put":{"description":"Since this endpoint can be used to both update and to create a\nrepository, the request body depends on the intent.\n\n#### Creation\n\nSee the POST documentation for the repository endpoint for an example\nof the request body.\n\n#### Update\n\nNote: Changing the `name` of the repository will cause the location to\nbe changed. This is because the URL of the repo is derived from the\nname (a process called slugification). In such a scenario, it is\npossible for the request to fail if the newly created slug conflicts\nwith an existing repository's slug. But if there is no conflict,\nthe new location will be returned in the `Location` header of the\nresponse.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"The repository that is to be updated.\n\nNote that the elements \"owner\" and \"full_name\" are ignored since the\nURL implies them.\n"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"The existing repository has been updated","headers":{"Location":{"description":"The location of the repository. This header is only\nprovided when the repository's name is changed.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"A new repository has been created","headers":{"Location":{"description":"The location of the newly created repository","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update a repository","tags":["Repositories"]}},"/repositories/{workspace}/{repo_slug}/branch-restrictions":{"get":{"description":"Returns a paginated list of all branch restrictions on the\nrepository.","parameters":[{"description":"Branch restrictions of this type","in":"query","name":"kind","required":false,"schema":{"type":"string"}},{"description":"Branch restrictions applied to branches of this pattern","in":"query","name":"pattern","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_branchrestrictions"}}},"description":"A paginated list of branch restrictions"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"List branch restrictions","tags":["Branch restrictions"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new branch restriction rule for a repository.\n\n`kind` describes what will be restricted. Allowed values include:\n`push`, `force`, `delete` and `restrict_merges`.\n\nDifferent kinds of branch restrictions have different requirements:\n\n* `push` and `restrict_merges` require `users` and `groups` to be\n specified. Empty lists are allowed, in which case permission is\n denied for everybody.\n\nThe restriction applies to all branches that match. There are\ntwo ways to match a branch. It is configured in `branch_match_kind`:\n\n1. `glob`: Matches a branch against the `pattern`. A `'*'` in\n `pattern` will expand to match zero or more characters, and every\n other character matches itself. For example, `'foo*'` will match\n `'foo'` and `'foobar'`, but not `'barfoo'`. `'*'` will match all\n branches.\n2. `branching_model`: Matches a branch against the repository's\n branching model. The `branch_type` controls the type of branch\n to match. Allowed values include: `production`, `development`,\n `bugfix`, `release`, `feature` and `hotfix`.\n\nThe combination of `kind` and match must be unique. This means that\ntwo `glob` restrictions in a repository cannot have the same `kind` and\n`pattern`. Additionally, two `branching_model` restrictions in a\nrepository cannot have the same `kind` and `branch_type`.\n\n`users` and `groups` are lists of users and groups that are except from\nthe restriction. They can only be configured in `push` and\n`restrict_merges` restrictions. The `push` restriction stops a user\npushing to matching branches unless that user is in `users` or is a\nmember of a group in `groups`. The `restrict_merges` stops a user\nmerging pull requests to matching branches unless that user is in\n`users` or is a member of a group in `groups`. Adding new users or\ngroups to an existing restriction should be done via `PUT`.\n\nNote that branch restrictions with overlapping matchers is allowed,\nbut the resulting behavior may be surprising.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branchrestriction"}}},"description":"The new rule","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branchrestriction"}}},"description":"A paginated list of branch restrictions"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Create a branch restriction rule","tags":["Branch restrictions"]}},"/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}":{"delete":{"description":"Deletes an existing branch restriction rule.","responses":{"204":{"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or branch restriction id does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a branch restriction rule","tags":["Branch restrictions"]},"get":{"description":"Returns a specific branch restriction rule.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branchrestriction"}}},"description":"The branch restriction rule"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or branch restriction id does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get a branch restriction rule","tags":["Branch restrictions"]},"parameters":[{"description":"The restriction rule's id","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates an existing branch restriction rule.\n\nFields not present in the request body are ignored.\n\nSee [`POST`](/cloud/bitbucket/rest/api-group-branch-restrictions/#api-repositories-workspace-repo-slug-branch-restrictions-post) for details.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branchrestriction"}}},"description":"The new version of the existing rule","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branchrestriction"}}},"description":"The updated branch restriction rule"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or branch restriction id does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update a branch restriction rule","tags":["Branch restrictions"]}},"/repositories/{workspace}/{repo_slug}/branching-model":{"get":{"description":"Return the branching model as applied to the repository. This view is\nread-only. The branching model settings can be changed using the\n[settings](#api-repositories-workspace-repo-slug-branching-model-settings-get) API.\n\nThe returned object:\n\n1. Always has a `development` property. `development.branch` contains\n the actual repository branch object that is considered to be the\n `development` branch. `development.branch` will not be present\n if it does not exist.\n2. Might have a `production` property. `production` will not\n be present when `production` is disabled.\n `production.branch` contains the actual branch object that is\n considered to be the `production` branch. `production.branch` will\n not be present if it does not exist.\n3. Always has a `branch_types` array which contains all enabled branch\n types.\n\nExample body:\n\n```\n{\n \"development\": {\n \"name\": \"master\",\n \"branch\": {\n \"type\": \"branch\",\n \"name\": \"master\",\n \"target\": {\n \"hash\": \"16dffcb0de1b22e249db6799532074cf32efe80f\"\n }\n },\n \"use_mainbranch\": true\n },\n \"production\": {\n \"name\": \"production\",\n \"branch\": {\n \"type\": \"branch\",\n \"name\": \"production\",\n \"target\": {\n \"hash\": \"16dffcb0de1b22e249db6799532074cf32efe80f\"\n }\n },\n \"use_mainbranch\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branching_model"}}},"description":"The branching model object"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have read access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get the branching model for a repository","tags":["Branching model"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/branching-model/settings":{"get":{"description":"Return the branching model configuration for a repository. The returned\nobject:\n\n1. Always has a `development` property for the development branch.\n2. Always a `production` property for the production branch. The\n production branch can be disabled.\n3. The `branch_types` contains all the branch types.\n\nThis is the raw configuration for the branching model. A client\nwishing to see the branching model with its actual current branches may\nfind the [active model API](/cloud/bitbucket/rest/api-group-branching-model/#api-repositories-workspace-repo-slug-branching-model-get) more useful.\n\nExample body:\n\n```\n{\n \"development\": {\n \"is_valid\": true,\n \"name\": null,\n \"use_mainbranch\": true\n },\n \"production\": {\n \"is_valid\": true,\n \"name\": \"production\",\n \"use_mainbranch\": false,\n \"enabled\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"enabled\": true,\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"enabled\": true,\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"enabled\": false,\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model_settings\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model/settings\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branching_model_settings"}}},"description":"The branching model configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get the branching model config for a repository","tags":["Branching model"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Update the branching model configuration for a repository.\n\nThe `development` branch can be configured to a specific branch or to\ntrack the main branch. When set to a specific branch it must\ncurrently exist. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`development` property will leave the development branch unchanged.\n\nIt is possible for the `development` branch to be invalid. This\nhappens when it points at a specific branch that has been\ndeleted. This is indicated in the `is_valid` field for the branch. It is\nnot possible to update the settings for `development` if that\nwould leave the branch in an invalid state. Such a request will be\nrejected.\n\nThe `production` branch can be a specific branch, the main\nbranch or disabled. When set to a specific branch it must currently\nexist. The `enabled` property can be used to enable (`true`) or\ndisable (`false`) it. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`production` property will leave the production branch unchanged.\n\nIt is possible for the `production` branch to be invalid. This\nhappens when it points at a specific branch that has been\ndeleted. This is indicated in the `is_valid` field for the branch. A\nrequest that would leave `production` enabled and invalid will be\nrejected. It is possible to update `production` and make it invalid if\nit would also be left disabled.\n\nThe `branch_types` property contains the branch types to be updated.\nOnly the branch types passed will be updated. All updates will be\nrejected if it would leave the branching model in an invalid state.\nFor branch types this means that:\n\n1. The prefixes for all enabled branch types are valid. For example,\n it is not possible to use '*' inside a Git prefix.\n2. A prefix of an enabled branch type must not be a prefix of another\n enabled branch type. This is to ensure that a branch can be easily\n classified by its prefix unambiguously.\n\nIt is possible to store an invalid prefix if that branch type would be\nleft disabled. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. Each branch type must\nhave a `kind` property to identify it.\n\nExample Body:\n\n```\n {\n \"development\": {\n \"use_mainbranch\": true\n },\n \"production\": {\n \"enabled\": true,\n \"use_mainbranch\": false,\n \"name\": \"production\"\n },\n \"branch_types\": [\n {\n \"kind\": \"bugfix\",\n \"enabled\": true,\n \"prefix\": \"bugfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"release\",\n \"enabled\": false,\n }\n ]\n }\n```\n\nThere is currently a side effect when using this API endpoint. If the\nrepository is inheriting branching model settings from its project,\nupdating the branching model for this repository will disable the\nproject setting inheritance.\n\n\nWe have deprecated this side effect and will remove it on 1 August 2022.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branching_model_settings"}}},"description":"The updated branching model configuration"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request contains invalid branching model configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update the branching model config for a repository","tags":["Branching model"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}":{"get":{"description":"Returns the specified commit.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a1\n{\n \"rendered\": {\n \"message\": {\n \"raw\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"markup\": \"markdown\",\n \"html\": \"

Add a GEORDI_OUTPUT_DIR setting

\",\n \"type\": \"rendered\"\n }\n },\n \"hash\": \"f7591a13eda445d9a9167f98eb870319f4b6c2d8\",\n \"repository\": {\n \"name\": \"geordi\",\n \"type\": \"repository\",\n \"full_name\": \"bitbucket/geordi\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B85d08b4e-571d-44e9-a507-fa476535aa98%7D?ts=1730260\"\n }\n },\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/patch/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi/commits/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diff/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Brodie Rao \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"Brodie Rao\",\n \"uuid\": \"{9484702e-c663-4afd-aefb-c93a8cd31c28}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B9484702e-c663-4afd-aefb-c93a8cd31c28%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B9484702e-c663-4afd-aefb-c93a8cd31c28%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:3aae1e05-702a-41e5-81c8-f36f29afb6ca/613070db-28b0-421f-8dba-ae8a87e2a5c7/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"brodie\",\n \"account_id\": \"557058:3aae1e05-702a-41e5-81c8-f36f29afb6ca\"\n }\n },\n \"summary\": {\n \"raw\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"markup\": \"markdown\",\n \"html\": \"

Add a GEORDI_OUTPUT_DIR setting

\",\n \"type\": \"rendered\"\n },\n \"participants\": [],\n \"parents\": [\n {\n \"type\": \"commit\",\n \"hash\": \"f06941fec4ef6bcb0c2456927a0cf258fa4f899b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f06941fec4ef6bcb0c2456927a0cf258fa4f899b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi/commits/f06941fec4ef6bcb0c2456927a0cf258fa4f899b\"\n }\n }\n }\n ],\n \"date\": \"2012-07-16T19:37:54+00:00\",\n \"message\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"type\": \"commit\"\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit"}}},"description":"The commit object"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified commit or repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a commit","tags":["Commits"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/commit/{commit}/approve":{"delete":{"description":"Redact the authenticated user's approval of the specified commit.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.","responses":{"204":{"description":"An empty response indicating the authenticated user's approval has been withdrawn."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified commit, or the repository does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Unapprove a commit","tags":["Commits"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Approve the specified commit as the authenticated user.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/participant"}}},"description":"The `participant` object recording that the authenticated user approved the commit."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified commit, or the repository does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Approve a commit","tags":["Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/comments":{"get":{"description":"Returns the commit's comments.\n\nThis includes both global and inline comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.","parameters":[{"description":"Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Field by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_commit_comments"}}},"description":"A paginated list of commit comments."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List a commit's comments","tags":["Commits"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates new comment on the specified commit.\n\nTo post a reply to an existing comment, include the `parent.id` field:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/db9ba1e031d07a02603eae0e559a7adc010257fc/comments/ \\\n -X POST -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"One more thing!\"},\n \"parent\": {\"id\": 5728901}}'\n```","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit_comment"}}},"description":"The specified comment.","required":true},"responses":{"201":{"description":"The newly created comment.","headers":{"Location":{"description":"The location of the newly created comment.","schema":{"type":"string"}}}},"400":{"description":"If the comment was detected as spam, or if the parent comment is not attached to the same node as the new comment"},"404":{"description":"If a parent ID was passed in that cannot be found"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Create comment for a commit","tags":["Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}":{"delete":{"description":"Deletes the specified commit comment.\n\nNote that deleting comments that have visible replies that point to\nthem will not really delete the resource. This is to retain the integrity\nof the original comment tree. Instead, the `deleted` element is set to\n`true` and the content is blanked out. The comment will continue to be\nreturned by the collections and self endpoints.","responses":{"204":{"description":"Indicates the comment was deleted by this action or a previous delete."},"404":{"description":"If the comment doesn't exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a commit comment","tags":["Commits"]},"get":{"description":"Returns the specified commit comment.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit_comment"}}},"description":"The commit comment."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a commit comment","tags":["Commits"]},"parameters":[{"description":"The id of the comment.","in":"path","name":"comment_id","required":true,"schema":{"type":"integer"}},{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Used to update the contents of a comment. Only the content of the comment can be updated.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/7f71b5/comments/5728901 \\\n -X PUT -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"One more thing!\"}'\n```","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit_comment"}}},"description":"The updated comment.","required":true},"responses":{"201":{"description":"The newly updated comment.","headers":{"Location":{"description":"The location of the newly updated comment.","schema":{"type":"string"}}}},"400":{"description":"If the comment update was detected as spam"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Update a commit comment","tags":["Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}":{"delete":{"description":"Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.","operationId":"deleteCommitHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"An empty response."}},"summary":"Delete a commit application property","tags":["properties"]},"get":{"description":"Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.","operationId":"getCommitHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_property"}}},"description":"The value of the property."}},"summary":"Get a commit application property","tags":["properties"]},"put":{"description":"Update an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.","operationId":"updateCommitHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/application_property"},"responses":{"204":{"description":"An empty response."}},"summary":"Update a commit application property","tags":["properties"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests":{"get":{"description":"Returns a paginated list of all pull requests as part of which this commit was reviewed. Pull Request Commit Links app must be installed first before using this API; installation automatically occurs when 'Go to pull request' is clicked from the web interface for a commit's details.","operationId":"getPullrequestsForCommit","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository; either the UUID in curly braces, or the slug","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The SHA1 of the commit","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Which page to retrieve","in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","type":"integer"}},{"description":"How many pull requests to retrieve per page","in":"query","name":"pagelen","required":false,"schema":{"default":30,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pullrequests"}}},"description":"The paginated list of pull requests."},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pullrequests"}}},"description":"The repository's pull requests are still being indexed."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Either the repository does not exist, or pull request commit links have not yet been indexed."}},"summary":"List pull requests that contain a commit","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/reports":{"get":{"description":"Returns a paginated list of Reports linked to this commit.","operationId":"getReportsForCommit","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit for which to retrieve reports.","in":"path","name":"commit","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_reports"}}},"description":"OK"}},"summary":"List reports","tags":["Reports","Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}":{"delete":{"description":"Deletes a single Report matching the provided ID.","operationId":"deleteReport","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit the report belongs to.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content"}},"summary":"Delete a report","tags":["Reports","Commits"]},"get":{"description":"Returns a single Report matching the provided ID.","operationId":"getReport","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit the report belongs to.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The report with the given ID was not found."}},"summary":"Get a report","tags":["Reports","Commits"]},"put":{"description":"Creates or updates a report for the specified commit.\nTo upload a report, make sure to generate an ID that is unique across all reports for that commit. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-001.\n\n### Sample cURL request:\n```\ncurl --request PUT 'https://api.bitbucket.org/2.0/repositories///commit//reports/mysystem-001' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Security scan report\",\n \"details\": \"This pull request introduces 10 new dependency vulnerabilities.\",\n \"report_type\": \"SECURITY\",\n \"reporter\": \"mySystem\",\n \"link\": \"http://www.mysystem.com/reports/001\",\n \"result\": \"FAILED\",\n \"data\": [\n {\n \"title\": \"Duration (seconds)\",\n \"type\": \"DURATION\",\n \"value\": 14\n },\n {\n \"title\": \"Safe to merge?\",\n \"type\": \"BOOLEAN\",\n \"value\": false\n }\n ]\n}'\n```\n\n### Possible field values:\nreport_type: SECURITY, COVERAGE, TEST, BUG\nresult: PASSED, FAILED, PENDING\ndata.type: BOOLEAN, DATE, DURATION, LINK, NUMBER, PERCENTAGE, TEXT\n\n#### Data field formats\n| Type Field | Value Field Type | Value Field Display |\n|:--------------|:------------------|:--------------------|\n| None/ Omitted | Number, String or Boolean (not an array or object) | Plain text |\n| BOOLEAN\t| Boolean | The value will be read as a JSON boolean and displayed as 'Yes' or 'No'. |\n| DATE | Number | The value will be read as a JSON number in the form of a Unix timestamp (milliseconds) and will be displayed as a relative date if the date is less than one week ago, otherwise it will be displayed as an absolute date. |\n| DURATION | Number | The value will be read as a JSON number in milliseconds and will be displayed in a human readable duration format. |\n| LINK | Object: `{\"text\": \"Link text here\", \"href\": \"https://link.to.annotation/in/external/tool\"}` | The value will be read as a JSON object containing the fields \"text\" and \"href\" and will be displayed as a clickable link on the report. |\n| NUMBER | Number | The value will be read as a JSON number and large numbers will be displayed in a human readable format (e.g. 14.3k). |\n| PERCENTAGE | Number (between 0 and 100) | The value will be read as a JSON number between 0 and 100 and will be displayed with a percentage sign. |\n| TEXT | String | The value will be read as a JSON string and will be displayed as-is |\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n","operationId":"createOrUpdateReport","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit the report belongs to.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report"}}},"description":"The report to create or update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The provided Report object is malformed or incomplete."}},"summary":"Create or update a report","tags":["Reports","Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations":{"get":{"description":"Returns a paginated list of Annotations for a specified report.","operationId":"getAnnotationsForReport","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit for which to retrieve reports.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Uuid or external-if of the report for which to get annotations for.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_annotations"}}},"description":"OK"}},"summary":"List annotations","tags":["Reports","Commits"]},"post":{"description":"Bulk upload of annotations.\nAnnotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.\n\nAdd the annotations you want to upload as objects in a JSON array and make sure each annotation has the external_id field set to a unique value. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001. The external id can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). You can upload up to 100 annotations per POST request.\n\n### Sample cURL request:\n```\ncurl --location 'https://api.bitbucket.org/2.0/repositories///commit//reports/mysystem-001/annotations' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"external_id\": \"mysystem-annotation001\",\n \"title\": \"Security scan report\",\n \"annotation_type\": \"VULNERABILITY\",\n \"summary\": \"This line represents a security threat.\",\n \"severity\": \"HIGH\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Main.java\",\n \"line\": 42\n },\n {\n \"external_id\": \"mySystem-annotation002\",\n \"title\": \"Bug report\",\n \"annotation_type\": \"BUG\",\n \"result\": \"FAILED\",\n \"summary\": \"This line might introduce a bug.\",\n \"severity\": \"MEDIUM\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Helper.java\",\n \"line\": 13\n }\n]'\n```\n\n### Possible field values:\nannotation_type: VULNERABILITY, CODE_SMELL, BUG\nresult: PASSED, FAILED, IGNORED, SKIPPED\nseverity: HIGH, MEDIUM, LOW, CRITICAL\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n","operationId":"bulkCreateOrUpdateAnnotations","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit for which to retrieve reports.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Uuid or external-if of the report for which to get annotations for.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/report_annotation"},"maxItems":100,"minItems":1,"type":"array"}}},"description":"The annotations to create or update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/report_annotation"},"type":"array"}}},"description":"OK"}},"summary":"Bulk create or update annotations","tags":["Reports","Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}":{"delete":{"description":"Deletes a single Annotation matching the provided ID.","operationId":"deleteAnnotation","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit the annotation belongs to.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the annotation.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the annotation.","in":"path","name":"annotationId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content"}},"summary":"Delete an annotation","tags":["Reports","Commits"]},"get":{"description":"Returns a single Annotation matching the provided ID.","operationId":"getAnnotation","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit the report belongs to.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the annotation.","in":"path","name":"annotationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_annotation"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The annotation with the given ID was not found."}},"summary":"Get an annotation","tags":["Reports","Commits"]},"put":{"description":"Creates or updates an individual annotation for the specified report.\nAnnotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.\n\nJust as reports, annotation needs to be uploaded with a unique ID that can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001.\n\n### Sample cURL request:\n```\ncurl --request PUT 'https://api.bitbucket.org/2.0/repositories///commit//reports/mySystem-001/annotations/mysystem-annotation001' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Security scan report\",\n \"annotation_type\": \"VULNERABILITY\",\n \"summary\": \"This line represents a security thread.\",\n \"severity\": \"HIGH\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Main.java\",\n \"line\": 42\n}'\n```\n\n### Possible field values:\nannotation_type: VULNERABILITY, CODE_SMELL, BUG\nresult: PASSED, FAILED, IGNORED, SKIPPED\nseverity: HIGH, MEDIUM, LOW, CRITICAL\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n","operationId":"createOrUpdateAnnotation","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The commit the report belongs to.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the report.","in":"path","name":"reportId","required":true,"schema":{"type":"string"}},{"description":"Either the uuid or external-id of the annotation.","in":"path","name":"annotationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_annotation"}}},"description":"The annotation to create or update","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_annotation"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The provided Annotation object is malformed or incomplete."}},"summary":"Create or update an annotation","tags":["Reports","Commits"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses":{"get":{"description":"Returns all statuses (e.g. build results) for a specific commit.","parameters":[{"description":"Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"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","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_commitstatuses"}}},"description":"A paginated list of all commit statuses for this commit."},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or commit does not exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List commit statuses for a commit","tags":["Commit statuses"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build":{"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"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-build-result\"\n }'\n```\n\nWhen creating a new commit status, you can use a URI template for the URL.\nTemplates are URLs that contain variable names that Bitbucket will\nevaluate at runtime whenever the URL is displayed anywhere similar to\nparameter substitution in\n[Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).\nFor example, one could use `https://foo.com/builds/{repository.full_name}`\nwhich Bitbucket will turn into `https://foo.com/builds/foo/bar` at render time.\nThe context variables available are `repository` and `commit`.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commitstatus"}}},"description":"The new commit status object."},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commitstatus"}}},"description":"The newly created build status object."},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository, commit, or build status key does not exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Create a build status for a commit","tags":["Commit statuses"]}},"/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}":{"get":{"description":"Returns the specified build status for a commit.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commitstatus"}}},"description":"The build status object with the specified key."},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository, commit, or build status key does not exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a build status for a commit","tags":["Commit statuses"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"The build status' unique key","in":"path","name":"key","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"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.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commitstatus"}}},"description":"The updated build status object"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commitstatus"}}},"description":"The updated build status object."},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or build does not exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Update a build status for a commit","tags":["Commit statuses"]}},"/repositories/{workspace}/{repo_slug}/commits":{"get":{"description":"These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log`.\nLike these tools, the DAG can be filtered.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all`).\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nAn optional `path` parameter can be specified that will limit the\nresults to commits that affect that path. `path` can either be a file\nor a directory. If a directory is specified, commits are returned that\nhave modified any file in the directory tree rooted by `path`. It is\nimportant to note that if the `path` parameter is specified, the commits\nreturned by this endpoint may no longer be a DAG, parent commits that\ndo not modify the path will be omitted from the response.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?path=README.md&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `foo` or `bar`, but not on `master`\nthat changed the file README.md.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?path=src/&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `foo` or `bar`, but not on `master`\nthat changed to a file in any file in the directory src or its children.\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_changeset"}}},"description":"A paginated list of commits"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List commits","tags":["Commits"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Identical to `GET /repositories/{workspace}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_changeset"}}},"description":"A paginated list of commits"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List commits with include/exclude","tags":["Commits"]}},"/repositories/{workspace}/{repo_slug}/commits/{revision}":{"get":{"description":"These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log`.\nLike these tools, the DAG can be filtered.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/master\n\nReturns all commits on ref `master` (similar to `git log master`).\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/dev?include=foo&exclude=master\n\nReturns all commits on ref `dev` or `foo`, except those that are reachable on\n`master` (similar to `git log dev foo ^master`).\n\nAn optional `path` parameter can be specified that will limit the\nresults to commits that affect that path. `path` can either be a file\nor a directory. If a directory is specified, commits are returned that\nhave modified any file in the directory tree rooted by `path`. It is\nimportant to note that if the `path` parameter is specified, the commits\nreturned by this endpoint may no longer be a DAG, parent commits that\ndo not modify the path will be omitted from the response.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/dev?path=README.md&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `dev` or `foo` or `bar`, but not on `master`\nthat changed the file README.md.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/dev?path=src/&include=foo&exclude=master\n\nReturns all commits that are on refs `dev` or `foo`, but not on `master`\nthat changed to a file in any file in the directory src or its children.\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_changeset"}}},"description":"A paginated list of commits"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified revision does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List commits for revision","tags":["Commits"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"A commit SHA1 or ref name.","in":"path","name":"revision","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Identical to `GET /repositories/{workspace}/{repo_slug}/commits/{revision}`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_changeset"}}},"description":"A paginated list of commits"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified revision does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List commits for revision using include/exclude","tags":["Commits"]}},"/repositories/{workspace}/{repo_slug}/components":{"get":{"description":"Returns the components that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_components"}}},"description":"The components that have been defined in the issue tracker."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List components","tags":["Issue tracker"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/components/{component_id}":{"get":{"description":"Returns the specified issue tracker component object.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/component"}}},"description":"The specified component object."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or component does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get a component for issues","tags":["Issue tracker"]},"parameters":[{"description":"The component's id","in":"path","name":"component_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/default-reviewers":{"get":{"description":"Returns the repository's default reviewers.\n\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created. To obtain the repository's default reviewers\nas well as the default reviewers inherited from the project, use the\n[effective-default-reveiwers](#api-repositories-workspace-repo-slug-effective-default-reviewers-get) endpoint.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_accounts"}}},"description":"The paginated list of default reviewers"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to view the default reviewers"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List default reviewers","tags":["Pullrequests"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}":{"delete":{"description":"Removes a default reviewer from the repository.","responses":{"204":{"description":"The specified user successfully removed from the default reviewers"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access modify the default reviewers"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Remove a user from the default reviewers","tags":["Pullrequests"]},"get":{"description":"Returns the specified reviewer.\n\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"The specified user is a default reviewer"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to check if the specified user is a default reviewer"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist or is not a default reviewer"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Get a default reviewer","tags":["Pullrequests"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account UUID}`.\n","in":"path","name":"target_username","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Adds the specified user to the repository's list of default\nreviewers.\n\nThis method is idempotent. Adding a user a second time has no effect.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"The specified user was successfully added to the default reviewers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user tried to add a team, bot user, or user without access to the repository to the default reviewers"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to modify the default reviewers"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Add a user to the default reviewers","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/deploy-keys":{"get":{"description":"Returns all deploy-keys belonging to a repository.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys\n\nOutput:\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"id\": 123,\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"label\": \"mykey\",\n \"type\": \"deploy_key\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\":{\n \"self\":{\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123\"\n }\n }\n \"last_used\": null,\n \"comment\": \"mleu@C02W454JHTD8\"\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_deploy_keys"}}},"description":"Deploy keys matching the repository"},"403":{"description":"If the specified user or repository is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user or repository does not exist"}},"security":[{"oauth2":["repository","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"List repository deploy keys","tags":["Deployments"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Create a new deploy key in a repository. Note: If authenticating a deploy key\nwith an OAuth consumer, any changes to the OAuth consumer will subsequently\ninvalidate the deploy key.\n\n\nExample:\n```\n$ curl -XPOST \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys -d \\\n'{\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8\",\n \"label\": \"mydeploykey\"\n}'\n\nOutput:\n{\n \"id\": 123,\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"label\": \"mydeploykey\",\n \"type\": \"deploy_key\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\":{\n \"self\":{\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123\"\n }\n }\n \"last_used\": null,\n \"comment\": \"mleu@C02W454JHTD8\"\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deploy_key"}}},"description":"The deploy key that was created"},"400":{"description":"Invalid deploy key inputs"},"403":{"description":"If the specified user or repository is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user or repository does not exist"}},"security":[{"oauth2":["repository","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Add a repository deploy key","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}":{"delete":{"description":"This deletes a deploy key from a repository.\n\nExample:\n```\n$ curl -XDELETE \\\n-H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234\n```","responses":{"204":{"description":"The key has been deleted"},"403":{"description":"If the current user does not have permission to delete a key for the specified user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user, repository, or deploy key does not exist"}},"security":[{"oauth2":["repository","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a repository deploy key","tags":["Deployments"]},"get":{"description":"Returns the deploy key belonging to a specific key.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234\n\nOutput:\n{\n \"comment\": \"mleu@C02W454JHTD8\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234\"\n }\n },\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"label\": \"mykey\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"id\": 1234,\n \"type\": \"deploy_key\"\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deploy_key"}}},"description":"Deploy key matching the key ID"},"403":{"description":"If the specified user or repository is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user or repository does not exist"}},"security":[{"oauth2":["repository","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get a repository deploy key","tags":["Deployments"]},"parameters":[{"description":"The key ID matching the deploy key.","in":"path","name":"key_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Create a new deploy key in a repository.\n\nThe same key needs to be passed in but the comment and label can change.\n\nExample:\n```\n$ curl -XPUT \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234 -d \\\n'{\n \"label\": \"newlabel\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 newcomment\",\n}'\n\nOutput:\n{\n \"comment\": \"newcomment\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234\"\n }\n },\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"label\": \"newlabel\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"id\": 1234,\n \"type\": \"deploy_key\"\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deploy_key"}}},"description":"The newly updated deploy key."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the submitted key or related value is invalid"},"403":{"description":"If the current user does not have permission to add a key for the specified user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user, repository, or deploy key does not exist"}},"security":[{"oauth2":["repository","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update a repository deploy key","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/deployments":{"get":{"description":"Find deployments","operationId":"getDeploymentsForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_deployments"}}},"description":"The matching deployments."}},"summary":"List deployments","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}":{"get":{"description":"Retrieve a deployment","operationId":"getDeploymentForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The deployment UUID.","in":"path","name":"deployment_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment"}}},"description":"The deployment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository or deployment with the UUID provided exists."}},"summary":"Get a deployment","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables":{"get":{"description":"Find deployment environment level variables.","operationId":"getDeploymentVariables","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_deployment_variable"}}},"description":"The retrieved deployment variables."}},"summary":"List variables for an environment","tags":["Pipelines"]},"post":{"description":"Create a deployment environment level variable.","operationId":"createDeploymentVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_variable"}}},"description":"The variable to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_variable"}}},"description":"The variable was created.","headers":{"Location":{"description":"The URL of the newly created variable.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository, environment or variable with the given UUID was not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A variable with the provided key already exists."}},"summary":"Create a variable for an environment","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}":{"delete":{"description":"Delete a deployment environment level variable.","operationId":"deleteDeploymentVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to delete.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The variable was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository, environment or variable with given UUID was not found."}},"summary":"Delete a variable for an environment","tags":["Pipelines"]},"put":{"description":"Update a deployment environment level variable.","operationId":"updateDeploymentVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to update.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_variable"}}},"description":"The updated deployment variable.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_variable"}}},"description":"The deployment variable was updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository, environment or variable with the given UUID was not found."}},"summary":"Update a variable for an environment","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/diff/{spec}":{"get":{"description":"Produces a raw git-style diff.\n\n#### Single commit spec\n\nIf the `spec` argument to this API is a single commit, the diff is\nproduced against the first parent of the specified commit.\n\n#### Two commit spec\n\nTwo commits separated by `..` may be provided as the `spec`, e.g.,\n`3a8b42..9ff173`. When two commits are provided and the `topic` query\nparameter is true or absent, this API produces a 2-way three dot diff.\nThis is the diff between source commit and the merge base of the source\ncommit and the destination commit. When the `topic` query param is false,\na simple git-style diff is produced.\n\nThe two commits are interpreted as follows:\n\n* First commit: the commit containing the changes we wish to preview\n* Second commit: the commit representing the state to which we want to\n compare the first commit\n* **Note**: This is the opposite of the order used in `git diff`.\n\n#### Comparison to patches\n\nWhile similar to patches, diffs:\n\n* Don't have a commit header (username, commit message, etc)\n* Support the optional `path=foo/bar.py` query param to filter\n the diff to just that one file diff\n\n#### Response\n\nThe raw diff is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`.","parameters":[{"description":"Generate diffs with lines of context instead of the usual three.","in":"query","name":"context","required":false,"schema":{"type":"integer"}},{"description":"Limit the diff to a particular file (this parameter\ncan be repeated for multiple paths).","in":"query","name":"path","required":false,"schema":{"type":"string"}},{"description":"Generate diffs that ignore whitespace.","in":"query","name":"ignore_whitespace","required":false,"schema":{"type":"boolean"}},{"description":"Generate diffs that include binary files, true if omitted.","in":"query","name":"binary","required":false,"schema":{"type":"boolean"}},{"description":"Whether to perform rename detection, true if omitted.","in":"query","name":"renames","required":false,"schema":{"type":"boolean"}},{"description":"This parameter is deprecated and will be removed at the end\nof 2022. The 'topic' parameter should be used instead. The\n'merge' and 'topic' parameters cannot be both used at the same\ntime.\n\nIf true, the source commit is merged into the\ndestination commit, and then a diff from the\ndestination to the merge result is returned. If false,\na simple 'two dot' diff between the source and\ndestination is returned. True if omitted.","in":"query","name":"merge","required":false,"schema":{"type":"boolean"}},{"description":"If true, returns 2-way 'three-dot' diff.\nThis is a diff between the source commit and the merge base\nof the source commit and the destination commit.\nIf false, a simple 'two dot' diff between the source and\ndestination is returned.","in":"query","name":"topic","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"The raw diff"},"555":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the diff was too large and timed out.\n\nSince this endpoint does not employ any form of pagination, but\ninstead returns the diff as a single document, it can run into\ntrouble on very large diffs. If Bitbucket times out in cases\nlike these, a 555 status code is returned."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Compare two commits","tags":["Commits"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"A commit SHA (e.g. `3a8b42`) or a commit range using double dot\nnotation (e.g. `3a8b42..9ff173`).\n","in":"path","name":"spec","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/diffstat/{spec}":{"get":{"description":"Produces a response in JSON format with a record for every path\nmodified, including information on the type of the change and the\nnumber of lines added and removed.\n\n#### Single commit spec\n\nIf the `spec` argument to this API is a single commit, the diff is\nproduced against the first parent of the specified commit.\n\n#### Two commit spec\n\nTwo commits separated by `..` may be provided as the `spec`, e.g.,\n`3a8b42..9ff173`. When two commits are provided and the `topic` query\nparameter is true or absent, this API produces a 2-way three dot diff.\nThis is the diff between source commit and the merge base of the source\ncommit and the destination commit. When the `topic` query param is false,\na simple git-style diff is produced.\n\nThe two commits are interpreted as follows:\n\n* First commit: the commit containing the changes we wish to preview\n* Second commit: the commit representing the state to which we want to\n compare the first commit\n* **Note**: This is the opposite of the order used in `git diff`.\n\n#### Sample output\n```\ncurl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diffstat/d222fa2..e174964\n{\n \"pagelen\": 500,\n \"values\": [\n {\n \"type\": \"diffstat\",\n \"status\": \"modified\",\n \"lines_removed\": 1,\n \"lines_added\": 2,\n \"old\": {\n \"path\": \"setup.py\",\n \"escaped_path\": \"setup.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/e1749643d655d7c7014001a6c0f58abaf42ad850/setup.py\"\n }\n }\n },\n \"new\": {\n \"path\": \"setup.py\",\n \"escaped_path\": \"setup.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/d222fa235229c55dad20b190b0b571adf737d5a6/setup.py\"\n }\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_diffstats"}}},"description":"The diff stats"},"555":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If generating the diffstat timed out."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Compare two commit diff stats","tags":["Commits"]},"parameters":[{"description":"Generate diffs that ignore whitespace","in":"query","name":"ignore_whitespace","required":false,"schema":{"type":"boolean"}},{"description":"This parameter is deprecated and will be removed at the end\nof 2022. The 'topic' parameter should be used instead. The\n'merge' and 'topic' parameters cannot be both used at the same\ntime.\n\nIf true, the source commit is merged into the\ndestination commit, and then a diffstat from the\ndestination to the merge result is returned. If false,\na simple 'two dot' diffstat between the source and\ndestination is returned. True if omitted.","in":"query","name":"merge","required":false,"schema":{"type":"boolean"}},{"description":"Limit the diffstat to a particular file (this parameter\ncan be repeated for multiple paths).","in":"query","name":"path","required":false,"schema":{"type":"string"}},{"description":"Whether to perform rename detection, true if omitted.","in":"query","name":"renames","required":false,"schema":{"type":"boolean"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"A commit SHA (e.g. `3a8b42`) or a commit range using double dot\nnotation (e.g. `3a8b42..9ff173`).\n","in":"path","name":"spec","required":true,"schema":{"type":"string"}},{"description":"If true, returns 2-way 'three-dot' diff.\nThis is a diff between the source commit and the merge base\nof the source commit and the destination commit.\nIf false, a simple 'two dot' diff between the source and\ndestination is returned.","in":"query","name":"topic","required":false,"schema":{"type":"boolean"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/downloads":{"get":{"description":"Returns a list of download links associated with the repository.","responses":{"200":{"description":"Returns a paginated list of the downloads associated with the repository."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"User is not authorized to read from the repository."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List download artifacts","tags":["Downloads"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Upload new download artifacts.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\n\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced.","responses":{"201":{"description":"The artifact was uploaded sucessfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Bad Request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"User is not authorized to write to the repository."},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unsupported Content-Type. Use multiplart/form-data."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Upload a download artifact","tags":["Downloads"]}},"/repositories/{workspace}/{repo_slug}/downloads/{filename}":{"delete":{"description":"Deletes the specified download artifact from the repository.","responses":{"204":{"description":"The specified download artifact was deleted."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"User is not authorized to write to the repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified download does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a download artifact","tags":["Downloads"]},"get":{"description":"Return a redirect to the contents of a download artifact.\n\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World","responses":{"302":{"description":"Redirects to the url of the specified download artifact."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"User is not authorized to read from the repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified download artifact does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a download artifact link","tags":["Downloads"]},"parameters":[{"description":"Name of the file.","in":"path","name":"filename","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/effective-branching-model":{"get":{"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/effective_repo_branching_model"}}},"description":"The effective branching model object"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have read access to the repository"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist"}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get the effective, or currently applied, branching model for a repository","tags":["Branching model"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/effective-default-reviewers":{"get":{"description":"Returns the repository's effective default reviewers. This includes both default\nreviewers defined at the repository level as well as those inherited from its project.\n\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/{workspace_slug}/{repo_slug}/effective-default-reviewers?page=1&pagelen=20\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"user\": {\n \"display_name\": \"Patrick Wolf\",\n \"uuid\": \"{9565301a-a3cf-4b5d-88f4-dd6af8078d7e}\"\n },\n \"reviewer_type\": \"project\",\n \"type\": \"default_reviewer\",\n },\n {\n \"user\": {\n \"display_name\": \"Davis Lee\",\n \"uuid\": \"{f0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6}\"\n },\n \"reviewer_type\": \"repository\",\n \"type\": \"default_reviewer\",\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_default_reviewer_and_type"}}},"description":"The paginated list of effective default reviewers"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to view the default reviewers"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List effective default reviewers","tags":["Pullrequests"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/environments":{"get":{"description":"Find environments","operationId":"getEnvironmentsForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_environments"}}},"description":"The matching environments."}},"summary":"List environments","tags":["Deployments"]},"post":{"description":"Create an environment.","operationId":"createEnvironment","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_environment"}}},"description":"The environment to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_environment"}}},"description":"The environment was created.","headers":{"Location":{"description":"The URL of the newly created environment.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"An environment host with the provided name already exists."}},"summary":"Create an environment","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}":{"delete":{"description":"Delete an environment","operationId":"deleteEnvironmentForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment UUID.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The environment was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account or repository with the UUID provided exists."}},"summary":"Delete an environment","tags":["Deployments"]},"get":{"description":"Retrieve an environment","operationId":"getEnvironmentForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment UUID.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment_environment"}}},"description":"The environment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository or environment with the UUID provided exists."}},"summary":"Get an environment","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes":{"post":{"description":"Update an environment","operationId":"updateEnvironmentForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The environment UUID.","in":"path","name":"environment_uuid","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"The environment update request was accepted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository or environment with the UUID provided exists."}},"summary":"Update an environment","tags":["Deployments"]}},"/repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}":{"get":{"description":"Returns a paginated list of commits that modified the specified file.\n\nCommits are returned in reverse chronological order. This is roughly\nequivalent to the following commands:\n\n $ git log --follow --date-order \n\nBy default, Bitbucket will follow renames and the path name in the\nreturned entries reflects that. This can be turned off using the\n`?renames=false` query parameter.\n\nResults are returned in descending chronological order by default, and\nlike most endpoints you can\n[filter and sort](/cloud/bitbucket/rest/intro/#filtering) the response to\nonly provide exactly the data you want.\n\nFor example, if you wanted to find commits made before 2011-05-18\nagainst a file named `README.rst`, but you only wanted the path and\ndate, your query would look like this:\n\n```\n$ curl 'https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/filehistory/master/README.rst'\\\n '?fields=values.next,values.path,values.commit.date&q=commit.date<=2011-05-18'\n{\n \"values\": [\n {\n \"commit\": {\n \"date\": \"2011-05-17T07:32:09+00:00\"\n },\n \"path\": \"README.rst\"\n },\n {\n \"commit\": {\n \"date\": \"2011-05-16T06:33:28+00:00\"\n },\n \"path\": \"README.txt\"\n },\n {\n \"commit\": {\n \"date\": \"2011-05-16T06:15:39+00:00\"\n },\n \"path\": \"README.txt\"\n }\n ]\n}\n```\n\nIn the response you can see that the file was renamed to `README.rst`\nby the commit made on 2011-05-16, and was previously named `README.txt`.","parameters":[{"description":"\nWhen `true`, Bitbucket will follow the history of the file across\nrenames (this is the default behavior). This can be turned off by\nspecifying `false`.","in":"query","name":"renames","required":false,"schema":{"type":"string"}},{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_files"}}},"description":"A paginated list of commits that modified the specified file"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List commits that modified a file","tags":["Source","Repositories"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Path to the file.","in":"path","name":"path","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/forks":{"get":{"description":"Returns a paginated list of all the forks of the specified\nrepository.","parameters":[{"description":"Filters the result based on the authenticated user's role on each repository.\n\n* **member**: returns repositories to which the user has explicit read access\n* **contributor**: returns repositories to which the user has explicit write access\n* **admin**: returns repositories to which the user has explicit administrator access\n* **owner**: returns all repositories owned by the current user\n","in":"query","name":"role","required":false,"schema":{"enum":["admin","contributor","member","owner"],"type":"string"}},{"description":"Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repositories"}}},"description":"All forks."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List repository forks","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new fork of the specified repository.\n\n#### Forking a repository\n\nTo create a fork, specify the workspace explicitly as part of the\nrequest body:\n\n```\n$ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/atlassian/bbql/forks \\\n -H 'Content-Type: application/json' -d '{\n \"name\": \"bbql_fork\",\n \"workspace\": {\n \"slug\": \"atlassian\"\n }\n}'\n```\n\nTo fork a repository into the same workspace, also specify a new `name`.\n\nWhen you specify a value for `name`, it will also affect the `slug`.\nThe `slug` is reflected in the repository URL of the new fork. It is\nderived from `name` by substituting non-ASCII characters, removes\nwhitespace, and changes characters to lower case. For example,\n`My repo` would turn into `my_repo`.\n\nYou need contributor access to create new forks within a workspace.\n\n\n#### Change the properties of a new fork\n\nBy default the fork inherits most of its properties from the parent.\nHowever, since the optional POST body document follows the normal\n`repository` JSON schema and you can override the new fork's\nproperties.\n\nProperties that can be overridden include:\n\n* description\n* fork_policy\n* language\n* mainbranch\n* is_private (note that a private repo's fork_policy might prohibit\n the creation of public forks, in which `is_private=False` would fail)\n* has_issues (to initialize or disable the new repo's issue tracker --\n note that the actual contents of the parent repository's issue\n tracker are not copied during forking)\n* has_wiki (to initialize or disable the new repo's wiki --\n note that the actual contents of the parent repository's wiki are not\n copied during forking)\n* project (when forking into a private project, the fork's `is_private`\n must be `true`)\n\nProperties that cannot be modified include:\n\n* scm\n* parent\n* full_name","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"A repository object. This can be left blank."},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository"}}},"description":"The newly created fork.","headers":{"Location":{"description":"The URL of the newly created fork","schema":{"type":"string"}}}}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Fork a repository","tags":["Repositories"]}},"/repositories/{workspace}/{repo_slug}/hooks":{"get":{"description":"Returns a paginated list of webhooks installed on this repository.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_webhook_subscriptions"}}},"description":"The paginated list of installed webhooks."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to access the webhooks."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"List webhooks for a repository","tags":["Repositories","Webhooks"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new webhook on the specified repository.\n\nExample:\n\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json'\n https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo-slug/hooks\n -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\n\nNote that this call requires the webhook scope, as well as any scope\nthat applies to the events that the webhook subscribes to. In the\nexample above that means: `webhook`, `repository` and `issue`.\n\nAlso note that the `url` must properly resolve and cannot be an\ninternal, non-routed address.","responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_subscription"}}},"description":"If the webhook was registered successfully.","headers":{"Location":{"description":"The URL of new newly created webhook.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to install webhooks on the specified repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Create a webhook for a repository","tags":["Repositories","Webhooks"]}},"/repositories/{workspace}/{repo_slug}/hooks/{uid}":{"delete":{"description":"Deletes the specified webhook subscription from the given\nrepository.","responses":{"204":{"description":"When the webhook was deleted successfully"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to delete the webhook."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the webhook or repository does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a webhook for a repository","tags":["Repositories","Webhooks"]},"get":{"description":"Returns the webhook with the specified id installed on the specified\nrepository.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_subscription"}}},"description":"The webhook subscription object."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the webhook or repository does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Get a webhook for a repository","tags":["Repositories","Webhooks"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"Installed webhook's ID","in":"path","name":"uid","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_subscription"}}},"description":"The webhook subscription object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to update the webhook."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the webhook or repository does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Update a webhook for a repository","tags":["Repositories","Webhooks"]}},"/repositories/{workspace}/{repo_slug}/issues":{"get":{"description":"Returns the issues in the issue tracker.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_issues"}}},"description":"A paginated list of the issues matching any filter criteria that were provided."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List issues","tags":["Issue tracker"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new issue.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorization.\n\nThe authenticated user is used for the issue's `reporter` field.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}},"description":"The new issue. The only required element is `title`. All other elements can be omitted from the body.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}},"description":"The newly created issue.","headers":{"Location":{"description":"The (absolute) URL of the newly created issue.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user isn't authorized to create the issue."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/export":{"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"A POST request to this endpoint initiates a new background celery task that archives the repo's issues.\n\nFor example, you can run:\n\ncurl -u -X POST http://api.bitbucket.org/2.0/repositories///\nissues/export\n\nWhen the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the\n'Location' response header. This url is the endpoint for where the user can obtain their zip files.\"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/export_options"}}},"description":"The options to apply to the export. Available options include `project_key` and `project_name` which, if specified, are used as the project key and name in the exported Jira json format. Option `send_email` specifies whether an email should be sent upon export result. Option `include_attachments` specifies whether attachments are included in the export."},"responses":{"202":{"description":"The export job has been accepted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated properly"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user does not have admin permission on the repo"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The repo does not exist or does not have an issue tracker"}},"security":[{"oauth2":["issue","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Export issues","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip":{"get":{"description":"This endpoint is used to poll for the progress of an issue export\njob and return the zip file after the job is complete.\nAs long as the job is running, this will return a 200 response\nwith in the response body a description of the current status.\n\nAfter the job has been scheduled, but before it starts executing, this\nendpoint's response is:\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"ACCEPTED\",\n \"phase\": \"Initializing\",\n \"total\": 0,\n \"count\": 0,\n \"pct\": 0\n}\n\n\nThen once it starts running, it becomes:\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"STARTED\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 11,\n \"pct\": 73\n}\n\nOnce the job has successfully completed, it returns a stream of the zip file.","responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_job_status"}}},"description":"Export job accepted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated properly"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user does not have admin permission on the repo"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No export job has begun"}},"security":[{"oauth2":["issue","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Check issue export status","tags":["Issue tracker"]},"parameters":[{"description":"The name of the repo","in":"path","name":"repo_name","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The ID of the export task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/issues/import":{"get":{"description":"When using GET, this endpoint reports the status of the current import task. Request example:\n\n```\n$ curl -u -X GET https://api.bitbucket.org/2.0/repositories///issues/import\n```\n\nAfter the job has been scheduled, but before it starts executing, this endpoint's response is:\n\n```\n< HTTP/1.1 202 Accepted\n{\n \"type\": \"issue_job_status\",\n \"status\": \"PENDING\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 0,\n \"percent\": 0\n}\n```\n\nOnce it starts running, it is a 202 response with status STARTED and progress filled.\n\nAfter it is finished, it becomes a 200 response with status SUCCESS or FAILURE.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_job_status"}}},"description":"Import job complete with either FAILURE or SUCCESS status"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_job_status"}}},"description":"Import job started"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated properly"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user does not have admin permission on the repo"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No export job has begun"}},"security":[{"oauth2":["issue:write","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Check issue import status","tags":["Issue tracker"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"A POST request to this endpoint will import the zip file given by the archive parameter into the repository. All\nexisting issues will be deleted and replaced by the contents of the imported zip file.\n\nImports are done through a multipart/form-data POST. There is one valid and required form field, with the name\n\"archive,\" which needs to be a file field:\n\n```\n$ curl -u -X POST -F archive=@/path/to/file.zip https://api.bitbucket.org/2.0/repositories///issues/import\n```\n\nWhen the import job is accepted, here is example output:\n\n```\n< HTTP/1.1 202 Accepted\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"ACCEPTED\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 0,\n \"percent\": 0\n}\n```","responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_job_status"}}},"description":"Import job accepted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated properly"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user does not have admin permission on the repo"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No export job has begun"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Import already running"}},"security":[{"oauth2":["issue:write","repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Import issues","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}":{"delete":{"description":"Deletes the specified issue. This requires write access to the\nrepository.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}},"description":"The issue object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user isn't authorized to delete the issue."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete an issue","tags":["Issue tracker"]},"get":{"description":"Returns the specified issue.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}},"description":"The issue object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user isn't authorized to access the issue."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified issue is unavailable."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get an issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Modifies the issue.\n\n```\n$ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \\\n -u evzijst -s -X PUT -H 'Content-Type: application/json' \\\n -d '{\n \"title\": \"Updated title\",\n \"assignee\": {\n \"account_id\": \"5d5355e8c6b9320d9ea5b28d\"\n },\n \"priority\": \"minor\",\n \"version\": {\n \"name\": \"1.0\"\n },\n \"component\": null\n}'\n```\n\nThis example changes the `title`, `assignee`, `priority` and the\n`version`. It also removes the value of the `component` from the issue\nby setting the field to `null`. Any field not present keeps its existing\nvalue.\n\nEach time an issue is edited in the UI or through the API, an immutable\nchange record is created under the `/issues/123/changes` endpoint. It\nalso has a comment associated with the change.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue"}}},"description":"The updated issue object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user isn't authorized to access the issue."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Update an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments":{"get":{"description":"Returns all attachments for this issue.\n\nThis returns the files' meta data. This does not return the files'\nactual contents.\n\nThe files are always ordered by their upload date.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_issue_attachments"}}},"description":"A paginated list of all attachments for this issue."},"401":{"description":"If the issue tracker is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List attachments for an issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Upload new issue attachments.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\n\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced.","responses":{"201":{"description":"An empty response document.","headers":{"Location":{"description":"The URL to the issue's collection of attachments.","schema":{"type":"string"}}}},"400":{"description":"If no files were uploaded, or if the wrong `Content-Type` was used."},"401":{"description":"If the issue tracker is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Upload an attachment to an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}":{"delete":{"description":"Deletes an attachment.","responses":{"204":{"description":"Indicates that the deletion was successful"},"401":{"description":"If the issue tracker is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete an attachment for an issue","tags":["Issue tracker"]},"get":{"description":"Returns the contents of the specified file attachment.\n\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\n\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared.","responses":{"302":{"description":"A redirect to the file's contents","headers":{"Location":{"schema":{"type":"string"}}}},"401":{"description":"If the issue tracker is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get attachment for an issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"Path to the file.","in":"path","name":"path","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes":{"get":{"description":"Returns the list of all changes that have been made to the specified\nissue. Changes are returned in chronological order with the oldest\nchange first.\n\nEach time an issue is edited in the UI or through the API, an immutable\nchange record is created under the `/issues/123/changes` endpoint. It\nalso has a comment associated with the change.\n\nNote that this operation is changing significantly, due to privacy changes.\nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-the-issue-changes-api)\nfor details.\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes - | jq .\n\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"changes\": {\n \"priority\": {\n \"new\": \"trivial\",\n \"old\": \"major\"\n },\n \"assignee\": {\n \"new\": \"\",\n \"old\": \"evzijst\"\n },\n \"assignee_account_id\": {\n \"new\": \"\",\n \"old\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\"\n },\n \"kind\": {\n \"new\": \"enhancement\",\n \"old\": \"bug\"\n }\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes/2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow/issues/1#comment-2\"\n }\n },\n \"issue\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1\"\n }\n },\n \"type\": \"issue\",\n \"id\": 1,\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow/avatar/32/\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"dogslow\",\n \"full_name\": \"evzijst/dogslow\",\n \"uuid\": \"{988b17c6-1a47-4e70-84ee-854d5f012bf6}\"\n },\n \"title\": \"Updated title\"\n },\n \"created_on\": \"2018-03-03T00:35:28.353630+00:00\",\n \"user\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"evzijst\",\n \"type\": \"user\",\n \"uuid\": \"{aaa7972b-38af-4fb1-802d-6e3854c95778}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/evzijst/avatar/32/\"\n }\n }\n },\n \"message\": {\n \"raw\": \"Removed assignee, changed kind and priority.\",\n \"markup\": \"markdown\",\n \"html\": \"

Removed assignee, changed kind and priority.

\",\n \"type\": \"rendered\"\n },\n \"type\": \"issue_change\",\n \"id\": 2\n }\n ],\n \"page\": 1\n}\n```\n\nChanges support [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) that\ncan be used to search for specific changes. For instance, to see\nwhen an issue transitioned to \"resolved\":\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \\\n -G --data-urlencode='q=changes.state.new = \"resolved\"'\n```\n\nThis resource is only available on repositories that have the issue\ntracker enabled.\n\nN.B.\n\nThe `changes.assignee` and `changes.assignee_account_id` fields are not\na `user` object. Instead, they contain the raw `username` and\n`account_id` of the user. This is to protect the integrity of the audit\nlog even after a user account gets deleted.\n\nThe `changes.assignee` field is deprecated will disappear in the\nfuture. Use `changes.assignee_account_id` instead.","parameters":[{"description":"\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_log_entries"}}},"description":"Returns all the issue changes that were made on the specified issue."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List changes on an issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Makes a change to the specified issue.\n\nFor example, to change an issue's state and assignee, create a new\nchange object that modifies these fields:\n\n```\ncurl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \\\n -s -u evzijst -X POST -H \"Content-Type: application/json\" \\\n -d '{\n \"changes\": {\n \"assignee_account_id\": {\n \"new\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\"\n },\n \"state\": {\n \"new\": 'resolved\"\n }\n }\n \"message\": {\n \"raw\": \"This is now resolved.\"\n }\n }'\n```\n\nThe above example also includes a custom comment to go alongside the\nchange. This comment will also be visible on the issue page in the UI.\n\nThe fields of the `changes` object are strings, not objects. This\nallows for immutable change log records, even after user accounts,\nmilestones, or other objects recorded in a change entry, get renamed or\ndeleted.\n\nThe `assignee_account_id` field stores the account id. When POSTing a\nnew change and changing the assignee, the client should therefore use\nthe user's account_id in the `changes.assignee_account_id.new` field.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorization.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_change"}}},"description":"The new issue state change. The only required elements are `changes.[].new`. All other elements can be omitted from the body.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_change"}}},"description":"The newly created issue change.","headers":{"Location":{"description":"The (absolute) URL of the newly created issue change.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the authenticated user isn't authorized to modify the issue."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Modify the state of an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}":{"get":{"description":"Returns the specified issue change object.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_change"}}},"description":"The specified issue change object."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue change does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get issue change object","tags":["Issue tracker"]},"parameters":[{"description":"The issue change id","in":"path","name":"change_id","required":true,"schema":{"type":"string"}},{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments":{"get":{"description":"Returns a paginated list of all comments that were made on the\nspecified issue.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_issue_comments"}}},"description":"A paginated list of issue comments."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List comments on an issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new issue comment.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \\\n -X POST -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}}'\n```","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_comment"}}},"description":"The new issue comment object.","required":true},"responses":{"201":{"description":"The newly created comment.","headers":{"Location":{"description":"The location of the newly issue comment.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the input was invalid, or if the comment being created is detected as spam "}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a comment on an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}":{"delete":{"description":"Deletes the specified comment.","responses":{"204":{"description":"Indicates successful deletion."}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a comment on an issue","tags":["Issue tracker"]},"get":{"description":"Returns the specified issue comment object.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_comment"}}},"description":"The issue comment."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get a comment on an issue","tags":["Issue tracker"]},"parameters":[{"description":"The id of the comment.","in":"path","name":"comment_id","required":true,"schema":{"type":"integer"}},{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the content of the specified issue comment. Note that only\nthe `content.raw` field can be modified.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \\\n -X PUT -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}'\n```","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_comment"}}},"description":"The updated comment.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/issue_comment"}}},"description":"The updated issue comment."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the input was invalid, or if the update to the comment is detected as spam "}},"security":[{"oauth2":["issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Update a comment on an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote":{"delete":{"description":"Retract your vote.","responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unexpected error."}},"security":[{"oauth2":["account:write","issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Remove vote for an issue","tags":["Issue tracker"]},"get":{"description":"Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't.","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user has not voted for this issue."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user has not voted for this issue, or when the repo does not exist, or does not have an issue tracker."}},"security":[{"oauth2":["account","issue"]},{"basic":[]},{"api_key":[]}],"summary":"Check if current user voted for an issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Vote for this issue.\n\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful.","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Indicating the authenticated user has cast their vote successfully."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["account:write","issue"]},{"basic":[]},{"api_key":[]}],"summary":"Vote for an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch":{"delete":{"description":"Stop watching this issue.","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Indicates that the authenticated user successfully stopped watching this issue."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or issue does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["account:write","issue:write"]},{"basic":[]},{"api_key":[]}],"summary":"Stop watching an issue","tags":["Issue tracker"]},"get":{"description":"Indicated whether or not the authenticated user is watching this\nissue.","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user is watching this issue."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker."}},"security":[{"oauth2":["account","issue"]},{"basic":[]},{"api_key":[]}],"summary":"Check if current user is watching a issue","tags":["Issue tracker"]},"parameters":[{"description":"The issue id","in":"path","name":"issue_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Start watching this issue.\n\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful.","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Indicates that the authenticated user successfully started watching this issue."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker."}},"security":[{"oauth2":["account:write","issue"]},{"basic":[]},{"api_key":[]}],"summary":"Watch an issue","tags":["Issue tracker"]}},"/repositories/{workspace}/{repo_slug}/merge-base/{revspec}":{"get":{"description":"Returns the best common ancestor between two commits, specified in a revspec\nof 2 commits (e.g. 3a8b42..9ff173).\n\nIf more than one best common ancestor exists, only one will be returned. It is\nunspecified which will be returned.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/commit"}}},"description":"The merge base of the provided spec."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to any of the repositories specified."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or ref in the spec does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get the common ancestor between two commits","tags":["Commits"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"A commit range using double dot notation (e.g. `3a8b42..9ff173`).\n","in":"path","name":"revspec","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/milestones":{"get":{"description":"Returns the milestones that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_milestones"}}},"description":"The milestones that have been defined in the issue tracker."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List milestones","tags":["Issue tracker"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/milestones/{milestone_id}":{"get":{"description":"Returns the specified issue tracker milestone object.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestone"}}},"description":"The specified milestone object."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or milestone does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get a milestone","tags":["Issue tracker"]},"parameters":[{"description":"The milestone's id","in":"path","name":"milestone_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/override-settings":{"get":{"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository_inheritance_state"}}},"description":"The repository setting inheritance state"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If no repository exists at this location"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Retrieve the inheritance state for repository settings","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"","responses":{"204":{"description":"The repository setting inheritance state was set and no content returned"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If no repository exists at this location"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Set the inheritance state for repository settings\n ","tags":["Repositories"]}},"/repositories/{workspace}/{repo_slug}/patch/{spec}":{"get":{"description":"Produces a raw patch for a single commit (diffed against its first\nparent), or a patch-series for a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\n\nIn case of the latter (diffing a revspec), a patch series is returned\nfor the commits on the source branch (`3a8b42` and its ancestors in\nour example).\n\nWhile similar to diffs, patches:\n\n* Have a commit header (username, commit message, etc)\n* Do not support the `path=foo/bar.py` query parameter\n\nThe raw patch is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`.","responses":{"200":{"description":"The raw patches"},"555":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the diff was too large and timed out.\n\nSince this endpoint does not employ any form of pagination, but\ninstead returns the diff as a single document, it can run into\ntrouble on very large diffs. If Bitbucket times out in cases\nlike these, a 555 status code is returned."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a patch for two commits","tags":["Commits"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"A commit SHA (e.g. `3a8b42`) or a commit range using double dot\nnotation (e.g. `3a8b42..9ff173`).\n","in":"path","name":"spec","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/permissions-config/groups":{"get":{"description":"Returns a paginated list of explicit group permissions for the given repository.\nThis endpoint does not support BBQL features.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups\n\nHTTP/1.1 200\nLocation: https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Administrators\",\n \"slug\": \"administrators\"\n },\n \"permission\": \"admin\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/\n geordi/permissions-config/groups/administrators\"\n }\n }\n },\n {\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Developers\",\n \"slug\": \"developers\"\n },\n \"permission\": \"read\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/\n geordi/permissions-config/groups/developers\"\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repository_group_permissions"}}},"description":"Paginated of explicit group permissions on the repository."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"One or both of the workspace and repository doesn't exist for the given identifiers."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"List explicit group permissions for a repository","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}":{"delete":{"description":"Deletes the repository group permission between the requested repository and group, if one exists.\n\nOnly users with admin permission for the repository may access this resource.\n\nExample:\n\n$ curl -X DELETE https://api.bitbucket.org/2.0/repositories/atlassian_tutorial\n/geordi/permissions-config/groups/developers\n\n\nHTTP/1.1 204","responses":{"204":{"description":"Group permission deleted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository, or the authentication method was not via app password."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace does not exist, the repository does not exist, or the group does not exist."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Delete an explicit group permission for a repository","tags":["Repositories"]},"get":{"description":"Returns the group permission for a given group slug and repository\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n* `none`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n\nHTTP/1.1 200\nLocation:\nhttps://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n\n{\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Developers\",\n \"slug\": \"developers\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"read\",\n \"links\": {\n \"self\": {\n \"href\":\n \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository_group_permission"}}},"description":"Group permission for group slug and repository"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The given user, workspace, and/or repository could not be found"}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get an explicit group permission for a repository","tags":["Repositories"]},"parameters":[{"description":"Slug of the requested group.","in":"path","name":"group_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the group permission if it exists.\n\nOnly users with admin permission for the repository may access this resource.\n\nThe only authentication method supported for this endpoint is via app passwords.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n```\n$ curl -X PUT -H \"Content-Type: application/json\"\nhttps://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n-d\n'{\n \"permission\": \"write\"\n}'\n\nHTTP/1.1 200\nLocation:\nhttps://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n\n{\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Developers\",\n \"slug\": \"developers\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\",\n \"links\": {\n \"self\": {\n \"href\":\n \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository_group_permission"}}},"description":"Group permission updated"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No permission value was provided or the value is invalid(not one of read, write, or admin)"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"You have reached your plan's user limit and must upgrade before giving access to additional users."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository, or the authentication method was not via app password."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace does not exist, the repository does not exist, or the group does not exist."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update an explicit group permission for a repository","tags":["Repositories"]}},"/repositories/{workspace}/{repo_slug}/permissions-config/users":{"get":{"description":"Returns a paginated list of explicit user permissions for the given repository.\nThis endpoint does not support BBQL features.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/users\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Colin Cameron\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n },\n \"permission\": \"admin\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n }\n }\n },\n {\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324c\"\n },\n \"permission\": \"write\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0//repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324c\"\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repository_user_permissions"}}},"description":"Paginated of explicit user permissions on the repository."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No repository exists for the given repository slug and workspace."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"List explicit user permissions for a repository","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}":{"delete":{"description":"Deletes the repository user permission between the requested repository and user, if one exists.\n\nOnly users with admin permission for the repository may access this resource.\n\nThe only authentication method for this endpoint is via app passwords.\n\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\npermissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\n\n\nHTTP/1.1 204\n```","responses":{"204":{"description":"The repository user permission was deleted and no content returned."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository, or the authentication method was not via app password."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"One or more of the workspace, repository, and user doesn't exist for the given identifiers."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Delete an explicit user permission for a repository","tags":["Repositories"]},"get":{"description":"Returns the explicit user permission for a given user and repository.\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n* `none`\n\nExample:\n\n```\n$ curl 'https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n\nHTTP/1.1 200\nLocation: 'https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n\n{\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Colin Cameron\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository_user_permission"}}},"description":"Explicit user permission for user and repository"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"One or both of the workspace and repository doesn't exist for the given identifiers."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get an explicit user permission for a repository","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account ID.\n","in":"path","name":"selected_user_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the explicit user permission for a given user and repository. The selected user must be a member of\nthe workspace, and cannot be the workspace owner.\nOnly users with admin permission for the repository may access this resource.\n\nThe only authentication method for this endpoint is via app passwords.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl -X PUT -H \"Content-Type: application/json\" 'https://api.bitbucket.org/2.0/repositories/\natlassian_tutorial/geordi/permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n-d '{\n \"permission\": \"write\"\n}'\n\nHTTP/1.1 200\nLocation: 'https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\npermissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n\n\n{\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Colin Cameron\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/repository_user_permission"}}},"description":"Explicit user permission updated"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No permission value was provided or the value is invalid (not one of read, write, or admin), or the selected user is not a valid user to update."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The user couldn't be authenticated."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"You have reached your plan's user limit and must upgrade before giving access to additional users."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository, or the authentication method was not via app password."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"One or more of the workspace, repository, and selected user doesn't exist for the given identifiers."}},"security":[{"oauth2":["repository:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update an explicit user permission for a repository","tags":["Repositories"]}},"/repositories/{workspace}/{repo_slug}/pipelines":{"get":{"description":"Find pipelines","operationId":"getPipelinesForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipelines"}}},"description":"The matching pipelines."}},"summary":"List pipelines","tags":["Pipelines"]},"post":{"description":"Endpoint to create and initiate a pipeline.\nThere are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.\n# Trigger a Pipeline for a branch\nOne way to trigger pipelines is by specifying the branch for which you want to trigger a pipeline.\nThe specified branch will be used to determine which pipeline definition from the `bitbucket-pipelines.yml` file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified branch.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"ref_type\": \"branch\",\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a Pipeline for a commit on a branch or tag\nYou can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark).\nThe specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference.\n\nThe following reference types are supported:\n\n* `branch`\n* `named_branch`\n* `bookmark`\n * `tag`\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ce5b7431602f7cbba007062eeb55225c6e18e956\"\n },\n \"ref_type\": \"branch\",\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit.\nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\":\"custom\",\n \"pattern\":\"Deploy to production\"\n },\n \"type\":\"pipeline_commit_target\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit on a branch or tag\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit in the context of a specified reference.\nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n },\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\",\n \"ref_type\": \"branch\"\n }\n }'\n```\n\n\n# Trigger a custom pipeline with variables\nIn addition to triggering a custom pipeline that is defined in your `bitbucket-pipelines.yml` file as shown in the examples above, you can specify variables that will be available for your build. In the request, provide a list of variables, specifying the following for each variable: key, value, and whether it should be secured or not (this field is optional and defaults to not secured).\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\\n -d '\n {\n \"target\": {\n \"type\": \"pipeline_ref_target\",\n \"ref_type\": \"branch\",\n \"ref_name\": \"master\",\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n }\n },\n \"variables\": [\n {\n \"key\": \"var1key\",\n \"value\": \"var1value\",\n \"secured\": true\n },\n {\n \"key\": \"var2key\",\n \"value\": \"var2value\"\n }\n ]\n }'\n```\n\n# Trigger a pull request pipeline\n\nYou can also initiate a pipeline for a specific pull request.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\\n -d '\n {\n\t\"target\": {\n \"type\": \"pipeline_pullrequest_target\",\n\t \"source\": \"pull-request-branch\",\n \"destination\": \"master\",\n \"destination_commit\": {\n \t \"hash\" : \"9f848b7\"\n },\n \"commit\": {\n \t\"hash\" : \"1a372fc\"\n },\n \"pullrequest\" : {\n \t\"id\" : \"3\"\n },\n\t \"selector\": {\n \"type\": \"pull-requests\",\n \"pattern\": \"**\"\n }\n }\n }'\n```\n","operationId":"createPipelineForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline"}}},"description":"The pipeline to initiate.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline"}}},"description":"The initiated pipeline.","headers":{"Location":{"description":"The URL of the newly created pipeline.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository is not enabled, the yml file does not exist in the repository for the given revision, or the request body contained invalid properties."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository was not found."}},"summary":"Run a pipeline","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines-config/caches":{"delete":{"description":"Delete repository cache versions by name.","operationId":"deleteRepositoryPipelineCaches","parameters":[{"description":"The account.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The cache name.","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The caches were deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace, repository or cache name was not found."}},"summary":"Delete caches","tags":["Pipelines"]},"get":{"description":"Retrieve the repository pipelines caches.","operationId":"getRepositoryPipelineCaches","parameters":[{"description":"The account.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_caches"}}},"description":"The list of caches for the given repository."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository was not found."}},"summary":"List caches","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}":{"delete":{"description":"Delete a repository cache.","operationId":"deleteRepositoryPipelineCache","parameters":[{"description":"The account.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the cache to delete.","in":"path","name":"cache_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The cache was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace, repository or cache_uuid with given UUID was not found."}},"summary":"Delete a cache","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri":{"get":{"description":"Retrieve the URI of the content of the specified cache.","operationId":"getRepositoryPipelineCacheContentURI","parameters":[{"description":"The account.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the cache.","in":"path","name":"cache_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_cache_content_uri"}}},"description":"The cache content uri."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace, repository or cache_uuid with given UUID was not found."}},"summary":"Get cache content URI","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}":{"get":{"description":"Retrieve a specified pipeline","operationId":"getPipelineForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The pipeline UUID.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline"}}},"description":"The pipeline."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository or pipeline with the UUID provided exists."}},"summary":"Get a pipeline","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps":{"get":{"description":"Find steps for the given pipeline.","operationId":"getPipelineStepsForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_steps"}}},"description":"The steps."}},"summary":"List steps for a pipeline","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}":{"get":{"description":"Retrieve a given step of a pipeline.","operationId":"getPipelineStepForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the step.","in":"path","name":"step_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_step"}}},"description":"The step."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository, pipeline or step with the UUID provided exists for the pipeline with the UUID provided."}},"summary":"Get a step of a pipeline","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log":{"get":{"description":"Retrieve the log file for a given step of a pipeline.\n\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.","operationId":"getPipelineStepLogForRepository","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the step.","in":"path","name":"step_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The raw log file for this pipeline step."},"304":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The log has the same etag as the provided If-None-Match header."},"404":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A pipeline with the given UUID does not exist, a step with the given UUID does not exist in the pipeline or a log file does not exist for the given step."},"416":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requested range does not exist for requests that specified the [HTTP Range header](https://tools.ietf.org/html/rfc7233#section-3.1)."}},"summary":"Get log file for a step","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}":{"get":{"description":"Retrieve the log file for a build container or service container.\n\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.","operationId":"getPipelineContainerLog","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the step.","in":"path","name":"step_uuid","required":true,"schema":{"type":"string"}},{"description":"For the main build container specify the step UUID; for a service container specify the service container UUID","in":"path","name":"log_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The raw log file for the build container or service container."},"404":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository, pipeline, step or log exist for the provided path."}},"summary":"Get the logs for the build container or a service container for a given step of a pipeline.","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports":{"get":{"operationId":"getPipelineTestReports","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the step.","in":"path","name":"step_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A summary of test reports for this pipeline step."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository, pipeline, step or test reports exist for the provided path."}},"summary":"Get a summary of test reports for a given step of a pipeline.","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases":{"get":{"operationId":"getPipelineTestReportTestCases","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the step.","in":"path","name":"step_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Test cases for this pipeline step."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository, pipeline, step or test reports exist for the provided path."}},"summary":"Get test cases for a given step of a pipeline.","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons":{"get":{"operationId":"getPipelineTestReportTestCaseReasons","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the step.","in":"path","name":"step_uuid","required":true,"schema":{"type":"string"}},{"description":"The UUID of the test case.","in":"path","name":"test_case_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Test case reasons (output)."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"No account, repository, pipeline, step or test case with the UUID provided exists for the pipeline with the UUID provided."}},"summary":"Get test case reasons (output) for a given test case in a step of a pipeline.","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline":{"post":{"description":"Signal the stop of a pipeline and all of its steps that not have completed yet.","operationId":"stopPipeline","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the pipeline.","in":"path","name":"pipeline_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The pipeline has been signaled to stop."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified pipeline has already completed."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Either the account, repository or pipeline with the given UUID does not exist."}},"summary":"Stop a pipeline","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config":{"get":{"description":"Retrieve the repository pipelines configuration.","operationId":"getRepositoryPipelineConfig","parameters":[{"description":"The account.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipelines_config"}}},"description":"The repository pipelines configuration."}},"summary":"Get configuration","tags":["Pipelines"]},"put":{"description":"Update the pipelines configuration for a repository.","operationId":"updateRepositoryPipelineConfig","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipelines_config"}}},"description":"The updated repository pipelines configuration.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipelines_config"}}},"description":"The repository pipelines configuration was updated."}},"summary":"Update configuration","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/build_number":{"put":{"description":"Update the next build number that should be assigned to a pipeline. The next build number that will be configured has to be strictly higher than the current latest build number for this repository.","operationId":"updateRepositoryBuildNumber","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_build_number"}}},"description":"The build number to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_build_number"}}},"description":"The build number has been configured."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The update failed because the next number was invalid (it should be higher than the current number)."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository was not found."}},"summary":"Update the next build number","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/schedules":{"get":{"description":"Retrieve the configured schedules for the given repository.","operationId":"getRepositoryPipelineSchedules","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_schedules"}}},"description":"The list of schedules."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository was not found."}},"summary":"List schedules","tags":["Pipelines"]},"post":{"description":"Create a schedule for the given repository.","operationId":"createRepositoryPipelineSchedule","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_schedule_post_request_body"}}},"description":"The schedule to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_schedule"}}},"description":"The created schedule."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"There were errors validating the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The maximum limit of schedules for this repository was reached."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository was not found."}},"summary":"Create a schedule","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}":{"delete":{"description":"Delete a schedule.","operationId":"deleteRepositoryPipelineSchedule","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The uuid of the schedule.","in":"path","name":"schedule_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The schedule was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or schedule was not found."}},"summary":"Delete a schedule","tags":["Pipelines"]},"get":{"description":"Retrieve a schedule by its UUID.","operationId":"getRepositoryPipelineSchedule","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The uuid of the schedule.","in":"path","name":"schedule_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_schedule"}}},"description":"The requested schedule."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or schedule was not found."}},"summary":"Get a schedule","tags":["Pipelines"]},"put":{"description":"Update a schedule.","operationId":"updateRepositoryPipelineSchedule","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The uuid of the schedule.","in":"path","name":"schedule_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_schedule_put_request_body"}}},"description":"The schedule to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_schedule"}}},"description":"The schedule is updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or schedule was not found."}},"summary":"Update a schedule","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions":{"get":{"description":"Retrieve the executions of a given schedule.","operationId":"getRepositoryPipelineScheduleExecutions","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The uuid of the schedule.","in":"path","name":"schedule_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_schedule_executions"}}},"description":"The list of executions of a schedule."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository was not found."}},"summary":"List executions of a schedule","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair":{"delete":{"description":"Delete the repository SSH key pair.","operationId":"deleteRepositoryPipelineKeyPair","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The SSH key pair was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or SSH key pair was not found."}},"summary":"Delete SSH key pair","tags":["Pipelines"]},"get":{"description":"Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.","operationId":"getRepositoryPipelineSshKeyPair","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_ssh_key_pair"}}},"description":"The SSH key pair."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or SSH key pair was not found."}},"summary":"Get SSH key pair","tags":["Pipelines"]},"put":{"description":"Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.","operationId":"updateRepositoryPipelineKeyPair","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_ssh_key_pair"}}},"description":"The created or updated SSH key pair.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_ssh_key_pair"}}},"description":"The SSH key pair was created or updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or SSH key pair was not found."}},"summary":"Update SSH key pair","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts":{"get":{"description":"Find repository level known hosts.","operationId":"getRepositoryPipelineKnownHosts","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_known_hosts"}}},"description":"The retrieved known hosts."}},"summary":"List known hosts","tags":["Pipelines"]},"post":{"description":"Create a repository level known host.","operationId":"createRepositoryPipelineKnownHost","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_known_host"}}},"description":"The known host to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_known_host"}}},"description":"The known host was created.","headers":{"Location":{"description":"The URL of the newly created pipeline known host.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A known host with the provided hostname already exists."}},"summary":"Create a known host","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}":{"delete":{"description":"Delete a repository level known host.","operationId":"deleteRepositoryPipelineKnownHost","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the known host to delete.","in":"path","name":"known_host_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The known host was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or known host with given UUID was not found."}},"summary":"Delete a known host","tags":["Pipelines"]},"get":{"description":"Retrieve a repository level known host.","operationId":"getRepositoryPipelineKnownHost","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the known host to retrieve.","in":"path","name":"known_host_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_known_host"}}},"description":"The known host."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or known host with the specified UUID was not found."}},"summary":"Get a known host","tags":["Pipelines"]},"put":{"description":"Update a repository level known host.","operationId":"updateRepositoryPipelineKnownHost","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the known host to update.","in":"path","name":"known_host_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_known_host"}}},"description":"The updated known host.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_known_host"}}},"description":"The known host was updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or known host with the given UUID was not found."}},"summary":"Update a known host","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/variables":{"get":{"description":"Find repository level variables.","operationId":"getRepositoryPipelineVariables","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_variables"}}},"description":"The retrieved variables."}},"summary":"List variables for a repository","tags":["Pipelines"]},"post":{"description":"Create a repository level variable.","operationId":"createRepositoryPipelineVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable was created.","headers":{"Location":{"description":"The URL of the newly created pipeline variable.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or repository does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A variable with the provided key already exists."}},"summary":"Create a variable for a repository","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}":{"delete":{"description":"Delete a repository level variable.","operationId":"deleteRepositoryPipelineVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to delete.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The variable was deleted."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or variable with given UUID was not found."}},"summary":"Delete a variable for a repository","tags":["Pipelines"]},"get":{"description":"Retrieve a repository level variable.","operationId":"getRepositoryPipelineVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to retrieve.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or variable with the specified UUID was not found."}},"summary":"Get a variable for a repository","tags":["Pipelines"]},"put":{"description":"Update a repository level variable.","operationId":"updateRepositoryPipelineVariable","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to update.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The updated variable","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable was updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account, repository or variable with the given UUID was not found."}},"summary":"Update a variable for a repository","tags":["Pipelines"]}},"/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}":{"delete":{"description":"Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.","operationId":"deleteRepositoryHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"An empty response."}},"summary":"Delete a repository application property","tags":["properties"]},"get":{"description":"Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.","operationId":"getRepositoryHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_property"}}},"description":"The value of the property."}},"summary":"Get a repository application property","tags":["properties"]},"put":{"description":"Update an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.","operationId":"updateRepositoryHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/application_property"},"responses":{"204":{"description":"An empty response."}},"summary":"Update a repository application property","tags":["properties"]}},"/repositories/{workspace}/{repo_slug}/pullrequests":{"get":{"description":"Returns all pull requests on the specified repository.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details.","parameters":[{"description":"Only return pull requests that are in this state. This parameter can be repeated.","in":"query","name":"state","schema":{"enum":["OPEN","MERGED","DECLINED","SUPERSEDED"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pullrequests"}}},"description":"All pull requests on the specified repository."},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified repository does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List pull requests","tags":["Pullrequests"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new pull request where the destination repository is\nthis repository and the author is the authenticated user.\n\nThe minimum required fields to create a pull request are `title` and\n`source`, specified by a branch name.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repository/pullrequests \\\n -u my-username:my-password \\\n --request POST \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"staging\"\n }\n }\n }'\n```\n\nIf the pull request's `destination` is not specified, it will default\nto the `repository.mainbranch`. To open a pull request to a\ndifferent branch, say from a feature branch to a staging branch,\nspecify a `destination` (same format as the `source`):\n\n```\n{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"my-feature-branch\"\n }\n },\n \"destination\": {\n \"branch\": {\n \"name\": \"staging\"\n }\n }\n}\n```\n\nReviewers can be specified by adding an array of user objects as the\n`reviewers` property.\n\n```\n{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"my-feature-branch\"\n }\n },\n \"reviewers\": [\n {\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n }\n ]\n}\n```\n\nOther fields:\n\n* `description` - a string\n* `close_source_branch` - boolean that specifies if the source branch should be closed upon merging","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The new pull request.\n\nThe request URL you POST to becomes the destination repository URL. For this reason, you must specify an explicit source repository in the request object if you want to pull from a different repository (fork).\n\nSince not all elements are required or even mutable, you only need to include the elements you want to initialize, such as the source branch and the title."},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The newly created pull request.","headers":{"Location":{"description":"The URL of new newly created pull request.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/activity":{"get":{"description":"Returns a paginated list of the pull request's activity log.\n\nThis handler serves both a v20 and internal endpoint. The v20 endpoint\nreturns reviewer comments, updates, approvals and request changes. The internal\nendpoint includes those plus tasks and attachments.\n\nComments created on a file or a line of code have an inline property.\n\nComment example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"comment\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088\"\n }\n },\n \"deleted\": false,\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"content\": {\n \"raw\": \"inline with to a dn from lines\",\n \"markup\": \"markdown\",\n \"html\": \"

inline with to a dn from lines

\",\n \"type\": \"rendered\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"updated_on\": \"2019-09-27T00:33:46.055384+00:00\",\n \"inline\": {\n \"context_lines\": \"\",\n \"to\": null,\n \"path\": \"\",\n \"outdated\": false,\n \"from\": 211\n },\n \"type\": \"pullrequest_comment\",\n \"id\": 118571088\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nUpdates include a state property of OPEN, MERGED, or DECLINED.\n\nUpdate example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"update\": {\n \"description\": \"\",\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\",\n \"destination\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"6a2c16e4a152\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152\"\n }\n }\n },\n \"branch\": {\n \"name\": \"master\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"reason\": \"\",\n \"source\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"728c8bad1813\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813\"\n }\n }\n },\n \"branch\": {\n \"name\": \"username/NONE-add-onClick-prop-for-accessibility\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"state\": \"OPEN\",\n \"author\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"date\": \"2019-05-10T06:48:25.305565+00:00\"\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nApproval example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"approval\": {\n \"date\": \"2019-09-27T00:37:19.849534+00:00\",\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n }\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```","responses":{"200":{"description":"The pull request activity log"},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified repository does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List a pull request activity log","tags":["Pullrequests"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}":{"get":{"description":"Returns the specified pull request.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The pull request object"},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or pull request does not exist"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Get a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Mutates the specified pull request.\n\nThis can be used to change the pull request's branches or description.\n\nOnly open pull requests can be mutated.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The pull request that is to be updated."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The updated pull request"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the input document was invalid."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository or pull request id does not exist"}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Update a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity":{"get":{"description":"Returns a paginated list of the pull request's activity log.\n\nThis handler serves both a v20 and internal endpoint. The v20 endpoint\nreturns reviewer comments, updates, approvals and request changes. The internal\nendpoint includes those plus tasks and attachments.\n\nComments created on a file or a line of code have an inline property.\n\nComment example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"comment\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088\"\n }\n },\n \"deleted\": false,\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"content\": {\n \"raw\": \"inline with to a dn from lines\",\n \"markup\": \"markdown\",\n \"html\": \"

inline with to a dn from lines

\",\n \"type\": \"rendered\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"updated_on\": \"2019-09-27T00:33:46.055384+00:00\",\n \"inline\": {\n \"context_lines\": \"\",\n \"to\": null,\n \"path\": \"\",\n \"outdated\": false,\n \"from\": 211\n },\n \"type\": \"pullrequest_comment\",\n \"id\": 118571088\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nUpdates include a state property of OPEN, MERGED, or DECLINED.\n\nUpdate example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"update\": {\n \"description\": \"\",\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\",\n \"destination\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"6a2c16e4a152\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152\"\n }\n }\n },\n \"branch\": {\n \"name\": \"master\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"reason\": \"\",\n \"source\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"728c8bad1813\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813\"\n }\n }\n },\n \"branch\": {\n \"name\": \"username/NONE-add-onClick-prop-for-accessibility\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"state\": \"OPEN\",\n \"author\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"date\": \"2019-05-10T06:48:25.305565+00:00\"\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nApproval example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"approval\": {\n \"date\": \"2019-09-27T00:37:19.849534+00:00\",\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n }\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```","responses":{"200":{"description":"The pull request activity log"},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified repository does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List a pull request activity log","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve":{"delete":{"description":"Redact the authenticated user's approval of the specified pull\nrequest.","responses":{"204":{"description":"An empty response indicating the authenticated user's approval has been withdrawn."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Pull request cannot be unapproved because the pull request has already been merged."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified pull request or the repository does not exist."}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Unapprove a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Approve the specified pull request as the authenticated user.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/participant"}}},"description":"The `participant` object recording that the authenticated user approved the pull request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified pull request or the repository does not exist."}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Approve a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments":{"get":{"description":"Returns a paginated list of the pull request's comments.\n\nThis includes both global, inline comments and replies.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more\ndetails.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pullrequest_comments"}}},"description":"A paginated list of comments made on the given pull request, in chronological order."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the pull request."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the pull request does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List comments on a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new pull request comment.\n\nReturns the newly created pull request comment.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest_comment"}}},"description":"The comment object.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest_comment"}}},"description":"The newly created comment.","headers":{"Location":{"description":"The URL of the new comment","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the pull request."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the pull request does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Create a comment on a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}":{"delete":{"description":"Deletes a specific pull request comment.","responses":{"204":{"description":"Successful deletion."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to delete the comment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a comment on a pull request","tags":["Pullrequests"]},"get":{"description":"Returns a specific pull request comment.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest_comment"}}},"description":"The comment."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the pull request."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Get a comment on a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the comment.","in":"path","name":"comment_id","required":true,"schema":{"type":"integer"}},{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates a specific pull request comment.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest_comment"}}},"description":"The contents of the updated comment.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest_comment"}}},"description":"The updated comment."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the comment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Update a comment on a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve":{"delete":{"description":"","responses":{"204":{"description":"The comment is reopened."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the pull request,\nor if the provided comment is not a top-level comment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment does not exist, or if the comment has not been resolved"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Reopen a comment thread","tags":["Pullrequests"]},"parameters":[{"description":"The id of the comment.","in":"path","name":"comment_id","required":true,"schema":{"type":"integer"}},{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/comment_resolution"}}},"description":"The comment resolution details."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the pull request,\nor if the provided comment is not a top-level comment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment has already been resolved."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Resolve a comment thread","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits":{"get":{"description":"Returns a paginated list of the pull request's commits.\n\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted.","responses":{"200":{"description":"A paginated list of commits made on the given pull request, in chronological order. This list will be empty if the source branch no longer exists."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the pull request."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the pull request does not exist or the source branch is from a forked repository which no longer exists."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List commits on a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline":{"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Declines the pull request.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The pull request was successfully declined."},"555":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the decline took too long and timed out.\nIn this case the caller should retry the request later."}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Decline a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff":{"get":{"description":"Redirects to the [repository diff](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diff-spec-get)\nwith the revspec that corresponds to the pull request.","responses":{"302":{"description":"Redirects to the [repository diff](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diff-spec-get) with the\nrevspec that corresponds to the pull request.\n"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List changes in a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat":{"get":{"description":"Redirects to the [repository diffstat](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diffstat-spec-get)\nwith the revspec that corresponds to the pull request.","responses":{"302":{"description":"Redirects to the [repository diffstat](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diffstat-spec-get) with\nthe revspec that corresponds to pull request.\n"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Get the diff stat for a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge":{"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Merges the pull request.","parameters":[{"description":"Default value is false.\n\n\nWhen set to true, runs merge asynchronously and\nimmediately returns a 202 with polling link to\nthe task-status API in the Location header.\n\n\nWhen set to false, runs merge and waits for it to\ncomplete, returning 200 when it succeeds. If the\nduration of the merge exceeds a timeout threshold,\nthe API returns a 202 with polling link to the\ntask-status API in the Location header.","in":"query","name":"async","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest_merge_parameters"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pullrequest"}}},"description":"The pull request object."},"202":{"description":"In the Location header, the URL to poll for the pull request merge status"},"555":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the merge took too long and timed out.\nIn this case the caller should retry the request later"}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Merge a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}":{"get":{"description":"When merging a pull request takes too long, the client receives a\ntask ID along with a 202 status code. The task ID can be used in a call\nto this endpoint to check the status of a merge task.\n\n```\ncurl -X GET https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\n```\n\nIf the merge task is not yet finished, a PENDING status will be returned.\n\n```\nHTTP/2 200\n{\n \"task_status\": \"PENDING\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\"\n }\n }\n}\n```\n\nIf the merge was successful, a SUCCESS status will be returned.\n\n```\nHTTP/2 200\n{\n \"task_status\": \"SUCCESS\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\"\n }\n },\n \"merge_result\": \n}\n```\n\nIf the merge task failed, an error will be returned.\n\n```\n{\n \"type\": \"error\",\n \"error\": {\n \"message\": \"\"\n }\n}\n```","responses":{"200":{"description":"Returns a task status if the merge is either pending or successful, and if it is successful, a pull request"},"400":{"description":"If the provided task ID does not relate to this pull request, or if something went wrong during the merge operation"},"403":{"description":"The user making the request does not have permission to the repo and is different from the user who queued the task"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Get the merge task status for a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"ID of the merge task","in":"path","name":"task_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch":{"get":{"description":"Redirects to the [repository patch](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-patch-spec-get)\nwith the revspec that corresponds to pull request.","responses":{"302":{"description":"Redirects to the [repository patch](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-patch-spec-get) with\nthe revspec that corresponds to pull request.\n"}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"Get the patch for a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes":{"delete":{"description":"","responses":{"204":{"description":"An empty response indicating the authenticated user's request for change has been withdrawn."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Pull request requested changes cannot be removed because the pull request has already been merged."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified pull request or the repository does not exist."}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Remove change request for a pull request","tags":["Pullrequests"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/participant"}}},"description":"The `participant` object recording that the authenticated user requested changes on the pull request."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Pull request changes cannot be requested because the pull request has already been merged."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified pull request or the repository does not exist."}},"security":[{"oauth2":["pullrequest:write"]},{"basic":[]},{"api_key":[]}],"summary":"Request changes for a pull request","tags":["Pullrequests"]}},"/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses":{"get":{"description":"Returns all statuses (e.g. build results) for the given pull\nrequest.","parameters":[{"description":"Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"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","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_commitstatuses"}}},"description":"A paginated list of all commit statuses for this pull request."},"401":{"description":"If the repository is private and the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified repository or pull request does not exist."}},"security":[{"oauth2":["pullrequest"]},{"basic":[]},{"api_key":[]}],"summary":"List commit statuses for a pull request","tags":["Pullrequests","Commit statuses"]},"parameters":[{"description":"The id of the pull request.","in":"path","name":"pull_request_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}":{"delete":{"description":"Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.","operationId":"deletePullRequestHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The pull request ID.","in":"path","name":"pullrequest_id","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"An empty response."}},"summary":"Delete a pull request application property","tags":["properties"]},"get":{"description":"Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.","operationId":"getPullRequestHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The pull request ID.","in":"path","name":"pullrequest_id","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_property"}}},"description":"The value of the property."}},"summary":"Get a pull request application property","tags":["properties"]},"put":{"description":"Update an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.","operationId":"updatePullRequestHostedPropertyValue","parameters":[{"description":"The repository container; either the workspace slug or the UUID in curly braces.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The repository.","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The pull request ID.","in":"path","name":"pullrequest_id","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/application_property"},"responses":{"204":{"description":"An empty response."}},"summary":"Update a pull request application property","tags":["properties"]}},"/repositories/{workspace}/{repo_slug}/refs":{"get":{"description":"Returns the branches and tags in the repository.\n\nBy default, results will be in the order the underlying source control system returns them and identical to\nthe ordering one sees when running \"$ git show-ref\". Note that this follows simple\nlexical ordering of the ref names.\n\nThis can be undesirable as it does apply any natural sorting semantics, meaning for instance that refs are\nsorted [\"branch1\", \"branch10\", \"branch2\", \"v10\", \"v11\", \"v9\"] instead of [\"branch1\", \"branch2\",\n\"branch10\", \"v9\", \"v10\", \"v11\"].\n\nSorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,\nBitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","schema":{"type":"string"}},{"description":"\nField by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name`\nfield is handled specially for refs in that, if specified as the sort field, it\nuses a natural sort order instead of the default lexicographical sort order. For example,\nit will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2'].","in":"query","name":"sort","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_refs"}}},"description":"A paginated list of refs matching any filter criteria that were provided."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List branches and tags","tags":["Refs"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/refs/branches":{"get":{"description":"Returns a list of all open branches within the specified repository.\n Results will be in the order the source control manager returns them.\n\n ```\n $ curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches?pagelen=1 | jq .\n {\n \"pagelen\": 1,\n \"size\": 187,\n \"values\": [\n {\n \"name\": \"issue-9.3/AUI-5343-assistive-class\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/issue-9.3/AUI-5343-assistive-class\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/issue-9.3/AUI-5343-assistive-class\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/branch/issue-9.3/AUI-5343-assistive-class\"\n }\n },\n \"default_merge_strategy\": \"squash\",\n \"merge_strategies\": [\n \"merge_commit\",\n \"squash\",\n \"fast_forward\"\n ],\n \"type\": \"branch\",\n \"target\": {\n \"hash\": \"e5d1cde9069fcb9f0af90403a4de2150c125a148\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"aui\",\n \"full_name\": \"atlassian/aui\",\n \"uuid\": \"{585074de-7b60-4fd1-81ed-e0bc7fafbda5}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Marcin Konopka \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"Marcin Konopka\",\n \"uuid\": \"{47cc24f4-2a05-4420-88fe-0417535a110a}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B47cc24f4-2a05-4420-88fe-0417535a110a%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B47cc24f4-2a05-4420-88fe-0417535a110a%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/MK-1.png\"\n }\n },\n \"nickname\": \"Marcin Konopka\",\n \"type\": \"user\",\n \"account_id\": \"60113d2b47a9540069f4de03\"\n }\n },\n \"parents\": [\n {\n \"hash\": \"87f7fc92b00464ae47b13ef65c91884e4ac9be51\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/87f7fc92b00464ae47b13ef65c91884e4ac9be51\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/87f7fc92b00464ae47b13ef65c91884e4ac9be51\"\n }\n }\n }\n ],\n \"date\": \"2021-04-13T13:44:49+00:00\",\n \"message\": \"wip\n\",\n \"type\": \"commit\"\n }\n }\n ],\n \"page\": 1,\n \"next\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches?pagelen=1&page=2\"\n }\n ```\n\n Branches support [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)\n that can be used to search for specific branches. For instance, to find\n all branches that have \"stab\" in their name:\n\n ```\n curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches -G --data-urlencode 'q=name ~ \"stab\"'\n ```\n\n By default, results will be in the order the underlying source control system returns them and identical to\n the ordering one sees when running \"$ git branch --list\". Note that this follows simple\n lexical ordering of the ref names.\n\n This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are\n sorted [\"v10\", \"v11\", \"v9\"] instead of [\"v9\", \"v10\", \"v11\"].\n\n Sorting can be changed using the ?q= query parameter. When using ?q=name to explicitly sort on ref name,\n Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","schema":{"type":"string"}},{"description":"\nField by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name`\nfield is handled specially for branches in that, if specified as the sort field, it\nuses a natural sort order instead of the default lexicographical sort order. For example,\nit will return ['branch1', 'branch2', 'branch10'] instead of ['branch1', 'branch10', 'branch2'].","in":"query","name":"sort","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_branches"}}},"description":"A paginated list of branches matching any filter criteria that were provided."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List open branches","tags":["Refs"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new branch in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/branches \\\n-s -u seanfarley -X POST -H \"Content-Type: application/json\" \\\n-d '{\n \"name\" : \"smf/create-feature\",\n \"target\" : {\n \"hash\" : \"default\",\n }\n}'\n```\n\nThis call requires authentication. Private repositories require the\ncaller to authenticate with an account that has appropriate\nauthorization.\n\nThe branch name should not include any prefixes (e.g.\nrefs/heads). This endpoint does support using short hash prefixes for\nthe commit hash, but it may return a 400 response if the provided\nprefix is ambiguous. Using a full commit hash is the preferred\napproach.","responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branch"}}},"description":"The newly created branch object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or branch does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a branch","tags":["Refs"]}},"/repositories/{workspace}/{repo_slug}/refs/branches/{name}":{"delete":{"description":"Delete a branch in the specified repository.\n\nThe main branch is not allowed to be deleted and will return a 400\nresponse.\n\nThe branch name should not include any prefixes (e.g.\nrefs/heads).","responses":{"204":{"description":"Indicates that the specified branch was successfully deleted."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or branch does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a branch","tags":["Refs"]},"get":{"description":"Returns a branch object within the specified repository.\n\n ```\n $ curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master | jq .\n {\n \"name\": \"master\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/master\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/branch/master\"\n }\n },\n \"default_merge_strategy\": \"squash\",\n \"merge_strategies\": [\n \"merge_commit\",\n \"squash\",\n \"fast_forward\"\n ],\n \"type\": \"branch\",\n \"target\": {\n \"hash\": \"e7d158ff7ed5538c28f94cd97a9ad569680fc94e\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"aui\",\n \"full_name\": \"atlassian/aui\",\n \"uuid\": \"{585074de-7b60-4fd1-81ed-e0bc7fafbda5}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"psre-renovate-bot \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"psre-renovate-bot\",\n \"uuid\": \"{250a442a-3ab3-4fcb-87c3-3c8f3df65ec7}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://secure.gravatar.com/avatar/6972ee037c9f36360170a86f544071a2?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FP-3.png\"\n }\n },\n \"nickname\": \"Renovate Bot\",\n \"type\": \"user\",\n \"account_id\": \"5d5355e8c6b9320d9ea5b28d\"\n }\n },\n \"parents\": [\n {\n \"hash\": \"eab868a309e75733de80969a7bed1ec6d4651e06\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/eab868a309e75733de80969a7bed1ec6d4651e06\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/eab868a309e75733de80969a7bed1ec6d4651e06\"\n }\n }\n }\n ],\n \"date\": \"2021-04-12T06:44:38+00:00\",\n \"message\": \"Merged in issue/NONE-renovate-master-babel-monorepo (pull request #2883)\n\nchore(deps): update babel monorepo to v7.13.15 (master)\n\nApproved-by: Chris \"Daz\" Darroch\n\",\n \"type\": \"commit\"\n }\n }\n ```\n\n This call requires authentication. Private repositories require the\n caller to authenticate with an account that has appropriate\n authorization.\n\n For Git, the branch name should not include any prefixes (e.g.\n refs/heads).","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branch"}}},"description":"The branch object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or branch does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a branch","tags":["Refs"]},"parameters":[{"description":"The name of the branch.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/refs/tags":{"get":{"description":"Returns the tags in the repository.\n\nBy default, results will be in the order the underlying source control system returns them and identical to\nthe ordering one sees when running \"$ git tag --list\". Note that this follows simple\nlexical ordering of the ref names.\n\nThis can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are\nsorted [\"v10\", \"v11\", \"v9\"] instead of [\"v9\", \"v10\", \"v11\"].\n\nSorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,\nBitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","schema":{"type":"string"}},{"description":"\nField by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name`\nfield is handled specially for tags in that, if specified as the sort field, it\nuses a natural sort order instead of the default lexicographical sort order. For example,\nit will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2'].","in":"query","name":"sort","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_tags"}}},"description":"A paginated list of tags matching any filter criteria that were provided."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List tags","tags":["Refs"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new tag in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/jdoe/myrepo/refs/tags \\\n-s -u jdoe -X POST -H \"Content-Type: application/json\" \\\n-d '{\n \"name\" : \"new-tag-name\",\n \"target\" : {\n \"hash\" : \"a1b2c3d4e5f6\",\n }\n}'\n```\n\nThis endpoint does support using short hash prefixes for the commit\nhash, but it may return a 400 response if the provided prefix is\nambiguous. Using a full commit hash is the preferred approach.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tag"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tag"}}},"description":"The newly created tag."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the target hash is missing, ambiguous, or invalid, or if the name is not provided."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a tag","tags":["Refs"]}},"/repositories/{workspace}/{repo_slug}/refs/tags/{name}":{"delete":{"description":"Delete a tag in the specified repository.\n\nThe tag name should not include any prefixes (e.g. refs/tags).","responses":{"204":{"description":"Indicates the specified tag was successfully deleted."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or tag does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a tag","tags":["Refs"]},"get":{"description":"Returns the specified tag.\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8 -G | jq .\n{\n \"name\": \"3.8\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commits/3.8\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/tag/3.8\"\n }\n },\n \"tagger\": {\n \"raw\": \"Matt Mackall \",\n \"type\": \"author\",\n \"user\": {\n \"username\": \"mpmselenic\",\n \"nickname\": \"mpmselenic\",\n \"display_name\": \"Matt Mackall\",\n \"type\": \"user\",\n \"uuid\": \"{a4934530-db4c-419c-a478-9ab4964c2ee7}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/mpmselenic\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/mpmselenic/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/mpmselenic/avatar/32/\"\n }\n }\n }\n },\n \"date\": \"2016-05-01T18:52:25+00:00\",\n \"message\": \"Added tag 3.8 for changeset f85de28eae32\",\n \"type\": \"tag\",\n \"target\": {\n \"hash\": \"f85de28eae32e7d3064b1a1321309071bbaaa069\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/avatar/32/\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"hg\",\n \"full_name\": \"seanfarley/hg\",\n \"uuid\": \"{c75687fb-e99d-4579-9087-190dbd406d30}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/patch/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/diff/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Sean Farley \",\n \"type\": \"author\",\n \"user\": {\n \"username\": \"seanfarley\",\n \"nickname\": \"seanfarley\",\n \"display_name\": \"Sean Farley\",\n \"type\": \"user\",\n \"uuid\": \"{a295f8a8-5876-4d43-89b5-3ad8c6c3c51d}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/seanfarley\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/seanfarley/avatar/32/\"\n }\n }\n }\n },\n \"parents\": [\n {\n \"hash\": \"9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2\"\n }\n }\n }\n ],\n \"date\": \"2016-05-01T04:21:17+00:00\",\n \"message\": \"debian: alphabetize build deps\",\n \"type\": \"commit\"\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tag"}}},"description":"The tag object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository is private and the authenticated user does not have\naccess to it.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or tag does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get a tag","tags":["Refs"]},"parameters":[{"description":"The name of the tag.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/src":{"get":{"description":"This endpoint redirects the client to the directory listing of the\nroot directory on the main branch.\n\nThis is equivalent to directly hitting\n[/2.0/repositories/{username}/{repo_slug}/src/{commit}/{path}](src/%7Bcommit%7D/%7Bpath%7D)\nwithout having to know the name or SHA1 of the repo's main branch.\n\nTo create new commits, [POST to this endpoint](#post)","parameters":[{"description":"Instead of returning the file's contents, return the (json) meta data for it.","in":"query","name":"format","required":false,"schema":{"enum":["meta"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_treeentries"}}},"description":"If the path matches a file, then the raw contents of the file are\nreturned (unless the `format=meta` query parameter was provided,\nin which case a json document containing the file's meta data is\nreturned). If the path matches a directory, then a paginated\nlist of file and directory entries is returned (if the\n`format=meta` query parameter was provided, then the json document\ncontaining the directory's meta data is returned).\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the path or commit in the URL does not exist."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get the root directory of the main branch","tags":["Source","Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"This endpoint is used to create new commits in the repository by\nuploading files.\n\nTo add a new file to a repository:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \\\n -F /repo/path/to/image.png=@image.png\n```\n\nThis will create a new commit on top of the main branch, inheriting the\ncontents of the main branch, but adding (or overwriting) the\n`image.png` file to the repository in the `/repo/path/to` directory.\n\nTo create a commit that deletes files, use the `files` parameter:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \\\n -F files=/file/to/delete/1.txt \\\n -F files=/file/to/delete/2.txt\n```\n\nYou can add/modify/delete multiple files in a request. Rename/move a\nfile by deleting the old path and adding the content at the new path.\n\nThis endpoint accepts `multipart/form-data` (as in the examples above),\nas well as `application/x-www-form-urlencoded`.\n\n#### multipart/form-data\n\nA `multipart/form-data` post contains a series of \"form fields\" that\nidentify both the individual files that are being uploaded, as well as\nadditional, optional meta data.\n\nFiles are uploaded in file form fields (those that have a\n`Content-Disposition` parameter) whose field names point to the remote\npath in the repository where the file should be stored. Path field\nnames are always interpreted to be absolute from the root of the\nrepository, regardless whether the client uses a leading slash (as the\nabove `curl` example did).\n\nFile contents are treated as bytes and are not decoded as text.\n\nThe commit message, as well as other non-file meta data for the\nrequest, is sent along as normal form field elements. Meta data fields\nshare the same namespace as the file objects. For `multipart/form-data`\nbodies that should not lead to any ambiguity, as the\n`Content-Disposition` header will contain the `filename` parameter to\ndistinguish between a file named \"message\" and the commit message field.\n\n#### application/x-www-form-urlencoded\n\nIt is also possible to upload new files using a simple\n`application/x-www-form-urlencoded` POST. This can be convenient when\nuploading pure text files:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src \\\n --data-urlencode \"/path/to/me.txt=Lorem ipsum.\" \\\n --data-urlencode \"message=Initial commit\" \\\n --data-urlencode \"author=Erik van Zijst \"\n```\n\nThere could be a field name clash if a client were to upload a file\nnamed \"message\", as this filename clashes with the meta data property\nfor the commit message. To avoid this and to upload files whose names\nclash with the meta data properties, use a leading slash for the files,\ne.g. `curl --data-urlencode \"/message=file contents\"`.\n\nWhen an explicit slash is omitted for a file whose path matches that of\na meta data parameter, then it is interpreted as meta data, not as a\nfile.\n\n#### Executables and links\n\nWhile this API aims to facilitate the most common use cases, it is\npossible to perform some more advanced operations like creating a new\nsymlink in the repository, or creating an executable file.\n\nFiles can be supplied with a `x-attributes` value in the\n`Content-Disposition` header. For example, to upload an executable\nfile, as well as create a symlink from `README.txt` to `README`:\n\n```\n--===============1438169132528273974==\nContent-Type: text/plain; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-ID: \"bin/shutdown.sh\"\nContent-Disposition: attachment; filename=\"shutdown.sh\"; x-attributes:\"executable\"\n\n#!/bin/sh\nhalt\n\n--===============1438169132528273974==\nContent-Type: text/plain; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-ID: \"/README.txt\"\nContent-Disposition: attachment; filename=\"README.txt\"; x-attributes:\"link\"\n\nREADME\n--===============1438169132528273974==--\n```\n\nLinks are files that contain the target path and have\n`x-attributes:\"link\"` set.\n\nWhen overwriting links with files, or vice versa, the newly uploaded\nfile determines both the new contents, as well as the attributes. That\nmeans uploading a file without specifying `x-attributes=\"link\"` will\ncreate a regular file, even if the parent commit hosted a symlink at\nthe same path.\n\nThe same applies to executables. When modifying an existing executable\nfile, the form-data file element must include\n`x-attributes=\"executable\"` in order to preserve the executable status\nof the file.\n\nNote that this API does not support the creation or manipulation of\nsubrepos / submodules.","parameters":[{"description":"The commit message. When omitted, Bitbucket uses a canned string.","in":"query","name":"message","required":false,"schema":{"type":"string"}},{"description":"\nThe raw string to be used as the new commit's author.\nThis string follows the format\n`Erik van Zijst `.\n\nWhen omitted, Bitbucket uses the authenticated user's\nfull/display name and primary email address. Commits cannot\nbe created anonymously.","in":"query","name":"author","required":false,"schema":{"type":"string"}},{"description":"\nA comma-separated list of SHA1s of the commits that should\nbe the parents of the newly created commit.\n\nWhen omitted, the new commit will inherit from and become\na child of the main branch's tip/HEAD commit.\n\nWhen more than one SHA1 is provided, the first SHA1\nidentifies the commit from which the content will be\ninherited.\".","in":"query","name":"parents","required":false,"schema":{"type":"string"}},{"description":"\nOptional field that declares the files that the request is\nmanipulating. When adding a new file to a repo, or when\noverwriting an existing file, the client can just upload\nthe full contents of the file in a normal form field and\nthe use of this `files` meta data field is redundant.\nHowever, when the `files` field contains a file path that\ndoes not have a corresponding, identically-named form\nfield, then Bitbucket interprets that as the client wanting\nto replace the named file with the null set and the file is\ndeleted instead.\n\nPaths in the repo that are referenced in neither files nor\nan individual file field, remain unchanged and carry over\nfrom the parent to the new commit.\n\nThis API does not support renaming as an explicit feature.\nTo rename a file, simply delete it and recreate it under\nthe new name in the same commit.\n","in":"query","name":"files","required":false,"schema":{"type":"string"}},{"description":"\nThe name of the branch that the new commit should be\ncreated on. When omitted, the commit will be created on top\nof the main branch and will become the main branch's new\nhead.\n\nWhen a branch name is provided that already exists in the\nrepo, then the commit will be created on top of that\nbranch. In this case, *if* a parent SHA1 was also provided,\nthen it is asserted that the parent is the branch's\ntip/HEAD at the time the request is made. When this is not\nthe case, a 409 is returned.\n\nWhen a new branch name is specified (that does not already\nexist in the repo), and no parent SHA1s are provided, then\nthe new commit will inherit from the current main branch's\ntip/HEAD commit, but not advance the main branch. The new\ncommit will be the new branch. When the request *also*\nspecifies a parent SHA1, then the new commit and branch\nare created directly on top of the parent commit,\nregardless of the state of the main branch.\n\nWhen a branch name is not specified, but a parent SHA1 is\nprovided, then Bitbucket asserts that it represents the\nmain branch's current HEAD/tip, or a 409 is returned.\n\nWhen a branch name is not specified and the repo is empty,\nthe new commit will become the repo's root commit and will\nbe on the main branch.\n\nWhen a branch name is specified and the repo is empty, the\nnew commit will become the repo's root commit and also\ndefine the repo's main branch going forward.\n\nThis API cannot be used to create additional root commits\nin non-empty repos.\n\nThe branch field cannot be repeated.\n\nAs a side effect, this API can be used to create a new\nbranch without modifying any files, by specifying a new\nbranch name in this field, together with `parents`, but\nomitting the `files` fields, while not sending any files.\nThis will create a new commit and branch with the same\ncontents as the first parent. The diff of this commit\nagainst its first parent will be empty.\n","in":"query","name":"branch","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"\n"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have write or admin access"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the repository does not exist."}},"security":[{"oauth2":["repository:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a commit by uploading a file","tags":["Source","Repositories"]}},"/repositories/{workspace}/{repo_slug}/src/{commit}/{path}":{"get":{"description":"This endpoints is used to retrieve the contents of a single file,\nor the contents of a directory at a specified revision.\n\n#### Raw file contents\n\nWhen `path` points to a file, this endpoint returns the raw contents.\nThe response's Content-Type is derived from the filename\nextension (not from the contents). The file contents are not processed\nand no character encoding/recoding is performed and as a result no\ncharacter encoding is included as part of the Content-Type.\n\nThe `Content-Disposition` header will be \"attachment\" to prevent\nbrowsers from running executable files.\n\nIf the file is managed by LFS, then a 301 redirect pointing to\nAtlassian's media services platform is returned.\n\nThe response includes an ETag that is based on the contents of the file\nand its attributes. This means that an empty `__init__.py` always\nreturns the same ETag, regardless on the directory it lives in, or the\ncommit it is on.\n\n#### File meta data\n\nWhen the request for a file path includes the query parameter\n`?format=meta`, instead of returning the file's raw contents, Bitbucket\ninstead returns the JSON object describing the file's properties:\n\n```javascript\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests/__init__.py?format=meta\n{\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta\"\n }\n },\n \"path\": \"tests/__init__.py\",\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"eefd5ef5d3df01aed629f650959d6706d54cd335\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n }\n }\n },\n \"attributes\": [],\n \"type\": \"commit_file\",\n \"size\": 0\n}\n```\n\nFile objects contain an `attributes` element that contains a list of\npossible modifiers. Currently defined values are:\n\n* `link` -- indicates that the entry is a symbolic link. The contents\n of the file represent the path the link points to.\n* `executable` -- indicates that the file has the executable bit set.\n* `subrepository` -- indicates that the entry points to a submodule or\n subrepo. The contents of the file is the SHA1 of the repository\n pointed to.\n* `binary` -- indicates whether Bitbucket thinks the file is binary.\n\nThis endpoint can provide an alternative to how a HEAD request can be\nused to check for the existence of a file, or a file's size without\nincurring the overhead of receiving its full contents.\n\n\n#### Directory listings\n\nWhen `path` points to a directory instead of a file, the response is a\npaginated list of directory and file objects in the same order as the\nunderlying SCM system would return them.\n\nFor example:\n\n```javascript\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"path\": \"tests/test_project\",\n \"type\": \"commit_directory\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta\"\n }\n },\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"eefd5ef5d3df01aed629f650959d6706d54cd335\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n }\n }\n }\n },\n {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta\"\n }\n },\n \"path\": \"tests/__init__.py\",\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"eefd5ef5d3df01aed629f650959d6706d54cd335\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n }\n }\n },\n \"attributes\": [],\n \"type\": \"commit_file\",\n \"size\": 0\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nWhen listing the contents of the repo's root directory, the use of a\ntrailing slash at the end of the URL is required.\n\nThe response by default is not recursive, meaning that only the direct contents of\na path are returned. The response does not recurse down into\nsubdirectories. In order to \"walk\" the entire directory tree, the\nclient can either parse each response and follow the `self` links of each\n`commit_directory` object, or can specify a `max_depth` to recurse to.\n\nThe max_depth parameter will do a breadth-first search to return the contents of the subdirectories\nup to the depth specified. Breadth-first search was chosen as it leads to the least amount of\nfile system operations for git. If the `max_depth` parameter is specified to be too\nlarge, the call will time out and return a 555.\n\nEach returned object is either a `commit_file`, or a `commit_directory`,\nboth of which contain a `path` element. This path is the absolute path\nfrom the root of the repository. Each object also contains a `commit`\nobject which embeds the commit the file is on. Note that this is merely\nthe commit that was used in the URL. It is *not* the commit that last\nmodified the file.\n\nDirectory objects have 2 representations. Their `self` link returns the\npaginated contents of the directory. The `meta` link on the other hand\nreturns the actual `directory` object itself, e.g.:\n\n```javascript\n{\n \"path\": \"tests/test_project\",\n \"type\": \"commit_directory\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta\"\n }\n },\n \"commit\": { ... }\n}\n```\n\n#### Querying, filtering and sorting\n\nLike most API endpoints, this API supports the Bitbucket\nquerying/filtering syntax and so you could filter a directory listing\nto only include entries that match certain criteria. For instance, to\nlist all binary files over 1kb use the expression:\n\n`size > 1024 and attributes = \"binary\"`\n\nwhich after urlencoding yields the query string:\n\n`?q=size%3E1024+and+attributes%3D%22binary%22`\n\nTo change the ordering of the response, use the `?sort` parameter:\n\n`.../src/eefd5ef/?sort=-size`\n\nSee [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more\ndetails.","parameters":[{"description":"If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.","in":"query","name":"format","required":false,"schema":{"enum":["meta","rendered"],"type":"string"}},{"description":"Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1.","in":"query","name":"max_depth","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_treeentries"}}},"description":"If the path matches a file, then the raw contents of the file are\nreturned. If the `format=meta` query parameter is provided,\na json document containing the file's meta data is\nreturned. If the `format=rendered` query parameter is provided,\nthe contents of the file in HTML-formated rendered markup is returned.\nIf the path matches a directory, then a paginated\nlist of file and directory entries is returned (if the\n`format=meta` query parameter was provided, then the json document\ncontaining the directory's meta data is returned.)\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the path or commit in the URL does not exist."},"555":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the call times out, possibly because the specified recursion depth is too large."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"Get file or directory contents","tags":["Source","Repositories"]},"parameters":[{"description":"The commit's SHA1.","in":"path","name":"commit","required":true,"schema":{"type":"string"}},{"description":"Path to the file.","in":"path","name":"path","required":true,"schema":{"type":"string"}},{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/versions":{"get":{"description":"Returns the versions that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_versions"}}},"description":"The versions that have been defined in the issue tracker."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"List defined versions for issues","tags":["Issue tracker"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/versions/{version_id}":{"get":{"description":"Returns the specified issue tracker version object.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/version"}}},"description":"The specified version object."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The specified repository or version does not exist or does not have the issue tracker enabled."}},"security":[{"oauth2":["issue"]},{"basic":[]},{"api_key":[]}],"summary":"Get a defined version for issues","tags":["Issue tracker"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"The version's id","in":"path","name":"version_id","required":true,"schema":{"type":"integer"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/repositories/{workspace}/{repo_slug}/watchers":{"get":{"description":"Returns a paginated list of all the watchers on the specified\nrepository.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_accounts"}}},"description":"A paginated list of all the watchers on the specified repository."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List repositories watchers","tags":["Repositories"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets":{"get":{"description":"Returns all snippets. Like pull requests, repositories and workspaces, the\nfull set of snippets is defined by what the current user has access to.\n\nThis includes all snippets owned by any of the workspaces the user is a member of,\nor snippets by other users that the current user is either watching or has collaborated\non (for instance by commenting on it).\n\nTo limit the set of returned snippets, apply the\n`?role=[owner|contributor|member]` query parameter where the roles are\ndefined as follows:\n\n* `owner`: all snippets owned by the current user\n* `contributor`: all snippets owned by, or watched by the current user\n* `member`: created in a workspaces or watched by the current user\n\nWhen no role is specified, all public snippets are returned, as well as all\nprivately owned snippets watched or commented on.\n\nThe returned response is a normal paginated JSON list. This endpoint\nonly supports `application/json` responses and no\n`multipart/form-data` or `multipart/related`. As a result, it is not\npossible to include the file contents.","parameters":[{"description":"Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).","in":"query","name":"role","required":false,"schema":{"enum":["owner","contributor","member"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_snippets"}}},"description":"A paginated list of snippets."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"List snippets","tags":["Snippets"]},"parameters":[],"post":{"description":"Creates a new snippet under the authenticated user's account.\n\nSnippets can contain multiple files. Both text and binary files are\nsupported.\n\nThe simplest way to create a new snippet from a local file:\n\n $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png\n\nCreating snippets through curl has a few limitations and so let's look\nat a more complicated scenario.\n\nSnippets are created with a multipart POST. Both `multipart/form-data`\nand `multipart/related` are supported. Both allow the creation of\nsnippets with both meta data (title, etc), as well as multiple text\nand binary files.\n\nThe main difference is that `multipart/related` can use rich encoding\nfor the meta data (currently JSON).\n\n\nmultipart/related (RFC-2387)\n----------------------------\n\nThis is the most advanced and efficient way to create a paste.\n\n POST /2.0/snippets/evzijst HTTP/1.1\n Content-Length: 1188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My snippet\",\n \"is_private\": true,\n \"scm\": \"git\",\n \"files\": {\n \"foo.txt\": {},\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nThe request contains multiple parts and is structured as follows.\n\nThe first part is the JSON document that describes the snippet's\nproperties or meta data. It either has to be the first part, or the\nrequest's `Content-Type` header must contain the `start` parameter to\npoint to it.\n\nThe remaining parts are the files of which there can be zero or more.\nEach file part should contain the `Content-ID` MIME header through\nwhich the JSON meta data's `files` element addresses it. The value\nshould be the name of the file.\n\n`Content-Disposition` is an optional MIME header. The header's\noptional `filename` parameter can be used to specify the file name\nthat Bitbucket should use when writing the file to disk. When present,\n`filename` takes precedence over the value of `Content-ID`.\n\nWhen the JSON body omits the `files` element, the remaining parts are\nnot ignored. Instead, each file is added to the new snippet as if its\nname was explicitly linked (the use of the `files` elements is\nmandatory for some operations like deleting or renaming files).\n\n\nmultipart/form-data\n-------------------\n\nThe use of JSON for the snippet's meta data is optional. Meta data can\nalso be supplied as regular form fields in a more conventional\n`multipart/form-data` request:\n\n $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets -F title=\"My snippet\" -F file=@foo.txt -F file=@image.png\n\n POST /2.0/snippets HTTP/1.1\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"image.png\"\n Content-Type: application/octet-stream\n\n ?PNG\n\n IHDR?1??I.....\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My snippet\n ------------------------------63a4b224c59f--\n\nHere the meta data properties are included as flat, top-level form\nfields. The file attachments use the `file` field name. To attach\nmultiple files, simply repeat the field.\n\nThe advantage of `multipart/form-data` over `multipart/related` is\nthat it can be easier to build clients.\n\nEssentially all properties are optional, `title` and `files` included.\n\n\nSharing and Visibility\n----------------------\n\nSnippets can be either public (visible to anyone on Bitbucket, as well\nas anonymous users), or private (visible only to members of the workspace).\nThis is controlled through the snippet's `is_private` element:\n\n* **is_private=false** -- everyone, including anonymous users can view\n the snippet\n* **is_private=true** -- only workspace members can view the snippet\n\nTo create the snippet under a workspace, just append the workspace ID\nto the URL. See [`/2.0/snippets/{workspace}`](/cloud/bitbucket/rest/api-group-snippets/#api-snippets-workspace-post).","requestBody":{"$ref":"#/components/requestBodies/snippet"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The newly created snippet object.","headers":{"Location":{"description":"The URL of the newly created snippet.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a snippet","tags":["Snippets"]}},"/snippets/{workspace}":{"get":{"description":"Identical to [`/snippets`](/cloud/bitbucket/rest/api-group-snippets/#api-snippets-get), except that the result is further filtered\nby the snippet owner and only those that are owned by `{workspace}` are\nreturned.","parameters":[{"description":"Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).","in":"query","name":"role","required":false,"schema":{"enum":["owner","contributor","member"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_snippets"}}},"description":"A paginated list of snippets."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the user does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"List snippets in a workspace","tags":["Snippets"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Identical to [`/snippets`](/cloud/bitbucket/rest/api-group-snippets/#api-snippets-post), except that the new snippet will be\ncreated under the workspace specified in the path parameter\n`{workspace}`.","requestBody":{"$ref":"#/components/requestBodies/snippet"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The newly created snippet object.","headers":{"Location":{"description":"The URL of the newly created snippet.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to create snippets in the specified workspace."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Create a snippet for a workspace","tags":["Snippets"]}},"/snippets/{workspace}/{encoded_id}":{"delete":{"description":"Deletes a snippet and returns an empty response.","responses":{"204":{"description":"If the snippet was deleted successfully."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet is private and the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If authenticated user does not have permission to delete the private snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a snippet","tags":["Snippets"]},"get":{"description":"Retrieves a single snippet.\n\nSnippets support multiple content types:\n\n* application/json\n* multipart/related\n* multipart/form-data\n\n\napplication/json\n----------------\n\nThe default content type of the response is `application/json`.\nSince JSON is always `utf-8`, it cannot reliably contain file contents\nfor files that are not text. Therefore, JSON snippet documents only\ncontain the filename and links to the file contents.\n\nThis means that in order to retrieve all parts of a snippet, N+1\nrequests need to be made (where N is the number of files in the\nsnippet).\n\n\nmultipart/related\n-----------------\n\nTo retrieve an entire snippet in a single response, use the\n`Accept: multipart/related` HTTP request header.\n\n $ curl -H \"Accept: multipart/related\" https://api.bitbucket.org/2.0/snippets/evzijst/1\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 2214\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments\"\n },\n \"watchers\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers\"\n },\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits\"\n }\n },\n \"id\": kypj,\n \"title\": \"My snippet\",\n \"created_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"updated_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"is_private\": false,\n \"files\": {\n \"foo.txt\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt\"\n }\n }\n },\n \"image.png\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-image.png\"\n }\n }\n }\n ],\n \"owner\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n },\n \"creator\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nmultipart/form-data\n-------------------\n\nAs with creating new snippets, `multipart/form-data` can be used as an\nalternative to `multipart/related`. However, the inherently flat\nstructure of form-data means that only basic, root-level properties\ncan be returned, while nested elements like `links` are omitted:\n\n $ curl -H \"Accept: multipart/form-data\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n Content-Type: text/plain; charset=\"utf-8\"\n\n My snippet\n ------------------------------63a4b224c59f--\n Content-Disposition: attachment; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: attachment; name=\"file\"; filename=\"image.png\"\n Content-Transfer-Encoding: base64\n Content-Type: application/octet-stream\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n ------------------------------5957323a6b76--","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The snippet object."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet is private and the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If authenticated user does not have access to the private snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet marked as spam."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get a snippet","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Used to update a snippet. Use this to add and delete files and to\nchange a snippet's title.\n\nTo update a snippet, one can either PUT a full snapshot, or only the\nparts that need to be changed.\n\nThe contract for PUT on this API is that properties missing from the\nrequest remain untouched so that snippets can be efficiently\nmanipulated with differential payloads.\n\nTo delete a property (e.g. the title, or a file), include its name in\nthe request, but omit its value (use `null`).\n\nAs in Git, explicit renaming of files is not supported. Instead, to\nrename a file, delete it and add it again under another name. This can\nbe done atomically in a single request. Rename detection is left to\nthe SCM.\n\nPUT supports three different content types for both request and\nresponse bodies:\n\n* `application/json`\n* `multipart/related`\n* `multipart/form-data`\n\nThe content type used for the request body can be different than that\nused for the response. Content types are specified using standard HTTP\nheaders.\n\nUse the `Content-Type` and `Accept` headers to select the desired\nrequest and response format.\n\n\napplication/json\n----------------\n\nAs with creation and retrieval, the content type determines what\nproperties can be manipulated. `application/json` does not support\nfile contents and is therefore limited to a snippet's meta data.\n\nTo update the title, without changing any of its files:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": \"Updated title\"}'\n\n\nTo delete the title:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": null}'\n\nNot all parts of a snippet can be manipulated. The owner and creator\nfor instance are immutable.\n\n\nmultipart/related\n-----------------\n\n`multipart/related` can be used to manipulate all of a snippet's\nproperties. The body is identical to a POST. properties omitted from\nthe request are left unchanged. Since the `start` part contains JSON,\nthe mechanism for manipulating the snippet's meta data is identical\nto `application/json` requests.\n\nTo update one of a snippet's file contents, while also changing its\ntitle:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 288\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My updated snippet\",\n \"files\": {\n \"foo.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n Updated file contents.\n\n --===============1438169132528273974==--\n\nHere only the parts that are changed are included in the body. The\nother files remain untouched.\n\nNote the use of the `files` list in the JSON part. This list contains\nthe files that are being manipulated. This list should have\ncorresponding multiparts in the request that contain the new contents\nof these files.\n\nIf a filename in the `files` list does not have a corresponding part,\nit will be deleted from the snippet, as shown below:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==--\n\nTo simulate a rename, delete a file and add the same file under\nanother name:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 212\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"foo.txt\": {},\n \"bar.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"bar.txt\"\n Content-Disposition: attachment; filename=\"bar.txt\"\n\n foo\n\n --===============1438169132528273974==--\n\n\nmultipart/form-data\n-----------------\n\nAgain, one can also use `multipart/form-data` to manipulate file\ncontents and meta data atomically.\n\n $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj -F title=\"My updated snippet\" -F file=@foo.txt\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 351\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My updated snippet\n ------------------------------63a4b224c59f\n\nTo delete a file, omit its contents while including its name in the\n`files` field:\n\n $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 149\n Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86\n\n ------------------------------ef8871065a86\n Content-Disposition: form-data; name=\"files\"\n\n image.png\n ------------------------------ef8871065a86--\n\nThe explicit use of the `files` element in `multipart/related` and\n`multipart/form-data` is only required when deleting files.\nThe default mode of operation is for file parts to be processed,\nregardless of whether or not they are listed in `files`, as a\nconvenience to the client.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The updated snippet object."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet is private and the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If authenticated user does not have permission to update the private snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Update a snippet","tags":["Snippets"]}},"/snippets/{workspace}/{encoded_id}/comments":{"get":{"description":"Used to retrieve a paginated list of all comments for a specific\nsnippet.\n\nThis resource works identical to commit and pull request comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_snippet_comments"}}},"description":"A paginated list of snippet comments, ordered by creation date."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"List comments on a snippet","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new comment.\n\nThe only required field in the body is `content.raw`.\n\nTo create a threaded reply to an existing comment, include `parent.id`.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet_comment"}}},"description":"The contents of the new comment.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet_comment"}}},"description":"The newly created comment.","headers":{"Location":{"description":"The URL of the new comment","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Create a comment on a snippet","tags":["Snippets"]}},"/snippets/{workspace}/{encoded_id}/comments/{comment_id}":{"delete":{"description":"Deletes a snippet comment.\n\nComments can only be removed by the comment author, snippet creator, or workspace admin.","responses":{"204":{"description":"Indicates the comment was deleted successfully."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user is not the author of the comment."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment or the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a comment on a snippet","tags":["Snippets"]},"get":{"description":"Returns the specific snippet comment.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet_comment"}}},"description":"The specified comment."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment or snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get a comment on a snippet","tags":["Snippets"]},"parameters":[{"description":"The id of the comment.","in":"path","name":"comment_id","required":true,"schema":{"type":"integer"}},{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates a comment.\n\nThe only required field in the body is `content.raw`.\n\nComments can only be updated by their author.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet_comment"}}},"description":"The contents to update the comment to.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet_comment"}}},"description":"The updated comment object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the comment or snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Update a comment on a snippet","tags":["Snippets"]}},"/snippets/{workspace}/{encoded_id}/commits":{"get":{"description":"Returns the changes (commits) made on this snippet.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_snippet_commit"}}},"description":"The paginated list of snippet commits."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"List snippet changes","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets/{workspace}/{encoded_id}/commits/{revision}":{"get":{"description":"Returns the changes made on this snippet in this commit.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet_commit"}}},"description":"The specified snippet commit."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the commit or the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get a previous snippet change","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"The commit's SHA1.","in":"path","name":"revision","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets/{workspace}/{encoded_id}/files/{path}":{"get":{"description":"Convenience resource for getting to a snippet's raw files without the\nneed for first having to retrieve the snippet itself and having to pull\nout the versioned file links.","responses":{"302":{"description":"A redirect to the most recent revision of the specified file.","headers":{"Location":{"description":"The URL of the most recent file revision.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get a snippet's raw file at HEAD","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"Path to the file.","in":"path","name":"path","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets/{workspace}/{encoded_id}/watch":{"delete":{"description":"Used to stop watching a specific snippet. Returns 204 (No Content)\nto indicate success.","responses":{"204":{"description":"Indicates the user stopped watching the snippet successfully."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Stop watching a snippet","tags":["Snippets"]},"get":{"description":"Used to check if the current user is watching a specific snippet.\n\nReturns 204 (No Content) if the user is watching the snippet and 404 if\nnot.\n\nHitting this endpoint anonymously always returns a 404.","responses":{"204":{"description":"If the authenticated user is watching the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist, or if the authenticated user is not watching the snippet."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Check if the current user is watching a snippet","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Used to start watching a specific snippet. Returns 204 (No Content).","responses":{"204":{"description":"Indicates the authenticated user is now watching the snippet."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Watch a snippet","tags":["Snippets"]}},"/snippets/{workspace}/{encoded_id}/watchers":{"get":{"deprecated":true,"description":"Returns a paginated list of all users watching a specific snippet.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_accounts"}}},"description":"The paginated list of users watching this snippet"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"List users watching a snippet","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets/{workspace}/{encoded_id}/{node_id}":{"delete":{"description":"Deletes the snippet.\n\nNote that this only works for versioned URLs that point to the latest\ncommit of the snippet. Pointing to an older commit results in a 405\nstatus code.\n\nTo delete a snippet, regardless of whether or not concurrent changes\nare being made to it, use `DELETE /snippets/{encoded_id}` instead.","responses":{"204":{"description":"If the snippet was deleted successfully."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet is private and the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If authenticated user does not have permission to delete the private snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If `{node_id}` is not the latest revision."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a previous revision of a snippet","tags":["Snippets"]},"get":{"description":"Identical to `GET /snippets/encoded_id`, except that this endpoint\ncan be used to retrieve the contents of the snippet as it was at an\nolder revision, while `/snippets/encoded_id` always returns the\nsnippet's current revision.\n\nNote that only the snippet's file contents are versioned, not its\nmeta data properties like the title.\n\nOther than that, the two endpoints are identical in behavior.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The snippet object."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet is private and the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If authenticated user does not have access to the private snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet, or the revision does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get a previous revision of a snippet","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"A commit revision (SHA1).","in":"path","name":"node_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Identical to `UPDATE /snippets/encoded_id`, except that this endpoint\ntakes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\"\n(most recent) version can be updated and requests on all other,\nolder revisions fail by returning a 405 status.\n\nUsage of this endpoint over the unrestricted `/snippets/encoded_id`\ncould be desired if the caller wants to be sure no concurrent\nmodifications have taken place between the moment of the UPDATE\nrequest and the original GET.\n\nThis can be considered a so-called \"Compare And Swap\", or CAS\noperation.\n\nOther than that, the two endpoints are identical in behavior.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/snippet"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The updated snippet object."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet is private and the request was not authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If authenticated user does not have permission to update the private snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet or the revision does not exist."},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/error"}},"multipart/related":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If `{node_id}` is not the latest revision."}},"security":[{"oauth2":["snippet:write"]},{"basic":[]},{"api_key":[]}],"summary":"Update a previous revision of a snippet","tags":["Snippets"]}},"/snippets/{workspace}/{encoded_id}/{node_id}/files/{path}":{"get":{"description":"Retrieves the raw contents of a specific file in the snippet. The\n`Content-Disposition` header will be \"attachment\" to avoid issues with\nmalevolent executable files.\n\nThe file's mime type is derived from its filename and returned in the\n`Content-Type` header.\n\nNote that for text files, no character encoding is included as part of\nthe content type.","responses":{"200":{"description":"Returns the contents of the specified file.","headers":{"Content-Disposition":{"description":"attachment","schema":{"type":"string"}},"Content-Type":{"description":"The mime type as derived from the filename","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the file or snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get a snippet's raw file","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"A commit revision (SHA1).","in":"path","name":"node_id","required":true,"schema":{"type":"string"}},{"description":"Path to the file.","in":"path","name":"path","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets/{workspace}/{encoded_id}/{revision}/diff":{"get":{"description":"Returns the diff of the specified commit against its first parent.\n\nNote that this resource is different in functionality from the `patch`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the diff is\nunspecified as Git does not track this, making it hard for\nBitbucket to reliably determine this.","parameters":[{"description":"When used, only one the diff of the specified file will be returned.","in":"query","name":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The raw diff contents."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get snippet changes between versions","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.","in":"path","name":"revision","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/snippets/{workspace}/{encoded_id}/{revision}/patch":{"get":{"description":"Returns the patch of the specified commit against its first\nparent.\n\nNote that this resource is different in functionality from the `diff`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the patch is\nunspecified as Git does not track this, making it hard for\nBitbucket to reliably determine this.","responses":{"200":{"description":"The raw patch contents."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have access to the snippet."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the snippet does not exist."}},"security":[{"oauth2":["snippet"]},{"basic":[]},{"api_key":[]}],"summary":"Get snippet patch between versions","tags":["Snippets"]},"parameters":[{"description":"The snippet id.","in":"path","name":"encoded_id","required":true,"schema":{"type":"string"}},{"description":"A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.","in":"path","name":"revision","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/teams/{username}/pipelines_config/variables":{"get":{"deprecated":true,"description":"Find account level variables.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"getPipelineVariablesForTeam","parameters":[{"description":"The account.","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_variables"}}},"description":"The found account level variables."}},"summary":"List variables for an account","tags":["Pipelines"]},"post":{"deprecated":true,"description":"Create an account level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"createPipelineVariableForTeam","parameters":[{"description":"The account.","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pipeline_variable2"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The created variable.","headers":{"Location":{"description":"The URL of the newly created pipeline variable.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A variable with the provided key already exists."}},"summary":"Create a variable for a user","tags":["Pipelines"]}},"/teams/{username}/pipelines_config/variables/{variable_uuid}":{"delete":{"deprecated":true,"description":"Delete a team level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"deletePipelineVariableForTeam","parameters":[{"description":"The account.","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to delete.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The variable was deleted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or the variable with the provided UUID does not exist."}},"summary":"Delete a variable for a team","tags":["Pipelines"]},"get":{"deprecated":true,"description":"Retrieve a team level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"getPipelineVariableForTeam","parameters":[{"description":"The account.","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to retrieve.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or variable with the given UUID was not found."}},"summary":"Get a variable for a team","tags":["Pipelines"]},"put":{"deprecated":true,"description":"Update a team level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"updatePipelineVariableForTeam","parameters":[{"description":"The account.","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pipeline_variable"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable was updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or the variable was not found."}},"summary":"Update a variable for a team","tags":["Pipelines"]}},"/teams/{username}/search/code":{"get":{"description":"Search for code in the repositories of the specified team.\n\nSearching across all repositories:\n\n```\ncurl 'https://api.bitbucket.org/2.0/teams/team_name/search/code?search_query=foo'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 2,\n \"content_matches\": [\n {\n \"lines\": [\n {\n \"line\": 2,\n \"segments\": []\n },\n {\n \"line\": 3,\n \"segments\": [\n {\n \"text\": \"def \"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \"():\"\n }\n ]\n },\n {\n \"line\": 4,\n \"segments\": [\n {\n \"text\": \" print(\\\"snek\\\")\"\n }\n ]\n },\n {\n \"line\": 5,\n \"segments\": []\n }\n ]\n }\n ],\n \"path_matches\": [\n {\n \"text\": \"src/\"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \".py\"\n }\n ],\n \"file\": {\n \"path\": \"src/foo.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n }\n }\n }\n ]\n}\n```\n\nNote that searches can match in the file's text (`content_matches`),\nthe path (`path_matches`), or both as in the example above.\n\nYou can use the same syntax for the search query as in the UI, e.g.\nto only search within a specific repository:\n\n```\ncurl 'https://api.bitbucket.org/2.0/teams/team_name/search/code?search_query=foo+repo:demo'\n# results from the \"demo\" repository\n```\n\nSimilar to other APIs, you can request more fields using a\n`fields` query parameter. E.g. to get some more information about\nthe repository of matched files (the `%2B` is a URL-encoded `+`):\n\n```\ncurl 'https://api.bitbucket.org/2.0/teams/team_name/search/code'\\\n '?search_query=foo&fields=%2Bvalues.file.commit.repository'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 1,\n \"content_matches\": [...],\n \"path_matches\": [...],\n \"file\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n }\n },\n \"repository\": {\n \"name\": \"demo\",\n \"type\": \"repository\",\n \"full_name\": \"my-workspace/demo\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default\"\n }\n },\n \"uuid\": \"{850e1749-781a-4115-9316-df39d0600e7a}\"\n }\n },\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n },\n \"path\": \"src/foo.py\"\n }\n }\n ]\n}\n```\n\nTry `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.\n","operationId":"searchTeam","parameters":[{"description":"The account to search in; either the username or the UUID in curly braces","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"The search query","in":"query","name":"search_query","required":true,"schema":{"type":"string"}},{"description":"Which page of the search results to retrieve","in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","type":"integer"}},{"description":"How many search results to retrieve per page","in":"query","name":"pagelen","required":false,"schema":{"default":10,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_result_page"}}},"description":"Successful search"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the search request was invalid due to one of the\nfollowing reasons:\n\n* the specified type of target account doesn''t match the actual\naccount type;\n\n* malformed pagination properties;\n\n* missing or malformed search query, in the latter case an error\nkey will be returned in `error.data.key` property.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Search is not enabled for the requested team, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Too many requests, try again later"}},"summary":"Search for code in a team's repositories","tags":["Search"]}},"/user":{"get":{"description":"Returns the currently logged in user.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"The current user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"When the request wasn't authenticated."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"Get current user","tags":["Users"]},"parameters":[]},"/user/emails":{"get":{"description":"Returns all the authenticated user's email addresses. Both\nconfirmed and unconfirmed.","responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unexpected error."}},"security":[{"oauth2":["email"]},{"basic":[]},{"api_key":[]}],"summary":"List email addresses for current user","tags":["Users"]},"parameters":[]},"/user/emails/{email}":{"get":{"description":"Returns details about a specific one of the authenticated user's\nemail addresses.\n\nDetails describe whether the address has been confirmed by the user and\nwhether it is the user's primary address or not.","responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unexpected error."}},"security":[{"oauth2":["email"]},{"basic":[]},{"api_key":[]}],"summary":"Get an email address for current user","tags":["Users"]},"parameters":[{"description":"Email address of the user.","in":"path","name":"email","required":true,"schema":{"type":"string"}}]},"/user/permissions/repositories":{"get":{"description":"Returns an object for each repository the caller has explicit access\nto and their effective permission — the highest level of permission the\ncaller has. This does not return public repositories that the user was\nnot granted any specific permission in, and does not distinguish between\nexplicit and implicit privileges.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/user/permissions/repositories\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"bitbucket/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```\n\nResults may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by\nrepository or permission by adding the following query string\nparameters:\n\n* `q=repository.name=\"geordi\"` or `q=permission>\"read\"`\n* `sort=repository.name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repository_permissions"}}},"description":"Repository permissions for the repositories a caller has explicit access to."}},"security":[{"oauth2":["account","repository"]},{"basic":[]},{"api_key":[]}],"summary":"List repository permissions for a user","tags":["Repositories"]},"parameters":[]},"/user/permissions/workspaces":{"get":{"description":"Returns an object for each workspace the caller is a member of, and\ntheir effective role - the highest level of privilege the caller has.\nIf a user is a member of multiple groups with distinct roles, only the\nhighest level is returned.\n\nPermissions can be:\n\n* `owner`\n* `collaborator`\n* `member`\n\n**The `collaborator` role is being removed from the Bitbucket Cloud API. For more information,\nsee the [deprecation announcement](/cloud/bitbucket/deprecation-notice-collaborator-role/).**\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/user/permissions/workspaces\n\n{\n \"pagelen\": 10,\n \"page\": 1,\n \"size\": 1,\n \"values\": [\n {\n \"type\": \"workspace_membership\",\n \"permission\": \"owner\",\n \"last_accessed\": \"2019-03-07T12:35:02.900024+00:00\",\n \"added_on\": \"2018-10-11T17:42:02.961424+00:00\",\n \"user\": {\n \"type\": \"user\",\n \"uuid\": \"{470c176d-3574-44ea-bb41-89e8638bcca4}\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n },\n \"workspace\": {\n \"type\": \"workspace\",\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"slug\": \"bbworkspace1\",\n \"name\": \"Atlassian Bitbucket\",\n }\n }\n ]\n}\n```\n\nResults may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by\nworkspace or permission by adding the following query string parameters:\n\n* `q=workspace.slug=\"bbworkspace1\"` or `q=permission=\"owner\"`\n* `sort=workspace.slug`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.","parameters":[{"description":"\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_workspace_memberships"}}},"description":"All of the workspace memberships for the authenticated user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"List workspaces for the current user","tags":["Workspaces"]},"parameters":[]},"/users/{selected_user}":{"get":{"description":"Gets the public information associated with a user account.\n\nIf the user's profile is private, `location`, `website` and\n`created_on` elements are omitted.\n\nNote that the user object returned by this operation is changing significantly, due to privacy changes.\nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-bitbucket-user-objects) for details.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"The user object"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If no user exists for the specified UUID, or if the specified account is a team account, not a personal account."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Get a user","tags":["Users"]},"parameters":[{"description":"This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account ID.\n","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}}]},"/users/{selected_user}/pipelines_config/variables":{"get":{"deprecated":true,"description":"Find user level variables.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"getPipelineVariablesForUser","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_variables"}}},"description":"The found user level variables."}},"summary":"List variables for a user","tags":["Pipelines"]},"post":{"deprecated":true,"description":"Create a user level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"createPipelineVariableForUser","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pipeline_variable2"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The created variable.","headers":{"Location":{"description":"The URL of the newly created pipeline variable.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A variable with the provided key already exists."}},"summary":"Create a variable for a user","tags":["Pipelines"]}},"/users/{selected_user}/pipelines_config/variables/{variable_uuid}":{"delete":{"deprecated":true,"description":"Delete an account level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"deletePipelineVariableForUser","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to delete.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The variable was deleted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or the variable with the provided UUID does not exist."}},"summary":"Delete a variable for a user","tags":["Pipelines"]},"get":{"deprecated":true,"description":"Retrieve a user level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"getPipelineVariableForUser","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to retrieve.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or variable with the given UUID was not found."}},"summary":"Get a variable for a user","tags":["Pipelines"]},"put":{"deprecated":true,"description":"Update a user level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).","operationId":"updatePipelineVariableForUser","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pipeline_variable"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable was updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The account or the variable was not found."}},"summary":"Update a variable for a user","tags":["Pipelines"]}},"/users/{selected_user}/properties/{app_key}/{property_name}":{"delete":{"description":"Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a user.","operationId":"deleteUserHostedPropertyValue","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"An empty response."}},"summary":"Delete a user application property","tags":["properties"]},"get":{"description":"Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a user.","operationId":"retrieveUserHostedPropertyValue","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_property"}}},"description":"The value of the property."}},"summary":"Get a user application property","tags":["properties"]},"put":{"description":"Update an [application property](/cloud/bitbucket/application-properties/) value stored against a user.","operationId":"updateUserHostedPropertyValue","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The key of the Connect app.","in":"path","name":"app_key","required":true,"schema":{"type":"string"}},{"description":"The name of the property.","in":"path","name":"property_name","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/application_property"},"responses":{"204":{"description":"An empty response."}},"summary":"Update a user application property","tags":["properties"]}},"/users/{selected_user}/search/code":{"get":{"description":"Search for code in the repositories of the specified user.\n\nSearching across all repositories:\n\n```\ncurl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code?search_query=foo'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 2,\n \"content_matches\": [\n {\n \"lines\": [\n {\n \"line\": 2,\n \"segments\": []\n },\n {\n \"line\": 3,\n \"segments\": [\n {\n \"text\": \"def \"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \"():\"\n }\n ]\n },\n {\n \"line\": 4,\n \"segments\": [\n {\n \"text\": \" print(\\\"snek\\\")\"\n }\n ]\n },\n {\n \"line\": 5,\n \"segments\": []\n }\n ]\n }\n ],\n \"path_matches\": [\n {\n \"text\": \"src/\"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \".py\"\n }\n ],\n \"file\": {\n \"path\": \"src/foo.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n }\n }\n }\n ]\n}\n```\n\nNote that searches can match in the file's text (`content_matches`),\nthe path (`path_matches`), or both as in the example above.\n\nYou can use the same syntax for the search query as in the UI, e.g.\nto only search within a specific repository:\n\n```\ncurl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code?search_query=foo+repo:demo'\n# results from the \"demo\" repository\n```\n\nSimilar to other APIs, you can request more fields using a\n`fields` query parameter. E.g. to get some more information about\nthe repository of matched files (the `%2B` is a URL-encoded `+`):\n\n```\ncurl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code'\\\n '?search_query=foo&fields=%2Bvalues.file.commit.repository'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 1,\n \"content_matches\": [...],\n \"path_matches\": [...],\n \"file\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n }\n },\n \"repository\": {\n \"name\": \"demo\",\n \"type\": \"repository\",\n \"full_name\": \"my-workspace/demo\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default\"\n }\n },\n \"uuid\": \"{850e1749-781a-4115-9316-df39d0600e7a}\"\n }\n },\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n },\n \"path\": \"src/foo.py\"\n }\n }\n ]\n}\n```\n\nTry `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.\n","operationId":"searchAccount","parameters":[{"description":"Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"The search query","in":"query","name":"search_query","required":true,"schema":{"type":"string"}},{"description":"Which page of the search results to retrieve","in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","type":"integer"}},{"description":"How many search results to retrieve per page","in":"query","name":"pagelen","required":false,"schema":{"default":10,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_result_page"}}},"description":"Successful search"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the search request was invalid due to one of the\nfollowing reasons:\n\n* the specified type of target account doesn''t match the actual\naccount type;\n\n* malformed pagination properties;\n\n* missing or malformed search query, in the latter case an error\nkey will be returned in `error.data.key` property.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Search is not enabled for the requested user, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Too many requests, try again later"}},"summary":"Search for code in a user's repositories","tags":["Search"]}},"/users/{selected_user}/ssh-keys":{"get":{"description":"Returns a paginated list of the user's SSH public keys.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys\n{\n \"page\": 1,\n \"pagelen\": 10,\n \"size\": 1,\n \"values\": [\n {\n \"comment\": \"user@myhost\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n }\n ]\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_ssh_user_keys"}}},"description":"A list of the SSH keys associated with the account."},"403":{"description":"If the specified user's keys are not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist"}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"List SSH keys","tags":["Ssh"]},"parameters":[{"description":"This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account ID.\n","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}}],"post":{"description":"Adds a new SSH public key to the specified user account and returns the resulting key.\n\nExample:\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY user@myhost\"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys\n\n{\n \"comment\": \"user@myhost\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n}\n```","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssh_account_key"}}},"description":"The new SSH key object. Note that the username property has been deprecated due to [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis)."},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssh_account_key"}}},"description":"The newly created SSH key."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the submitted key or related value is invalid"},"403":{"description":"If the current user does not have permission to add a key for the specified user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist"}},"security":[{"oauth2":["account:write"]},{"basic":[]},{"api_key":[]}],"summary":"Add a new SSH key","tags":["Ssh"]}},"/users/{selected_user}/ssh-keys/{key_id}":{"delete":{"description":"Deletes a specific SSH public key from a user's account\n\nExample:\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}\n```","responses":{"204":{"description":"The key has been deleted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the submitted key or related value is invalid"},"403":{"description":"If the current user does not have permission to add a key for the specified user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist"}},"security":[{"oauth2":["account:write"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a SSH key","tags":["Ssh"]},"get":{"description":"Returns a specific SSH public key belonging to a user.\n\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{fbe4bbab-f6f7-4dde-956b-5c58323c54b3}\n\n{\n \"comment\": \"user@myhost\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssh_account_key"}}},"description":"The specific SSH key matching the user and UUID"},"403":{"description":"If the specified user or key is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user or key does not exist"}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"Get a SSH key","tags":["Ssh"]},"parameters":[{"description":"The SSH key's UUID value.","in":"path","name":"key_id","required":true,"schema":{"type":"string"}},{"description":"This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account ID.\n","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates a specific SSH public key on a user's account\n\nNote: Only the 'comment' field can be updated using this API. To modify the key or comment values, you must delete and add the key again.\n\nExample:\n```\n$ curl -X PUT -H \"Content-Type: application/json\" -d '{\"label\": \"Work key\"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}\n\n{\n \"comment\": \"\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"Work key\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n}\n```","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssh_account_key"}}},"description":"The updated SSH key object"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssh_account_key"}}},"description":"The newly updated SSH key."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the submitted key or related value is invalid"},"403":{"description":"If the current user does not have permission to add a key for the specified user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user does not exist"}},"security":[{"oauth2":["account:write"]},{"basic":[]},{"api_key":[]}],"summary":"Update a SSH key","tags":["Ssh"]}},"/workspaces":{"get":{"description":"Returns a list of workspaces accessible by the authenticated user.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/workspaces\n\n{\n \"pagelen\": 10,\n \"page\": 1,\n \"size\": 1,\n \"values\": [\n {\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"links\": {\n \"owners\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1/members?q=permission%3D%22owner%22\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1\"\n },\n \"repositories\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bbworkspace1\"\n },\n \"snippets\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/bbworkspace1\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bbworkspace1/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/workspaces/bbworkspace1/avatar/?ts=1543465801\"\n },\n \"members\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1/members\"\n },\n \"projects\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1/projects\"\n }\n },\n \"created_on\": \"2018-11-14T19:15:05.058566+00:00\",\n \"type\": \"workspace\",\n \"slug\": \"bbworkspace1\",\n \"is_private\": true,\n \"name\": \"Atlassian Bitbucket\"\n }\n ]\n}\n```\n\nResults may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering) by\nworkspace or permission by adding the following query string parameters:\n\n* `q=slug=\"bbworkspace1\"` or `q=is_private=true`\n* `sort=created_on`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.\n\n**The `collaborator` role is being removed from the Bitbucket Cloud API. For more information,\nsee the [deprecation announcement](/cloud/bitbucket/deprecation-notice-collaborator-role/).**","parameters":[{"description":"\n Filters the workspaces based on the authenticated user's role on each workspace.\n\n * **member**: returns a list of all the workspaces which the caller is a member of\n at least one workspace group or repository\n * **collaborator**: returns a list of workspaces which the caller has write access\n to at least one repository in the workspace\n * **owner**: returns a list of workspaces which the caller has administrator access\n ","in":"query","name":"role","required":false,"schema":{"enum":["owner","collaborator","member"],"type":"string"}},{"description":"\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_workspaces"}}},"description":"The list of workspaces accessible by the authenticated user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"List workspaces for user","tags":["Workspaces"]},"parameters":[]},"/workspaces/{workspace}":{"get":{"description":"Returns the requested workspace.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}},"description":"The workspace."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If no workspace exists for the specified name or UUID."}},"security":[{"oauth2":[]},{"basic":[]},{"api_key":[]}],"summary":"Get a workspace","tags":["Workspaces"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/hooks":{"get":{"description":"Returns a paginated list of webhooks installed on this workspace.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_webhook_subscriptions"}}},"description":"The paginated list of installed webhooks."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user is not an owner on the specified workspace."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"List webhooks for a workspace","tags":["Workspaces","Webhooks"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new webhook on the specified workspace.\n\nWorkspace webhooks are fired for events from all repositories contained\nby that workspace.\n\nExample:\n\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json'\n https://api.bitbucket.org/2.0/workspaces/my-workspace/hooks\n -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\n\nThis call requires the webhook scope, as well as any scope\nthat applies to the events that the webhook subscribes to. In the\nexample above that means: `webhook`, `repository` and `issue`.\n\nThe `url` must properly resolve and cannot be an internal, non-routed address.\n\nOnly workspace owners can install webhooks on workspaces.","responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_subscription"}}},"description":"If the webhook was registered successfully.","headers":{"Location":{"description":"The URL of new newly created webhook.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to install webhooks on the specified workspace."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Create a webhook for a workspace","tags":["Workspaces","Webhooks"]}},"/workspaces/{workspace}/hooks/{uid}":{"delete":{"description":"Deletes the specified webhook subscription from the given workspace.","responses":{"204":{"description":"When the webhook was deleted successfully"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to delete the webhook."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the webhook or workspace does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a webhook for a workspace","tags":["Workspaces","Webhooks"]},"get":{"description":"Returns the webhook with the specified id installed on the given\nworkspace.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_subscription"}}},"description":"The webhook subscription object."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the webhook or workspace does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Get a webhook for a workspace","tags":["Workspaces","Webhooks"]},"parameters":[{"description":"Installed webhook's ID","in":"path","name":"uid","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_subscription"}}},"description":"The webhook subscription object."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have permission to update the webhook."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the webhook or workspace does not exist."}},"security":[{"oauth2":["webhook"]},{"basic":[]},{"api_key":[]}],"summary":"Update a webhook for a workspace","tags":["Workspaces","Webhooks"]}},"/workspaces/{workspace}/members":{"get":{"description":"Returns all members of the requested workspace.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_workspace_memberships"}}},"description":"The list of users that are part of a workspace."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"List users in a workspace","tags":["Workspaces"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/members/{member}":{"get":{"description":"Returns the workspace membership, which includes\na `User` object for the member and a `Workspace` object\nfor the requested workspace.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace_membership"}}},"description":"The user that is part of a workspace."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A workspace cannot be found, or a user cannot be found, or the user is not a a member of the workspace."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"Get user membership for a workspace","tags":["Workspaces"]},"parameters":[{"description":"Member's UUID or Atlassian ID.","in":"path","name":"member","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/permissions":{"get":{"description":"Returns the list of members in a workspace\nand their permission levels.\nPermission can be:\n* `owner`\n* `collaborator`\n* `member`\n\n**The `collaborator` role is being removed from the Bitbucket Cloud API. For more information,\nsee the [deprecation announcement](/cloud/bitbucket/deprecation-notice-collaborator-role/).**\n\nExample:\n\n```\n$ curl -X https://api.bitbucket.org/2.0/workspaces/bbworkspace1/permissions\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"permission\": \"owner\",\n \"type\": \"workspace_membership\",\n \"user\": {\n \"type\": \"user\",\n \"uuid\": \"{470c176d-3574-44ea-bb41-89e8638bcca4}\",\n \"display_name\": \"Erik van Zijst\",\n },\n \"workspace\": {\n \"type\": \"workspace\",\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"slug\": \"bbworkspace1\",\n \"name\": \"Atlassian Bitbucket\",\n }\n },\n {\n \"permission\": \"member\",\n \"type\": \"workspace_membership\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"seanaty\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"workspace\": {\n \"type\": \"workspace\",\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"slug\": \"bbworkspace1\",\n \"name\": \"Atlassian Bitbucket\",\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered](/cloud/bitbucket/rest/intro/#filtering) by\npermission by adding the following query string parameters:\n\n* `q=permission=\"owner\"`","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_workspace_memberships"}}},"description":"The list of users that are part of a workspace, along with their permission."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"List user permissions in a workspace","tags":["Workspaces"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/permissions/repositories":{"get":{"description":"Returns an object for each repository permission for all of a\nworkspace's repositories.\n\nPermissions returned are effective permissions: the highest level of\npermission the user has. This does not distinguish between direct and\nindirect (group) privileges.\n\nOnly users with admin permission for the team may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/workspaces/atlassian_tutorial/permissions/repositories\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Jeff Zeng\",\n \"uuid\": \"{47f92a9a-c3a3-4d0b-bc4e-782a969c5c72}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"whee\",\n \"full_name\": \"atlassian_tutorial/whee\",\n \"uuid\": \"{30ba25e9-51ff-4555-8dd0-fc7ee2fa0895}\"\n },\n \"permission\": \"admin\"\n }\n ],\n \"page\": 1,\n \"size\": 3\n}\n```\n\nResults may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering)\nby repository, user, or permission by adding the following query string\nparameters:\n\n* `q=repository.name=\"geordi\"` or `q=permission>\"read\"`\n* `sort=user.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repository_permissions"}}},"description":"List of workspace's repository permissions."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the workspace."}},"security":[{"oauth2":["account"]},{"basic":[]},{"api_key":[]}],"summary":"List all repository permissions for a workspace","tags":["Workspaces"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/permissions/repositories/{repo_slug}":{"get":{"description":"Returns an object for the repository permission of each user in the\nrequested repository.\n\nPermissions returned are effective permissions: the highest level of\npermission the user has. This does not distinguish between direct and\nindirect (group) privileges.\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/workspaces/atlassian_tutorial/permissions/repositories/geordi\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\"\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered or sorted](/cloud/bitbucket/rest/intro/#filtering)\nby user, or permission by adding the following query string parameters:\n\n* `q=permission>\"read\"`\n* `sort=user.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.","parameters":[{"description":"\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_repository_permissions"}}},"description":"The repository permission for all users in this repository."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't an admin of the repository."}},"security":[{"oauth2":["repository"]},{"basic":[]},{"api_key":[]}],"summary":"List a repository permissions for a workspace","tags":["Workspaces"]},"parameters":[{"description":"This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n","in":"path","name":"repo_slug","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration":{"get":{"description":"This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/","operationId":"getOIDCConfiguration","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The OpenID configuration"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace was not found."}},"summary":"Get OpenID configuration for OIDC in Pipelines","tags":["Pipelines"]}},"/workspaces/{workspace}/pipelines-config/identity/oidc/keys.json":{"get":{"description":"This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/","operationId":"getOIDCKeys","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The keys in JSON web key format"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace was not found."}},"summary":"Get keys for OIDC in Pipelines","tags":["Pipelines"]}},"/workspaces/{workspace}/pipelines-config/variables":{"get":{"description":"Find workspace level variables.","operationId":"getPipelineVariablesForWorkspace","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_pipeline_variables"}}},"description":"The found workspace level variables."}},"summary":"List variables for a workspace","tags":["Pipelines"]},"post":{"description":"Create a workspace level variable.","operationId":"createPipelineVariableForWorkspace","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pipeline_variable2"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The created variable.","headers":{"Location":{"description":"The URL of the newly created pipeline variable.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace does not exist."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A variable with the provided key already exists."}},"summary":"Create a variable for a workspace","tags":["Pipelines"]}},"/workspaces/{workspace}/pipelines-config/variables/{variable_uuid}":{"delete":{"description":"Delete a workspace level variable.","operationId":"deletePipelineVariableForWorkspace","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to delete.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The variable was deleted"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace or the variable with the provided UUID does not exist."}},"summary":"Delete a variable for a workspace","tags":["Pipelines"]},"get":{"description":"Retrieve a workspace level variable.","operationId":"getPipelineVariableForWorkspace","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable to retrieve.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace or variable with the given UUID was not found."}},"summary":"Get variable for a workspace","tags":["Pipelines"]},"put":{"description":"Update a workspace level variable.","operationId":"updatePipelineVariableForWorkspace","parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The UUID of the variable.","in":"path","name":"variable_uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pipeline_variable"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable was updated."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The workspace or the variable was not found."}},"summary":"Update variable for a workspace","tags":["Pipelines"]}},"/workspaces/{workspace}/projects":{"get":{"description":"Returns the list of projects in this workspace.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_projects"}}},"description":"The list of projects in this workspace."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A workspace doesn't exist at this location."}},"security":[{"oauth2":["project"]},{"basic":[]},{"api_key":[]}],"summary":"List projects in a workspace","tags":["Workspaces"]},"parameters":[{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new project.\n\nNote that the avatar has to be embedded as either a data-url\nor a URL to an external image as shown in the examples below:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/...\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```\n\nor even:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"http://i.imgur.com/72tRx4w.gif\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```","requestBody":{"$ref":"#/components/requestBodies/project"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project"}}},"description":"A new project has been created.","headers":{"Location":{"description":"The location of the newly created project","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't authorized to create the project."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A workspace doesn't exist at this location."}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Create a project in a workspace","tags":["Projects"]}},"/workspaces/{workspace}/projects/{project_key}":{"delete":{"description":"Deletes this project. This is an irreversible operation.\n\nYou cannot delete a project that still contains repositories.\nTo delete the project, [delete](/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-delete)\nor transfer the repositories first.\n\nExample:\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/bbworkspace1/PROJ\n```","responses":{"204":{"description":"Successful deletion."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't authorized to delete the project or the project isn't empty."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A project isn't hosted at this location."}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a project for a workspace","tags":["Projects"]},"get":{"description":"Returns the requested project.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project"}}},"description":"The project that is part of a workspace."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The request wasn't authenticated."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't authorized to access the project."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A project isn't hosted at this location."}},"security":[{"oauth2":["project"]},{"basic":[]},{"api_key":[]}],"summary":"Get a project for a workspace","tags":["Projects","Workspaces"]},"parameters":[{"description":"The project in question. This is the actual `key` assigned\nto the project.\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Since this endpoint can be used to both update and to create a\nproject, the request body depends on the intent.\n\n#### Creation\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The `key` should not be specified in the body of request\n(since it is already present in the URL). The `name` is required,\neverything else is optional.\n\n#### Update\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The key is not required in the body (since it is already in\nthe URL). The key may be specified in the body, if the intent is\nto change the key itself. In such a scenario, the location of the\nproject is changed and is returned in the `Location` header of the\nresponse.","requestBody":{"$ref":"#/components/requestBodies/project"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project"}}},"description":"The existing project is has been updated.","headers":{"Location":{"description":"The location of the project. This header is only provided\nwhen the project key is updated.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project"}}},"description":"A new project has been created.","headers":{"Location":{"description":"The location of the newly created project","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"The requesting user isn't authorized to update or create the project."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"A workspace doesn't exist at the location. Note that the project's absence from this location doesn't raise a 404, since a PUT at a non-existent location can be used to create a new project."}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update a project for a workspace","tags":["Projects"]}},"/workspaces/{workspace}/projects/{project_key}/branching-model":{"get":{"description":"Return the branching model set at the project level. This view is\nread-only. The branching model settings can be changed using the\n[settings](#api-workspaces-workspace-projects-project-key-branching-model-settings-get)\nAPI.\n\nThe returned object:\n\n1. Always has a `development` property. `development.name` is\n the user-specified branch that can be inherited by an individual repository's\n branching model.\n2. Might have a `production` property. `production` will not\n be present when `production` is disabled.\n `production.name` is the user-specified branch that can be\n inherited by an individual repository's branching model.\n3. Always has a `branch_types` array which contains all enabled branch\n types.\n\nExample body:\n\n```\n{\n \"development\": {\n \"name\": \"master\",\n \"use_mainbranch\": true\n },\n \"production\": {\n \"name\": \"production\",\n \"use_mainbranch\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"project_branching_model\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_branching_model"}}},"description":"The branching model object"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have read access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the project does not exist"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get the branching model for a project","tags":["Branching model"]},"parameters":[{"description":"The project in question. This is the actual `key` assigned\nto the project.\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/projects/{project_key}/branching-model/settings":{"get":{"description":"Return the branching model configuration for a project. The returned\nobject:\n\n1. Always has a `development` property for the development branch.\n2. Always a `production` property for the production branch. The\n production branch can be disabled.\n3. The `branch_types` contains all the branch types.\n\n\nThis is the raw configuration for the branching model. A client\nwishing to see the branching model with its actual current branches may find the\n[active model API](#api-workspaces-workspace-projects-project-key-branching-model-get)\nmore useful.\n\nExample body:\n\n```\n{\n \"development\": {\n \"name\": null,\n \"use_mainbranch\": true\n },\n \"production\": {\n \"name\": \"production\",\n \"use_mainbranch\": false,\n \"enabled\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"enabled\": true,\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"enabled\": true,\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"enabled\": false,\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model_settings\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model/settings\"\n }\n }\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branching_model_settings"}}},"description":"The branching model configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the project does not exist"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get the branching model config for a project","tags":["Branching model"]},"parameters":[{"description":"The project in question. This is the actual `key` assigned\nto the project.\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Update the branching model configuration for a project.\n\nThe `development` branch can be configured to a specific branch or to\ntrack the main branch. Any branch name can be supplied, but will only\nsuccessfully be applied to a repository via inheritance if that branch\nexists for that repository. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`development` property will leave the development branch unchanged.\n\nThe `production` branch can be a specific branch, the main\nbranch or disabled. Any branch name can be supplied, but will only\nsuccessfully be applied to a repository via inheritance if that branch\nexists for that repository. The `enabled` property can be used to enable (`true`)\nor disable (`false`) it. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`production` property will leave the production branch unchanged.\n\nThe `branch_types` property contains the branch types to be updated.\nOnly the branch types passed will be updated. All updates will be\nrejected if it would leave the branching model in an invalid state.\nFor branch types this means that:\n\n1. The prefixes for all enabled branch types are valid. For example,\n it is not possible to use '*' inside a Git prefix.\n2. A prefix of an enabled branch type must not be a prefix of another\n enabled branch type. This is to ensure that a branch can be easily\n classified by its prefix unambiguously.\n\nIt is possible to store an invalid prefix if that branch type would be\nleft disabled. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. Each branch type must\nhave a `kind` property to identify it.\n\nExample Body:\n\n```\n {\n \"development\": {\n \"use_mainbranch\": true\n },\n \"production\": {\n \"enabled\": true,\n \"use_mainbranch\": false,\n \"name\": \"production\"\n },\n \"branch_types\": [\n {\n \"kind\": \"bugfix\",\n \"enabled\": true,\n \"prefix\": \"bugfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"release\",\n \"enabled\": false,\n }\n ]\n }\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/branching_model_settings"}}},"description":"The updated branching model configuration"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request contains an invalid branching model configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the request was not authenticated"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the project does not exist"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Update the branching model config for a project","tags":["Branching model"]}},"/workspaces/{workspace}/projects/{project_key}/default-reviewers":{"get":{"description":"Return a list of all default reviewers for a project. This is a list of users that will be added as default\nreviewers to pull requests for any repository within the project.\n\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/.../projects/.../default-reviewers | jq .\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"user\": {\n \"display_name\": \"Davis Lee\",\n \"uuid\": \"{f0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6}\"\n },\n \"reviewer_type\": \"project\",\n \"type\": \"default_reviewer\"\n },\n {\n \"user\": {\n \"display_name\": \"Jorge Rodriguez\",\n \"uuid\": \"{1aa43376-260d-4a0b-9660-f62672b9655d}\"\n },\n \"reviewer_type\": \"project\",\n \"type\": \"default_reviewer\"\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_default_reviewer_and_type"}}},"description":"The list of project default reviewers"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the workspace or project does not exist at this location"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"List the default reviewers in a project","tags":["Projects"]},"parameters":[{"description":"The project in question. This is the actual `key` assigned\nto the project.\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}":{"delete":{"description":"Removes a default reviewer from the project.\n\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/.../default-reviewers/%7Bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6%7D\n\nHTTP/1.1 204\n```","responses":{"204":{"description":"The specified user was removed from the list of project default reviewers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user is not a default reviewer for the project"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user, project, or workspace does not exist"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Remove the specific user from the project's default reviewers","tags":["Projects"]},"get":{"description":"Returns the specified default reviewer.\n\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/.../default-reviewers/%7Bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6%7D\n{\n \"display_name\": \"Davis Lee\",\n \"type\": \"user\",\n \"uuid\": \"{f0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6}\"\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}},"description":"The specified user that is a default reviewer"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user is not a default reviewer for the project"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user, project, or workspace does not exist"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get a default reviewer","tags":["Projects"]},"parameters":[{"description":"The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account UUID}`.\n","in":"path","name":"selected_user","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"put":{"description":"Adds the specified user to the project's list of default reviewers. The method is\nidempotent. Accepts an optional body containing the `uuid` of the user to be added.\n\nExample:\n```\n$ curl -XPUT https://api.bitbucket.org/2.0/.../default-reviewers/%7Bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6%7D\n-d { 'uuid': '{f0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6}' }\n\nHTTP/1.1 204\n```","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}},"description":"The specified user was added as a project default reviewer"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user cannot be added as a default reviewer for the project"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the authenticated user does not have admin access to the project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified user, project, or workspace does not exist"}},"security":[{"oauth2":["project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Add the specific user as a default reviewer for the project","tags":["Projects"]}},"/workspaces/{workspace}/projects/{project_key}/deploy-keys":{"get":{"description":"Returns all deploy keys belonging to a project.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT/deploy-keys\n\nOutput:\n{\n \"pagelen\":10,\n \"values\":[\n {\n \"comment\":\"thakseth@C02W454JHTD8\",\n \"last_used\":null,\n \"links\":{\n \"self\":{\n \"href\":\"https://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT/deploy-keys/1234\"\n }\n },\n \"label\":\"test\",\n \"project\":{\n \"links\":{\n \"self\":{\n \"href\":\"https://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT\"\n }\n },\n \"type\":\"project\",\n \"name\":\"cooperative standard\",\n \"key\":\"TEST_PROJECT\",\n \"uuid\":\"{3b3e510b-7f2b-414d-a2b7-76c4e405c1c0}\"\n },\n \"created_on\":\"2021-07-28T21:20:19.491721+00:00\",\n \"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDX5yfMOEw6HG9jKTYTisbmDTJ4MCUTSVGr5e4OWvY3UuI2A6F8SdzQqa2f5BABA/4g5Sk5awJrYHlNu3EzV1V2I44tR3A4fnZAG71ZKyDPi1wvdO7UYmFgxV/Vd18H9QZFFjICGDM7W0PT2mI0kON/jN3qNWi+GiB/xgaeQKSqynysdysDp8lnnI/8Sh3ikURP9UP83ShRCpAXszOUNaa+UUlcYQYBDLIGowsg51c4PCkC3DNhAMxppkNRKoSOWwyl+oRVXHSDylkiJSBHW3HH4Q6WHieD54kGrjbhWBKdnnxKX7QAAZBDseY+t01N36m6/ljvXSUEcBWtHxBYye0r\",\n \"type\":\"project_deploy_key\",\n \"id\":1234\n }\n ],\n \"page\":1,\n \"size\":1\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paginated_project_deploy_keys"}}},"description":"Deploy keys matching the project"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace or project is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace or project does not exist"}},"security":[{"oauth2":["project","project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"List project deploy keys","tags":["Deployments"]},"parameters":[{"description":"The project in question. This is the actual `key` assigned\nto the project.\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}],"post":{"description":"Create a new deploy key in a project.\n\nExample:\n```\n$ curl -XPOST \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/workspaces/jzeng/projects/JZ/deploy-keys/ -d \\\n'{\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8\",\n \"label\": \"mydeploykey\"\n}'\n\nOutput:\n{\n \"comment\": \"mleu@C02W454JHTD8\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/testadfsa/projects/ASDF/deploy-keys/5/\"\n }\n },\n \"label\": \"myprojectkey\",\n \"project\": {\n ...\n },\n \"created_on\": \"2021-08-10T05:28:00.570859+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"type\": \"project_deploy_key\",\n \"id\": 5\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_deploy_key"}}},"description":"The project deploy key that was created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Invalid deploy key inputs"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace or project is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace or project does not exist"}},"security":[{"oauth2":["project","project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Create a project deploy key","tags":["Deployments"]}},"/workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}":{"delete":{"description":"This deletes a deploy key from a project.\n\nExample:\n```\n$ curl -XDELETE \\\n-H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/workspaces/jzeng/projects/JZ/deploy-keys/1234\n```","responses":{"204":{"description":"The project deploy key has been deleted"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the current user does not have permission to delete a key for the specified project"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace, project, or project deploy key does not exist"}},"security":[{"oauth2":["project","project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Delete a deploy key from a project","tags":["Deployments"]},"get":{"description":"Returns the deploy key belonging to a specific key ID.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT/deploy-keys/1234\n\nOutput:\n{\n \"pagelen\":10,\n \"values\":[\n {\n \"comment\":\"thakseth@C02W454JHTD8\",\n \"last_used\":null,\n \"links\":{\n \"self\":{\n \"href\":\"https://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT/deploy-keys/1234\"\n }\n },\n \"label\":\"test\",\n \"project\":{\n \"links\":{\n \"self\":{\n \"href\":\"https://api.bitbucket.org/2.0/workspaces/standard/projects/TEST_PROJECT\"\n }\n },\n \"type\":\"project\",\n \"name\":\"cooperative standard\",\n \"key\":\"TEST_PROJECT\",\n \"uuid\":\"{3b3e510b-7f2b-414d-a2b7-76c4e405c1c0}\"\n },\n \"created_on\":\"2021-07-28T21:20:19.491721+00:00\",\n \"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDX5yfMOEw6HG9jKTYTisbmDTJ4MCUTSVGr5e4OWvY3UuI2A6F8SdzQqa2f5BABA/4g5Sk5awJrYHlNu3EzV1V2I44tR3A4fnZAG71ZKyDPi1wvdO7UYmFgxV/Vd18H9QZFFjICGDM7W0PT2mI0kON/jN3qNWi+GiB/xgaeQKSqynysdysDp8lnnI/8Sh3ikURP9UP83ShRCpAXszOUNaa+UUlcYQYBDLIGowsg51c4PCkC3DNhAMxppkNRKoSOWwyl+oRVXHSDylkiJSBHW3HH4Q6WHieD54kGrjbhWBKdnnxKX7QAAZBDseY+t01N36m6/ljvXSUEcBWtHxBYye0r\",\n \"type\":\"project_deploy_key\",\n \"id\":1234\n }\n ],\n}\n```","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project_deploy_key"}}},"description":"Project deploy key matching the key ID"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace or project is not accessible to the current user"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the specified workspace or project does not exist"}},"security":[{"oauth2":["project","project:admin"]},{"basic":[]},{"api_key":[]}],"summary":"Get a project deploy key","tags":["Deployments"]},"parameters":[{"description":"The key ID matching the project deploy key.","in":"path","name":"key_id","required":true,"schema":{"type":"string"}},{"description":"The project in question. This is the actual `key` assigned\nto the project.\n","in":"path","name":"project_key","required":true,"schema":{"type":"string"}},{"description":"This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n","in":"path","name":"workspace","required":true,"schema":{"type":"string"}}]},"/workspaces/{workspace}/search/code":{"get":{"description":"Search for code in the repositories of the specified workspace.\n\nSearching across all repositories:\n\n```\ncurl 'https://api.bitbucket.org/2.0/workspaces/workspace_slug_or_uuid/search/code?search_query=foo'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 2,\n \"content_matches\": [\n {\n \"lines\": [\n {\n \"line\": 2,\n \"segments\": []\n },\n {\n \"line\": 3,\n \"segments\": [\n {\n \"text\": \"def \"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \"():\"\n }\n ]\n },\n {\n \"line\": 4,\n \"segments\": [\n {\n \"text\": \" print(\\\"snek\\\")\"\n }\n ]\n },\n {\n \"line\": 5,\n \"segments\": []\n }\n ]\n }\n ],\n \"path_matches\": [\n {\n \"text\": \"src/\"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \".py\"\n }\n ],\n \"file\": {\n \"path\": \"src/foo.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n }\n }\n }\n ]\n}\n```\n\nNote that searches can match in the file's text (`content_matches`),\nthe path (`path_matches`), or both as in the example above.\n\nYou can use the same syntax for the search query as in the UI, e.g.\nto only search within a specific repository:\n\n```\ncurl 'https://api.bitbucket.org/2.0/workspaces/my-workspace/search/code?search_query=foo+repo:demo'\n# results from the \"demo\" repository\n```\n\nSimilar to other APIs, you can request more fields using a\n`fields` query parameter. E.g. to get some more information about\nthe repository of matched files (the `%2B` is a URL-encoded `+`):\n\n```\ncurl 'https://api.bitbucket.org/2.0/workspaces/my-workspace/search/code'\\\n '?search_query=foo&fields=%2Bvalues.file.commit.repository'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 1,\n \"content_matches\": [...],\n \"path_matches\": [...],\n \"file\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n }\n },\n \"repository\": {\n \"name\": \"demo\",\n \"type\": \"repository\",\n \"full_name\": \"my-workspace/demo\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default\"\n }\n },\n \"uuid\": \"{850e1749-781a-4115-9316-df39d0600e7a}\"\n }\n },\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n },\n \"path\": \"src/foo.py\"\n }\n }\n ]\n}\n```\n\nTry `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.\n","operationId":"searchWorkspace","parameters":[{"description":"The workspace to search in; either the slug or the UUID in curly braces","in":"path","name":"workspace","required":true,"schema":{"type":"string"}},{"description":"The search query","in":"query","name":"search_query","required":true,"schema":{"type":"string"}},{"description":"Which page of the search results to retrieve","in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","type":"integer"}},{"description":"How many search results to retrieve per page","in":"query","name":"pagelen","required":false,"schema":{"default":10,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_result_page"}}},"description":"Successful search"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"If the search request was invalid due to one of the\nfollowing reasons:\n\n* the specified type of target account doesn''t match the actual\naccount type;\n\n* malformed pagination properties;\n\n* missing or malformed search query, in the latter case an error\nkey will be returned in `error.data.key` property.\n"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Search is not enabled for the requested workspace, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Too many requests, try again later"}},"summary":"Search for code in a workspace","tags":["Search"]}}},"components":{"requestBodies":{"application_property":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_property"}}},"description":"The application property to create or update.","required":true},"pipeline_variable":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The updated variable.","required":true},"pipeline_variable2":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipeline_variable"}}},"description":"The variable to create."},"project":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project"}}},"required":true},"snippet":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/snippet"}}},"description":"The new snippet object.","required":true}},"schemas":{"account":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"An account object.","properties":{"created_on":{"format":"date-time","type":"string"},"display_name":{"type":"string"},"links":{"$ref":"#/components/schemas/account_links"},"username":{"pattern":"^[a-zA-Z0-9_\\-]+$","type":"string"},"uuid":{"type":"string"}},"title":"Account","type":"object"}]},"account_links":{"additionalProperties":true,"description":"Links related to an Account.","properties":{"avatar":{"$ref":"#/components/schemas/link"}},"title":"Account Links","type":"object"},"app_user":{"allOf":[{"$ref":"#/components/schemas/account"},{"additionalProperties":true,"description":"An app user object.","properties":{"account_id":{"description":"The user's Atlassian account ID.","type":"string"},"account_status":{"description":"The status of the account. Currently the only possible value is \"active\", but more values may be added in the future.","type":"string"},"kind":{"description":"The kind of App User.","type":"string"}},"title":"App User","type":"object"}]},"application_property":{"additionalProperties":true,"description":"An application property. It is a caller defined JSON object that Bitbucket will store and return. \nThe `_attributes` field at its top level can be used to control who is allowed to read and update the property. \nThe keys of the JSON object must match an allowed pattern. For details, \nsee [Application properties](/cloud/bitbucket/application-properties/).\n","properties":{"_attributes":{"items":{"enum":["public","read_only"],"type":"string"},"type":"array"}},"title":"Application Property","type":"object"},"author":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The author of a change in a repository","properties":{"raw":{"description":"The raw author value from the repository. This may be the only value available if the author does not match a user in Bitbucket.","type":"string"},"user":{"$ref":"#/components/schemas/account"}},"title":"Author","type":"object"}]},"base_commit":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The common base type for both repository and snippet commits.","properties":{"author":{"$ref":"#/components/schemas/author"},"date":{"format":"date-time","type":"string"},"hash":{"pattern":"[0-9a-f]{7,}?","type":"string"},"message":{"type":"string"},"parents":{"items":{"$ref":"#/components/schemas/base_commit"},"minItems":0,"type":"array"},"summary":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"}},"title":"Base Commit","type":"object"}]},"branch":{"allOf":[{"$ref":"#/components/schemas/ref"},{"additionalProperties":true,"description":"A branch object, representing a branch in a repository.","properties":{"default_merge_strategy":{"description":"The default merge strategy for pull requests targeting this branch.","type":"string"},"merge_strategies":{"description":"Available merge strategies for pull requests targeting this branch.","items":{"enum":["merge_commit","squash","fast_forward"],"type":"string"},"type":"array"}},"title":"Branch","type":"object"}]},"branching_model":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A repository's branching model","properties":{"branch_types":{"description":"The active branch types.","items":{"additionalProperties":false,"properties":{"kind":{"description":"The kind of branch.","enum":["feature","bugfix","release","hotfix"],"type":"string"},"prefix":{"description":"The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`.","type":"string"}},"required":["kind","prefix"],"type":"object"},"maxItems":4,"minItems":0,"type":"array","uniqueItems":true},"development":{"additionalProperties":false,"properties":{"branch":{"$ref":"#/components/schemas/branch"},"name":{"description":"Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`).","type":"boolean"}},"required":["name","use_mainbranch"],"type":"object"},"production":{"additionalProperties":false,"properties":{"branch":{"$ref":"#/components/schemas/branch"},"name":{"description":"Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`).","type":"boolean"}},"required":["name","use_mainbranch"],"type":"object"}},"title":"Branching Model","type":"object"}]},"branching_model_settings":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A repository's branching model settings","properties":{"branch_types":{"items":{"additionalProperties":false,"properties":{"enabled":{"description":"Whether the branch type is enabled or not. A disabled branch type may contain an invalid `prefix`.","type":"boolean"},"kind":{"description":"The kind of the branch type.","enum":["feature","bugfix","release","hotfix"],"type":"string"},"prefix":{"description":"The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The `prefix` of an enabled branch type must be a valid branch prefix.Additionally, it cannot be blank, empty or `null`. The `prefix` for a disabled branch type can be empty or invalid.","type":"string"}},"required":["kind"],"type":"object"},"maxItems":4,"minItems":0,"type":"array","uniqueItems":true},"development":{"additionalProperties":false,"properties":{"is_valid":{"description":"Indicates if the configured branch is valid, that is, if the configured branch actually exists currently. Is always `true` when `use_mainbranch` is `true` (even if the main branch does not exist). This field is read-only. This field is ignored when updating/creating settings.","type":"boolean"},"name":{"description":"The configured branch. It must be `null` when `use_mainbranch` is `true`. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set). In this case `is_valid` will be `false`. The branch must exist when updating/setting the `name` or an error will occur.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). When `true` the `name` must be `null` or not provided. When `false` the `name` must contain a non-empty branch name.","type":"boolean"}},"type":"object"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"production":{"additionalProperties":false,"properties":{"enabled":{"description":"Indicates if branch is enabled or not.","type":"boolean"},"is_valid":{"description":"Indicates if the configured branch is valid, that is, if the configured branch actually exists currently. Is always `true` when `use_mainbranch` is `true` (even if the main branch does not exist). This field is read-only. This field is ignored when updating/creating settings.","type":"boolean"},"name":{"description":"The configured branch. It must be `null` when `use_mainbranch` is `true`. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set). In this case `is_valid` will be `false`. The branch must exist when updating/setting the `name` or an error will occur.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). When `true` the `name` must be `null` or not provided. When `false` the `name` must contain a non-empty branch name.","type":"boolean"}},"type":"object"}},"title":"Branching Model Settings","type":"object"}]},"branchrestriction":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A branch restriction rule.","properties":{"groups":{"items":{"$ref":"#/components/schemas/group"},"minItems":0,"type":"array"},"users":{"items":{"$ref":"#/components/schemas/account"},"minItems":0,"type":"array"}},"title":"Branch Restriction","type":"object"}]},"comment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The base type for all comments. This type should be considered abstract. Each of the \"commentable\" resources defines its own subtypes (e.g. `issue_comment`).","properties":{"content":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"},"created_on":{"format":"date-time","type":"string"},"deleted":{"type":"boolean"},"id":{"type":"integer"},"inline":{"additionalProperties":false,"properties":{"from":{"description":"The comment's anchor line in the old version of the file.","minimum":1,"type":"integer"},"path":{"description":"The path of the file this comment is anchored to.","type":"string"},"to":{"description":"The comment's anchor line in the new version of the file. If the 'from' line is also provided, this value will be removed.","minimum":1,"type":"integer"}},"required":["path"],"type":"object"},"links":{"additionalProperties":false,"properties":{"code":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"parent":{"$ref":"#/components/schemas/comment"},"updated_on":{"format":"date-time","type":"string"},"user":{"$ref":"#/components/schemas/account"}},"title":"Comment","type":"object"}]},"comment_resolution":{"additionalProperties":true,"description":"The resolution object for a Comment.","properties":{"created_on":{"description":"The ISO8601 timestamp the resolution was created.","format":"date-time","type":"string"},"type":{"type":"string"},"user":{"$ref":"#/components/schemas/account"}},"required":["type"],"title":"Comment Resolution","type":"object"},"commit":{"allOf":[{"$ref":"#/components/schemas/base_commit"},{"additionalProperties":true,"description":"A repository commit object.","properties":{"participants":{"items":{"$ref":"#/components/schemas/participant"},"minItems":0,"type":"array"},"repository":{"$ref":"#/components/schemas/repository"}},"title":"Commit","type":"object"}]},"commit_comment":{"allOf":[{"$ref":"#/components/schemas/comment"},{"additionalProperties":true,"description":"A commit comment.","properties":{"commit":{"$ref":"#/components/schemas/commit"}},"title":"Commit Comment","type":"object"}]},"commit_file":{"additionalProperties":true,"description":"A file object, representing a file at a commit in a repository","properties":{"attributes":{"enum":["link","executable","subrepository","binary","lfs"],"type":"string"},"commit":{"$ref":"#/components/schemas/commit"},"escaped_path":{"description":"The escaped version of the path as it appears in a diff. If the path does not require escaping this will be the same as path.","type":"string"},"path":{"description":"The path in the repository","type":"string"},"type":{"type":"string"}},"required":["type"],"title":"Commit File","type":"object"},"commitstatus":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A commit status object.","properties":{"created_on":{"format":"date-time","type":"string"},"description":{"description":"A description of the build (e.g. \"Unit tests in Bamboo\")","type":"string"},"key":{"description":"An identifier for the status that's unique to\n its type (current \"build\" is the only supported type) and the vendor,\n e.g. BB-DEPLOY","type":"string"},"links":{"additionalProperties":false,"properties":{"commit":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"description":"An identifier for the build itself, e.g. BB-DEPLOY-1","type":"string"},"refname":{"description":"\nThe name of the ref that pointed to this commit at the time the status\nobject was created. Note that this the ref may since have moved off of\nthe commit. This optional field can be useful for build systems whose\nbuild triggers and configuration are branch-dependent (e.g. a Pipeline\nbuild).\nIt is legitimate for this field to not be set, or even apply (e.g. a\nstatic linting job).","type":"string"},"state":{"description":"Provides some indication of the status of this commit","enum":["INPROGRESS","SUCCESSFUL","FAILED","STOPPED"],"type":"string"},"updated_on":{"format":"date-time","type":"string"},"url":{"description":"A URL linking back to the vendor or build system, for providing more information about whatever process produced this status. Accepts context variables `repository` and `commit` that Bitbucket will evaluate at runtime whenever at runtime. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time.","type":"string"},"uuid":{"description":"The commit status' id.","type":"string"}},"title":"Commit Status","type":"object"}]},"component":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A component as defined in a repository's issue tracker.","properties":{"id":{"type":"integer"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"type":"string"}},"title":"Component","type":"object"}]},"ddev_report":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A report for a commit.","type":"object"}],"x-bb-default-fields":["uuid","commitHash"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commitHash}/reports/{uuid}"},"default_reviewer_and_type":{"additionalProperties":true,"description":"Object containing a user that is a default reviewer and the type of reviewer","properties":{"reviewer_type":{"type":"string"},"type":{"type":"string"},"user":{"$ref":"#/components/schemas/user"}},"required":["type"],"title":"Default Reviewer and Type","type":"object"},"deploy_key":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"Represents deploy key for a repository.","properties":{"added_on":{"format":"date-time","type":"string"},"comment":{"description":"The comment parsed from the deploy key (if present)","type":"string"},"key":{"description":"The deploy key value.","type":"string"},"label":{"description":"The user-defined label for the deploy key","type":"string"},"last_used":{"format":"date-time","type":"string"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"owner":{"$ref":"#/components/schemas/account"},"repository":{"$ref":"#/components/schemas/repository"}},"title":"Deploy Key","type":"object"}]},"deployment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment.","properties":{"environment":{"$ref":"#/components/schemas/deployment_environment"},"release":{"$ref":"#/components/schemas/deployment_release"},"state":{"$ref":"#/components/schemas/deployment_state"},"uuid":{"description":"The UUID identifying the deployment.","type":"string"}},"title":"Deployment","type":"object"}]},"deployment_environment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Environment.","properties":{"name":{"description":"The name of the environment.","type":"string"},"uuid":{"description":"The UUID identifying the environment.","type":"string"}},"title":"Deployment Environment","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments_batch","x-bb-default-fields":["uuid"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/{uuid}"},"deployment_environment_lock":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Environment Lock.","properties":{"environmentUuid":{"description":"The UUID identifying the environment.","type":"string"}},"title":"Deployment Environment Lock","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/locks_batch","x-bb-default-fields":["*","lock_opener.*","owner.*"]},"deployment_release":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Release.","properties":{"commit":{"$ref":"#/components/schemas/commit"},"created_on":{"description":"The timestamp when the release was created.","format":"date-time","type":"string"},"name":{"description":"The name of the release.","type":"string"},"url":{"description":"Link to the pipeline that produced the release.","format":"uri","type":"string"},"uuid":{"description":"The UUID identifying the release.","type":"string"}},"title":"Deployment Release","type":"object"}]},"deployment_state":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The representation of the progress state of a deployment.","properties":{},"title":"Deployment State","type":"object"}]},"deployment_state_completed":{"allOf":[{"$ref":"#/components/schemas/deployment_state"},{"additionalProperties":true,"description":"A Bitbucket Deployment COMPLETED deployment state.","properties":{"completion_date":{"description":"The timestamp when the deployment completed.","format":"date-time","type":"string"},"deployer":{"$ref":"#/components/schemas/account"},"name":{"description":"The name of deployment state (COMPLETED).","enum":["COMPLETED"],"type":"string"},"start_date":{"description":"The timestamp when the deployment was started.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/deployment_state_completed_status"},"url":{"description":"Link to the deployment result.","format":"uri","type":"string"}},"type":"object"}]},"deployment_state_completed_status":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The status of a completed deployment.","properties":{},"title":"Completed Deployment","type":"object"}]},"deployment_state_completed_status_failed":{"allOf":[{"$ref":"#/components/schemas/deployment_state_completed_status"},{"additionalProperties":true,"description":"A FAILED completed deployment status.","properties":{"name":{"description":"The name of the completed deployment status (FAILED).","enum":["FAILED"],"type":"string"}},"type":"object"}]},"deployment_state_completed_status_stopped":{"allOf":[{"$ref":"#/components/schemas/deployment_state_completed_status"},{"additionalProperties":true,"description":"A STOPPED completed deployment status.","properties":{"name":{"description":"The name of the completed deployment status (STOPPED).","enum":["STOPPED"],"type":"string"}},"type":"object"}]},"deployment_state_completed_status_successful":{"allOf":[{"$ref":"#/components/schemas/deployment_state_completed_status"},{"additionalProperties":true,"description":"A SUCCESSFUL completed deployment status.","properties":{"name":{"description":"The name of the completed deployment status (SUCCESSFUL).","enum":["SUCCESSFUL"],"type":"string"}},"type":"object"}]},"deployment_state_in_progress":{"allOf":[{"$ref":"#/components/schemas/deployment_state"},{"additionalProperties":true,"description":"A Bitbucket Deployment IN_PROGRESS deployment state.","properties":{"deployer":{"$ref":"#/components/schemas/account"},"name":{"description":"The name of deployment state (IN_PROGRESS).","enum":["IN_PROGRESS"],"type":"string"},"start_date":{"description":"The timestamp when the deployment was started.","format":"date-time","type":"string"},"url":{"description":"Link to the deployment result.","format":"uri","type":"string"}},"type":"object"}]},"deployment_state_undeployed":{"allOf":[{"$ref":"#/components/schemas/deployment_state"},{"additionalProperties":true,"description":"A Bitbucket Deployment UNDEPLOYED deployment state.","properties":{"name":{"description":"The name of deployment state (UNDEPLOYED).","enum":["UNDEPLOYED"],"type":"string"},"trigger_url":{"description":"Link to trigger the deployment.","format":"uri","type":"string"}},"type":"object"}]},"deployment_variable":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines deployment variable.","properties":{"key":{"description":"The unique name of the variable.","type":"string"},"secured":{"description":"If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.","type":"boolean"},"uuid":{"description":"The UUID identifying the variable.","type":"string"},"value":{"description":"The value of the variable. If the variable is secured, this will be empty.","type":"string"}},"title":"Deployment Variable","type":"object"}]},"deployments_ddev_deployment_environment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Environment.","properties":{"name":{"description":"The name of the environment.","type":"string"},"uuid":{"description":"The UUID identifying the environment.","type":"string"}},"title":"Deployment Environment","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments_batch","x-bb-default-fields":["uuid"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/{uuid}"},"deployments_ddev_deployment_environment_lock":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Environment Lock.","properties":{"environmentUuid":{"description":"The UUID identifying the environment.","type":"string"}},"title":"Deployment Environment Lock","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/locks_batch","x-bb-default-fields":["*","lock_opener.*","owner.*"]},"deployments_ddev_paginated_environments":{"description":"A paged list of environments","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/deployments_ddev_deployment_environment"},"minItems":0,"type":"array"}},"title":"Paginated Deployment Environments","type":"object"},"deployments_stg_west_deployment_environment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Environment.","properties":{"name":{"description":"The name of the environment.","type":"string"},"uuid":{"description":"The UUID identifying the environment.","type":"string"}},"title":"Deployment Environment","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments_batch","x-bb-default-fields":["uuid"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/{uuid}"},"deployments_stg_west_deployment_environment_lock":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Deployment Environment Lock.","properties":{"environmentUuid":{"description":"The UUID identifying the environment.","type":"string"}},"title":"Deployment Environment Lock","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/locks_batch","x-bb-default-fields":["*","lock_opener.*","owner.*"]},"deployments_stg_west_paginated_environments":{"description":"A paged list of environments","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/deployments_stg_west_deployment_environment"},"minItems":0,"type":"array"}},"title":"Paginated Deployment Environments","type":"object"},"diffstat":{"additionalProperties":true,"description":"A diffstat object that includes a summary of changes made to a file between two commits.","properties":{"lines_added":{"type":"integer"},"lines_removed":{"type":"integer"},"new":{"$ref":"#/components/schemas/commit_file"},"old":{"$ref":"#/components/schemas/commit_file"},"status":{"enum":["added","removed","modified","renamed"],"type":"string"},"type":{"type":"string"}},"required":["type"],"title":"Diff Stat","type":"object"},"effective_repo_branching_model":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A repository's effective branching model","properties":{"branch_types":{"description":"The active branch types.","items":{"additionalProperties":false,"properties":{"kind":{"description":"The kind of branch.","enum":["feature","bugfix","release","hotfix"],"type":"string"},"prefix":{"description":"The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`.","type":"string"}},"required":["kind","prefix"],"type":"object"},"maxItems":4,"minItems":0,"type":"array","uniqueItems":true},"development":{"additionalProperties":false,"properties":{"branch":{"$ref":"#/components/schemas/branch"},"name":{"description":"Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`).","type":"boolean"}},"required":["name","use_mainbranch"],"type":"object"},"production":{"additionalProperties":false,"properties":{"branch":{"$ref":"#/components/schemas/branch"},"name":{"description":"Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`).","type":"boolean"}},"required":["name","use_mainbranch"],"type":"object"}},"title":"Effective Repository Branching Model","type":"object"}]},"error":{"additionalProperties":true,"description":"Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.","properties":{"error":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Optional structured data that is endpoint-specific.","properties":{},"type":"object"},"detail":{"type":"string"},"message":{"type":"string"}},"required":["message"],"type":"object"},"type":{"type":"string"}},"required":["type"],"title":"Error","type":"object"},"export_options":{"additionalProperties":true,"description":"Options for issue export.","properties":{"include_attachments":{"type":"boolean"},"project_key":{"type":"string"},"project_name":{"type":"string"},"send_email":{"type":"boolean"},"type":{"type":"string"}},"required":["type"],"title":"Export Options","type":"object"},"group":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A group object","properties":{"full_slug":{"description":"The concatenation of the workspace's slug and the group's slug,\nseparated with a colon (e.g. `acme:developers`)\n","type":"string"},"links":{"additionalProperties":false,"properties":{"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/account"},"slug":{"description":"The \"sluggified\" version of the group's name. This contains only ASCII\ncharacters and can therefore be slightly different than the name","type":"string"},"workspace":{"$ref":"#/components/schemas/workspace"}},"title":"Group","type":"object"}]},"hook_event":{"additionalProperties":false,"description":"An event, associated with a resource or subject type.","properties":{"category":{"description":"The category this event belongs to.","type":"string"},"description":{"description":"More detailed description of the webhook event type.","type":"string"},"event":{"description":"The event identifier.","enum":["pullrequest:changes_request_removed","issue:comment_created","repo:push","repo:commit_status_updated","repo:imported","pullrequest:unapproved","repo:updated","pullrequest:rejected","pullrequest:fulfilled","pullrequest:created","pullrequest:approved","repo:transfer","repo:commit_status_created","repo:fork","issue:updated","project:updated","repo:created","issue:created","repo:commit_comment_created","pullrequest:updated","repo:deleted","pullrequest:comment_updated","pullrequest:changes_request_created","pullrequest:comment_deleted","pullrequest:comment_created"],"type":"string"},"label":{"description":"Summary of the webhook event type.","type":"string"}},"title":"Hook Event","type":"object"},"issue":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"An issue.","properties":{"assignee":{"$ref":"#/components/schemas/account"},"component":{"$ref":"#/components/schemas/component"},"content":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"},"created_on":{"format":"date-time","type":"string"},"edited_on":{"format":"date-time","type":"string"},"id":{"type":"integer"},"kind":{"enum":["bug","enhancement","proposal","task"],"type":"string"},"links":{"additionalProperties":false,"properties":{"attachments":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"comments":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"vote":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"watch":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"milestone":{"$ref":"#/components/schemas/milestone"},"priority":{"enum":["trivial","minor","major","critical","blocker"],"type":"string"},"reporter":{"$ref":"#/components/schemas/account"},"repository":{"$ref":"#/components/schemas/repository"},"state":{"enum":["submitted","new","open","resolved","on hold","invalid","duplicate","wontfix","closed"],"type":"string"},"title":{"type":"string"},"updated_on":{"format":"date-time","type":"string"},"version":{"$ref":"#/components/schemas/version"},"votes":{"type":"integer"}},"title":"Issue","type":"object"}]},"issue_attachment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"An issue file attachment's meta data. Note this does not contain the file's actual contents.","properties":{"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"type":"string"}},"title":"Issue Attachment","type":"object"}]},"issue_change":{"additionalProperties":true,"description":"An issue change.","properties":{"changes":{"additionalProperties":false,"properties":{"assignee":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"component":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"content":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"kind":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"milestone":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"priority":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"state":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"title":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"},"version":{"additionalProperties":false,"properties":{"new":{"type":"string"},"old":{"type":"string"}},"type":"object"}},"type":"object"},"created_on":{"format":"date-time","type":"string"},"issue":{"$ref":"#/components/schemas/issue"},"links":{"additionalProperties":false,"properties":{"issue":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"message":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"},"name":{"type":"string"},"type":{"type":"string"},"user":{"$ref":"#/components/schemas/account"}},"required":["type"],"title":"Issue Change","type":"object"},"issue_comment":{"allOf":[{"$ref":"#/components/schemas/comment"},{"additionalProperties":true,"description":"A issue comment.","properties":{"issue":{"$ref":"#/components/schemas/issue"}},"title":"Issue Comment","type":"object"}]},"issue_job_status":{"additionalProperties":false,"description":"The status of an import or export job","properties":{"count":{"description":"The total number of issues already imported/exported","type":"integer"},"pct":{"description":"The percentage of issues already imported/exported","maximum":100,"minimum":0,"type":"number"},"phase":{"description":"The phase of the import/export job","type":"string"},"status":{"description":"The status of the import/export job","enum":["ACCEPTED","STARTED","RUNNING","FAILURE"],"type":"string"},"total":{"description":"The total number of issues being imported/exported","type":"integer"},"type":{"type":"string"}},"title":"Issue Job Status","type":"object"},"jira_project":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Jira Project.","type":"object"}],"x-bb-default-fields":["type","cloudId","id"],"x-bb-detail-fields":["key","name","url","avatarUrls.*","site"],"x-bb-url":"/api/{target_user.uuid}/jira/sites/{cloudId}/projects/{id}?atlassian_account_id={user.account_id}"},"jira_site":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Jira Site.","type":"object"}],"x-bb-default-fields":["type","cloudId","cloudUrl","cloudName"],"x-bb-detail-fields":["connected"],"x-bb-url":"/api/{target_user.uuid}/jira/sites/{cloudId}?atlassian_account_id={user.account_id}"},"link":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"milestone":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A milestone as defined in a repository's issue tracker.","properties":{"id":{"type":"integer"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"type":"string"}},"title":"Milestone","type":"object"}]},"object":{"additionalProperties":true,"description":"Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"page":{"additionalProperties":false,"properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"}},"title":"Page","type":"object"},"paginated_accounts":{"additionalProperties":false,"description":"A paginated list of accounts.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/account"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Accounts","type":"object"},"paginated_annotations":{"description":"A paginated list of annotations.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/report_annotation"},"minItems":0,"type":"array"}},"title":"Paginated Annotations","type":"object"},"paginated_branches":{"additionalProperties":false,"description":"A paginated list of branches.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/branch"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Branches","type":"object"},"paginated_branchrestrictions":{"additionalProperties":false,"description":"A paginated list of branch restriction rules.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/branchrestriction"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Branch Restrictions","type":"object"},"paginated_changeset":{"additionalProperties":false,"description":"A paginated list of commits.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/base_commit"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Page","type":"object"},"paginated_commit_comments":{"additionalProperties":false,"description":"A paginated list of commit comments.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/commit_comment"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Commit Comments","type":"object"},"paginated_commitstatuses":{"additionalProperties":false,"description":"A paginated list of commit status objects.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/commitstatus"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Commit Statuses","type":"object"},"paginated_components":{"additionalProperties":false,"description":"A paginated list of issue tracker components.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/component"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Components","type":"object"},"paginated_default_reviewer_and_type":{"additionalProperties":false,"description":"A paginated list of default reviewers with reviewer type.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/default_reviewer_and_type"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Default Reviewer and Type","type":"object"},"paginated_deploy_keys":{"additionalProperties":false,"description":"A paginated list of deploy keys.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/deploy_key"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Deploy Keys","type":"object"},"paginated_deployment_variable":{"description":"A paged list of deployment variables.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/deployment_variable"},"minItems":0,"type":"array"}},"title":"Paginated Deployment Variables","type":"object"},"paginated_deployments":{"description":"A paged list of deployments","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/deployment"},"minItems":0,"type":"array"}},"title":"Paginated Deployments","type":"object"},"paginated_diffstats":{"additionalProperties":false,"description":"A paginated list of diffstats.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 500 with 5000 being the maximum allowed value.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/diffstat"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Diff Stat","type":"object"},"paginated_environments":{"description":"A paged list of environments","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/deployment_environment"},"minItems":0,"type":"array"}},"title":"Paginated Deployment Environments","type":"object"},"paginated_files":{"additionalProperties":false,"description":"A paginated list of commit_file objects.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/commit_file"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Files","type":"object"},"paginated_hook_events":{"additionalProperties":false,"description":"A paginated list of webhook types available to subscribe on.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/hook_event"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Hook Events","type":"object"},"paginated_issue_attachments":{"additionalProperties":false,"description":"A paginated list of issue attachments.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/issue_attachment"},"minItems":0,"type":"array"}},"title":"Paginated Issue Attachment","type":"object"},"paginated_issue_comments":{"additionalProperties":false,"description":"A paginated list of issue comments.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/issue_comment"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Issue Comments","type":"object"},"paginated_issues":{"additionalProperties":false,"description":"A paginated list of issues.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/issue"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Issues","type":"object"},"paginated_log_entries":{"additionalProperties":false,"description":"A paginated list of issue changes.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/issue_change"},"minItems":0,"type":"array"}},"title":"Paginated Log Entries","type":"object"},"paginated_milestones":{"additionalProperties":false,"description":"A paginated list of issue tracker milestones.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/milestone"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Milestones","type":"object"},"paginated_pipeline_caches":{"description":"A paged list of pipeline caches","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline_cache"},"minItems":0,"type":"array"}},"title":"Paginated Pipeline Cache","type":"object"},"paginated_pipeline_known_hosts":{"description":"A paged list of known hosts.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline_known_host"},"minItems":0,"type":"array"}},"title":"Paginated Pipeline Known Hosts","type":"object"},"paginated_pipeline_schedule_executions":{"description":"A paged list of the executions of a schedule.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline_schedule_execution"},"minItems":0,"type":"array"}},"title":"Paginated Pipeline Schedule Executions","type":"object"},"paginated_pipeline_schedules":{"description":"A paged list of schedules","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline_schedule"},"minItems":0,"type":"array"}},"title":"Paginated Pipeline Schedule","type":"object"},"paginated_pipeline_steps":{"description":"A paged list of pipeline steps.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline_step"},"minItems":0,"type":"array"}},"title":"Paginated Pipeline Steps","type":"object"},"paginated_pipeline_variables":{"description":"A paged list of variables.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline_variable"},"minItems":0,"type":"array"}},"title":"Paginated Pipeline Variables","type":"object"},"paginated_pipelines":{"description":"A paged list of pipelines","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/pipeline"},"minItems":0,"type":"array"}},"title":"Paginated Pipelines","type":"object"},"paginated_project_deploy_keys":{"additionalProperties":false,"description":"A paginated list of project deploy keys.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/project_deploy_key"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Project Deploy Keys","type":"object"},"paginated_projects":{"additionalProperties":false,"description":"A paginated list of projects","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/project"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Projects","type":"object"},"paginated_pullrequest_comments":{"additionalProperties":false,"description":"A paginated list of pullrequest comments.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/pullrequest_comment"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Pull Request Comments","type":"object"},"paginated_pullrequests":{"additionalProperties":false,"description":"A paginated list of pullrequests.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/pullrequest"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Pull Requests","type":"object"},"paginated_refs":{"additionalProperties":false,"description":"A paginated list of refs.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/ref"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Refs","type":"object"},"paginated_reports":{"description":"A paginated list of reports.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","type":"integer"},"values":{"description":"The values of the current page.","items":{"$ref":"#/components/schemas/report"},"minItems":0,"type":"array"}},"title":"Paginated Reports","type":"object"},"paginated_repositories":{"additionalProperties":false,"description":"A paginated list of repositories.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/repository"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Repositories","type":"object"},"paginated_repository_group_permissions":{"additionalProperties":false,"description":"A paginated list of repository group permissions.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/repository_group_permission"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Repository Group Permissions","type":"object"},"paginated_repository_permissions":{"additionalProperties":false,"description":"A paginated list of repository permissions.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/repository_permission"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Repository Permissions","type":"object"},"paginated_repository_user_permissions":{"additionalProperties":false,"description":"A paginated list of repository user permissions.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/repository_user_permission"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Repository User Permissions","type":"object"},"paginated_snippet_comments":{"additionalProperties":false,"description":"A paginated list of snippet comments.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/snippet_comment"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Snippet Comments","type":"object"},"paginated_snippet_commit":{"additionalProperties":false,"description":"A paginated list of snippet commits.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/snippet_commit"},"minItems":0,"type":"array"}},"title":"Paginated Snippet Commits","type":"object"},"paginated_snippets":{"additionalProperties":false,"description":"A paginated list of snippets.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/snippet"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Snippets","type":"object"},"paginated_ssh_user_keys":{"additionalProperties":false,"description":"A paginated list of SSH keys.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/ssh_account_key"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated SSH User Keys","type":"object"},"paginated_tags":{"additionalProperties":false,"description":"A paginated list of tags.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/tag"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Tags","type":"object"},"paginated_treeentries":{"additionalProperties":false,"description":"A paginated list of commit_file and/or commit_directory objects.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/treeentry"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Tree Entry","type":"object"},"paginated_versions":{"additionalProperties":false,"description":"A paginated list of issue tracker versions.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/version"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Versions","type":"object"},"paginated_webhook_subscriptions":{"additionalProperties":false,"description":"A paginated list of webhook subscriptions","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/webhook_subscription"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Webhook Subscriptions","type":"object"},"paginated_workspace_memberships":{"additionalProperties":false,"description":"A paginated list of workspace memberships.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/workspace_membership"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Workspace Memberships","type":"object"},"paginated_workspaces":{"additionalProperties":false,"description":"A paginated list of workspaces.","properties":{"next":{"description":"Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"page":{"description":"Page number of the current results. This is an optional element that is not provided in all responses.","minimum":1,"type":"integer"},"pagelen":{"description":"Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.","minimum":1,"type":"integer"},"previous":{"description":"Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.","format":"uri","type":"string"},"size":{"description":"Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.","minimum":0,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/workspace"},"minItems":0,"type":"array","uniqueItems":true}},"title":"Paginated Workspaces","type":"object"},"participant":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"Object describing a user's role on resources like commits or pull requests.","properties":{"approved":{"type":"boolean"},"participated_on":{"description":"The ISO8601 timestamp of the participant's action. For approvers, this is the time of their approval. For commenters and pull request reviewers who are not approvers, this is the time they last commented, or null if they have not commented.","format":"date-time","type":"string"},"role":{"enum":["PARTICIPANT","REVIEWER"],"type":"string"},"state":{"enum":["approved","changes_requested",null],"type":"string"},"user":{"$ref":"#/components/schemas/account"}},"title":"Participant","type":"object"}]},"pipeline":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket Pipeline. This represents an actual pipeline result.","properties":{"build_number":{"description":"The build number of the pipeline.","type":"integer"},"build_seconds_used":{"description":"The number of build seconds used by this pipeline.","type":"integer"},"completed_on":{"description":"The timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress.","format":"date-time","type":"string"},"created_on":{"description":"The timestamp when the pipeline was created.","format":"date-time","type":"string"},"creator":{"$ref":"#/components/schemas/account"},"repository":{"$ref":"#/components/schemas/repository"},"state":{"$ref":"#/components/schemas/pipeline_state"},"target":{"$ref":"#/components/schemas/pipeline_target"},"trigger":{"$ref":"#/components/schemas/pipeline_trigger"},"uuid":{"description":"The UUID identifying the pipeline.","type":"string"}},"title":"Pipeline","type":"object"}]},"pipeline_build_number":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines build number.","properties":{"next":{"description":"The next number that will be used as build number.","type":"integer"}},"title":"Pipeline Build Number","type":"object"}]},"pipeline_cache":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A representation of metadata for a pipeline cache for given repository.","properties":{"created_on":{"description":"The timestamp when the cache was created.","format":"date-time","type":"string"},"file_size_bytes":{"description":"The size of the file containing the archive of the cache.","type":"integer"},"key_hash":{"description":"The key hash of the cache version.","type":"string"},"name":{"description":"The name of the cache.","type":"string"},"path":{"description":"The path where the cache contents were retrieved from.","type":"string"},"pipeline_uuid":{"description":"The UUID of the pipeline that created the cache.","type":"string"},"step_uuid":{"description":"The uuid of the step that created the cache.","type":"string"},"uuid":{"description":"The UUID identifying the pipeline cache.","type":"string"}},"title":"Pipeline Cache","type":"object"}]},"pipeline_cache_content_uri":{"description":"A representation of the location of pipeline cache content.","properties":{"uri":{"description":"The uri for pipeline cache content.","format":"uri","type":"string"}},"title":"Pipeline Cache Content URI","type":"object"},"pipeline_command":{"description":"An executable pipeline command.","properties":{"command":{"description":"The executable command.","type":"string"},"name":{"description":"The name of the command.","type":"string"}},"title":"Pipeline Command","type":"object"},"pipeline_commit_target":{"allOf":[{"$ref":"#/components/schemas/pipeline_target"},{"additionalProperties":true,"description":"A Bitbucket Pipelines commit target.","properties":{"commit":{"$ref":"#/components/schemas/commit"},"selector":{"$ref":"#/components/schemas/pipeline_selector"}},"title":"Pipeline Commit Target","type":"object"}]},"pipeline_error":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"An error causing a pipeline failure.","properties":{"key":{"description":"The error key.","type":"string"},"message":{"description":"The error message.","type":"string"}},"title":"Pipeline Error","type":"object"}]},"pipeline_image":{"description":"The definition of a Docker image that can be used for a Bitbucket Pipelines step execution context.","properties":{"email":{"description":"The email needed to authenticate with the Docker registry. Only required when using a private Docker image.","type":"string"},"name":{"description":"The name of the image. If the image is hosted on DockerHub the short name can be used, otherwise the fully qualified name is required here.","type":"string"},"password":{"description":"The password needed to authenticate with the Docker registry. Only required when using a private Docker image.","type":"string"},"username":{"description":"The username needed to authenticate with the Docker registry. Only required when using a private Docker image.","type":"string"}},"title":"Pipeline Image","type":"object"},"pipeline_known_host":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines known host.","properties":{"hostname":{"description":"The hostname of the known host.","type":"string"},"public_key":{"$ref":"#/components/schemas/pipeline_ssh_public_key"},"uuid":{"description":"The UUID identifying the known host.","type":"string"}},"title":"Pipeline Known Host","type":"object"}]},"pipeline_ref_target":{"allOf":[{"$ref":"#/components/schemas/pipeline_target"},{"additionalProperties":true,"description":"A Bitbucket Pipelines reference target.","properties":{"commit":{"$ref":"#/components/schemas/commit"},"ref_name":{"description":"The name of the reference.","type":"string"},"ref_type":{"description":"The type of reference (branch/tag).","enum":["branch","tag","named_branch","bookmark"],"type":"string"},"selector":{"$ref":"#/components/schemas/pipeline_selector"}},"title":"Pipeline Ref Target","type":"object"}]},"pipeline_schedule":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines schedule.","properties":{"created_on":{"description":"The timestamp when the schedule was created.","format":"date-time","type":"string"},"cron_pattern":{"description":"The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day.","type":"string"},"enabled":{"description":"Whether the schedule is enabled.","type":"boolean"},"target":{"$ref":"#/components/schemas/pipeline_ref_target"},"updated_on":{"description":"The timestamp when the schedule was updated.","format":"date-time","type":"string"},"uuid":{"description":"The UUID identifying the schedule.","type":"string"}},"title":"Pipeline Schedule","type":"object"}]},"pipeline_schedule_execution":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines schedule execution.","properties":{},"title":"Pipeline Schedule Execution","type":"object"}]},"pipeline_schedule_execution_errored":{"allOf":[{"$ref":"#/components/schemas/pipeline_schedule_execution"},{"additionalProperties":true,"description":"A Pipelines schedule execution that failed to be executed.","properties":{"error":{"$ref":"#/components/schemas/pipeline_error"}},"type":"object"}]},"pipeline_schedule_execution_executed":{"allOf":[{"$ref":"#/components/schemas/pipeline_schedule_execution"},{"additionalProperties":true,"description":"A Pipelines executed schedule execution.","properties":{"pipeline":{"$ref":"#/components/schemas/pipeline"}},"type":"object"}]},"pipeline_schedule_post_request_body":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"properties":{"cron_pattern":{"description":"The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day.","type":"string"},"enabled":{"description":"Whether the schedule is enabled.","type":"boolean"},"target":{"description":"The target on which the schedule will be executed.","properties":{"ref_name":{"description":"The name of the reference.","type":"string"},"ref_type":{"description":"The type of reference (branch only).","enum":["branch"],"type":"string"},"selector":{"$ref":"#/components/schemas/pipeline_selector"}},"required":["selector","ref_name","ref_type"],"type":"object"}},"required":["target","cron_pattern"],"title":"Request body for Pipeline Schedule POST request","type":"object"}]},"pipeline_schedule_put_request_body":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"properties":{"enabled":{"description":"Whether the schedule is enabled.","type":"boolean"}},"title":"Request body for Pipeline Schedule PUT request","type":"object"}]},"pipeline_selector":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A representation of the selector that was used to identify the pipeline in the YML file.","properties":{"pattern":{"description":"The name of the matching pipeline definition.","type":"string"},"type":{"description":"The type of selector.","enum":["branches","tags","bookmarks","default","custom"],"type":"string"}},"title":"Pipeline Selector","type":"object"}]},"pipeline_ssh_key_pair":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines SSH key pair.","properties":{"private_key":{"description":"The SSH private key. This value will be empty when retrieving the SSH key pair.","type":"string"},"public_key":{"description":"The SSH public key.","type":"string"}},"title":"Pipeline SSH Key Pair","type":"object"}]},"pipeline_ssh_public_key":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines known host public key.","properties":{"key":{"description":"The base64 encoded public key.","type":"string"},"key_type":{"description":"The type of the public key.","type":"string"},"md5_fingerprint":{"description":"The MD5 fingerprint of the public key.","type":"string"},"sha256_fingerprint":{"description":"The SHA-256 fingerprint of the public key.","type":"string"}},"title":"Pipeline SSH Public Key","type":"object"}]},"pipeline_state":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The representation of the progress state of a pipeline.","properties":{},"title":"Pipeline State","type":"object"}]},"pipeline_state_completed":{"allOf":[{"$ref":"#/components/schemas/pipeline_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines COMPLETED pipeline state.","properties":{"name":{"description":"The name of pipeline state (COMPLETED).","enum":["COMPLETED"],"type":"string"},"result":{"$ref":"#/components/schemas/pipeline_state_completed_result"}},"title":"Pipeline Completed State","type":"object"}]},"pipeline_state_completed_error":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines ERROR pipeline result.","properties":{"error":{"$ref":"#/components/schemas/pipeline_error"},"name":{"description":"The name of the result (ERROR)","enum":["ERROR"],"type":"string"}},"title":"Pipeline Completed Error","type":"object"}]},"pipeline_state_completed_expired":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines EXPIRED pipeline result.","properties":{"name":{"description":"The name of the stopped result (EXPIRED).","enum":["EXPIRED"],"type":"string"}},"type":"object"}]},"pipeline_state_completed_failed":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines FAILED pipeline result.","properties":{"name":{"description":"The name of the failed result (FAILED).","enum":["FAILED"],"type":"string"}},"type":"object"}]},"pipeline_state_completed_result":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A result of a completed pipeline state.","properties":{},"title":"Pipeline Completed Result","type":"object"}]},"pipeline_state_completed_stopped":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines STOPPED pipeline result.","properties":{"name":{"description":"The name of the stopped result (STOPPED).","enum":["STOPPED"],"type":"string"}},"type":"object"}]},"pipeline_state_completed_successful":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines SUCCESSFUL pipeline result.","properties":{"name":{"description":"The name of the successful result (SUCCESSFUL).","enum":["SUCCESSFUL"],"type":"string"}},"type":"object"}]},"pipeline_state_in_progress":{"allOf":[{"$ref":"#/components/schemas/pipeline_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines IN_PROGRESS pipeline state.","properties":{"name":{"description":"The name of pipeline state (IN_PROGRESS).","enum":["IN_PROGRESS"],"type":"string"},"stage":{"$ref":"#/components/schemas/pipeline_state_in_progress_stage"}},"title":"Pipeline In-Progress State","type":"object"}]},"pipeline_state_in_progress_paused":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_in_progress_stage"},{"additionalProperties":true,"description":"A Bitbucket Pipelines PAUSED stage of a pipeline that is in progress.","properties":{"name":{"description":"The name of the stage (PAUSED)","enum":["PAUSED"],"type":"string"}},"type":"object"}]},"pipeline_state_in_progress_running":{"allOf":[{"$ref":"#/components/schemas/pipeline_state_in_progress_stage"},{"additionalProperties":true,"description":"A Bitbucket Pipelines RUNNING stage of a pipeline that is in progress.","properties":{"name":{"description":"The name of the stage (RUNNING)","enum":["RUNNING"],"type":"string"}},"type":"object"}]},"pipeline_state_in_progress_stage":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A result of an in progress pipeline state.","properties":{},"title":"Pipeline In-Progress Stage","type":"object"}]},"pipeline_state_pending":{"allOf":[{"$ref":"#/components/schemas/pipeline_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines PENDING pipeline state.","properties":{"name":{"description":"The name of pipeline state (PENDING).","enum":["PENDING"],"type":"string"}},"title":"Pipeline Pending State","type":"object"}]},"pipeline_step":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A step of a Bitbucket pipeline. This represents the actual result of the step execution.","properties":{"completed_on":{"description":"The timestamp when the step execution was completed. This is not set if the step is still in progress.","format":"date-time","type":"string"},"image":{"$ref":"#/components/schemas/pipeline_image"},"script_commands":{"description":"The list of build commands. These commands are executed in the build container.","items":{"$ref":"#/components/schemas/pipeline_command"},"type":"array"},"setup_commands":{"description":"The list of commands that are executed as part of the setup phase of the build. These commands are executed outside the build container.","items":{"$ref":"#/components/schemas/pipeline_command"},"type":"array"},"started_on":{"description":"The timestamp when the step execution was started. This is not set when the step hasn't executed yet.","format":"date-time","type":"string"},"state":{"$ref":"#/components/schemas/pipeline_step_state"},"uuid":{"description":"The UUID identifying the step.","type":"string"}},"title":"Pipeline Step","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/steps_batch","x-bb-default-fields":["uuid"],"x-bb-url":"/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}"},"pipeline_step_error":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"An error causing a step failure.","properties":{"key":{"description":"The error key.","type":"string"},"message":{"description":"The error message.","type":"string"}},"title":"Pipeline Step Error","type":"object"}]},"pipeline_step_state":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The representation of the progress state of a pipeline step.","properties":{},"title":"Pipeline Step State","type":"object"}]},"pipeline_step_state_completed":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines COMPLETED pipeline step state.","properties":{"name":{"description":"The name of pipeline step state (COMPLETED).","enum":["COMPLETED"],"type":"string"},"result":{"$ref":"#/components/schemas/pipeline_step_state_completed_result"}},"type":"object"}]},"pipeline_step_state_completed_error":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines ERROR pipeline step result.","properties":{"error":{"$ref":"#/components/schemas/pipeline_step_error"},"name":{"description":"The name of the result (ERROR)","enum":["ERROR"],"type":"string"}},"type":"object"}]},"pipeline_step_state_completed_expired":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines EXPIRED pipeline step result.","properties":{"name":{"description":"The name of the result (EXPIRED)","enum":["EXPIRED"],"type":"string"}},"type":"object"}]},"pipeline_step_state_completed_failed":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines FAILED pipeline step result.","properties":{"name":{"description":"The name of the result (FAILED)","enum":["FAILED"],"type":"string"}},"type":"object"}]},"pipeline_step_state_completed_not_run":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines NOT_RUN pipeline step result.","properties":{"name":{"description":"The name of the result (NOT_RUN)","enum":["NOT_RUN"],"type":"string"}},"type":"object"}]},"pipeline_step_state_completed_result":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A result of a completed pipeline step state.","properties":{},"title":"Pipeline Completed Step Result","type":"object"}]},"pipeline_step_state_completed_stopped":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines STOPPED pipeline step result.","properties":{"name":{"description":"The name of the result (STOPPED)","enum":["STOPPED"],"type":"string"}},"type":"object"}]},"pipeline_step_state_completed_successful":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state_completed_result"},{"additionalProperties":true,"description":"A Bitbucket Pipelines SUCCESSFUL pipeline step result.","properties":{"name":{"description":"The name of the result (SUCCESSFUL)","enum":["SUCCESSFUL"],"type":"string"}},"type":"object"}]},"pipeline_step_state_in_progress":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines IN_PROGRESS pipeline step state.","properties":{"name":{"description":"The name of pipeline step state (IN_PROGRESS).","enum":["IN_PROGRESS"],"type":"string"}},"type":"object"}]},"pipeline_step_state_pending":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines PENDING pipeline step state.","properties":{"name":{"description":"The name of pipeline step state (PENDING).","enum":["PENDING"],"type":"string"}},"type":"object"}]},"pipeline_step_state_ready":{"allOf":[{"$ref":"#/components/schemas/pipeline_step_state"},{"additionalProperties":true,"description":"A Bitbucket Pipelines READY pipeline step state.","properties":{"name":{"description":"The name of pipeline step state (READY).","enum":["READY"],"type":"string"}},"type":"object"}]},"pipeline_target":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A representation of the target that a pipeline executes on.","properties":{},"title":"Pipeline Target","type":"object"}]},"pipeline_trigger":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A representation of the trigger used for a pipeline.","properties":{},"title":"Pipeline Trigger","type":"object"}]},"pipeline_trigger_manual":{"allOf":[{"$ref":"#/components/schemas/pipeline_trigger"},{"additionalProperties":true,"description":"A Bitbucket Pipelines MANUAL trigger.","properties":{},"title":"Pipeline Manual Trigger","type":"object"}]},"pipeline_trigger_push":{"allOf":[{"$ref":"#/components/schemas/pipeline_trigger"},{"additionalProperties":true,"description":"A Bitbucket Pipelines PUSH trigger.","properties":{},"title":"Pipeline Push Trigger","type":"object"}]},"pipeline_variable":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Pipelines variable.","properties":{"key":{"description":"The unique name of the variable.","type":"string"},"secured":{"description":"If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.","type":"boolean"},"uuid":{"description":"The UUID identifying the variable.","type":"string"},"value":{"description":"The value of the variable. If the variable is secured, this will be empty.","type":"string"}},"title":"Pipeline Variable","type":"object"}]},"pipelines_config":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"The Pipelines configuration for a repository.","properties":{"enabled":{"description":"Whether Pipelines is enabled for the repository.","type":"boolean"},"repository":{"$ref":"#/components/schemas/repository"}},"title":"Pipelines Configuration","type":"object"}]},"pipelines_ddev_pipeline_step":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A step of a Bitbucket pipeline. This represents the actual result of the step execution.","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/steps_batch","x-bb-default-fields":["uuid"],"x-bb-url":"/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}"},"pipelines_stg_west_pipeline_step":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A step of a Bitbucket pipeline. This represents the actual result of the step execution.","type":"object"}],"x-bb-batch-max-size":100,"x-bb-batch-url":"/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/steps_batch","x-bb-default-fields":["uuid"],"x-bb-url":"/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}"},"project":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket project.\n Projects are used by teams to organize repositories.","properties":{"created_on":{"format":"date-time","type":"string"},"description":{"type":"string"},"has_publicly_visible_repos":{"description":"\nIndicates whether the project contains publicly visible repositories.\nNote that private projects cannot contain public repositories.","type":"boolean"},"is_private":{"description":"\nIndicates whether the project is publicly accessible, or whether it is\nprivate to the team and consequently only visible to team members.\nNote that private projects cannot contain public repositories.","type":"boolean"},"key":{"description":"The project's key.","type":"string"},"links":{"additionalProperties":false,"properties":{"avatar":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"description":"The name of the project.","type":"string"},"owner":{"$ref":"#/components/schemas/team"},"updated_on":{"format":"date-time","type":"string"},"uuid":{"description":"The project's immutable id.","type":"string"}},"title":"Project","type":"object"}]},"project_branching_model":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A project's branching model","properties":{"branch_types":{"description":"The active branch types.","items":{"additionalProperties":false,"properties":{"kind":{"description":"The kind of branch.","enum":["feature","bugfix","release","hotfix"],"type":"string"},"prefix":{"description":"The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`.","type":"string"}},"required":["kind","prefix"],"type":"object"},"maxItems":4,"minItems":0,"type":"array","uniqueItems":true},"development":{"additionalProperties":false,"properties":{"name":{"description":"Name of the target branch. If inherited by a repository, it will default to the main branch if the specified branch does not exist.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`).","type":"boolean"}},"required":["name","use_mainbranch"],"type":"object"},"production":{"additionalProperties":false,"properties":{"name":{"description":"Name of the target branch. If inherited by a repository, it will default to the main branch if the specified branch does not exist.","type":"string"},"use_mainbranch":{"description":"Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`).","type":"boolean"}},"required":["name","use_mainbranch"],"type":"object"}},"title":"Project Branching Model","type":"object"}]},"project_deploy_key":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"Represents deploy key for a project.","properties":{"added_on":{"format":"date-time","type":"string"},"comment":{"description":"The comment parsed from the deploy key (if present)","type":"string"},"created_by":{"$ref":"#/components/schemas/account"},"key":{"description":"The deploy key value.","type":"string"},"label":{"description":"The user-defined label for the deploy key","type":"string"},"last_used":{"format":"date-time","type":"string"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"project":{"$ref":"#/components/schemas/project"}},"title":"Project Deploy Key","type":"object"}]},"pullrequest":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A pull request object.","properties":{"author":{"$ref":"#/components/schemas/account"},"close_source_branch":{"description":"A boolean flag indicating if merging the pull request closes the source branch.","type":"boolean"},"closed_by":{"$ref":"#/components/schemas/account"},"comment_count":{"description":"The number of comments for a specific pull request.","minimum":0,"type":"integer"},"created_on":{"description":"The ISO8601 timestamp the request was created.","format":"date-time","type":"string"},"destination":{"$ref":"#/components/schemas/pullrequest_endpoint"},"id":{"description":"The pull request's unique ID. Note that pull request IDs are only unique within their associated repository.","type":"integer"},"links":{"additionalProperties":false,"properties":{"activity":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"approve":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"comments":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"commits":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"decline":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"diff":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"diffstat":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"merge":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"merge_commit":{"additionalProperties":false,"properties":{"hash":{"pattern":"[0-9a-f]{7,}?","type":"string"}},"title":"Pull Request Commit","type":"object"},"participants":{"description":" The list of users that are collaborating on this pull request.\n Collaborators are user that:\n\n * are added to the pull request as a reviewer (part of the reviewers\n list)\n * are not explicit reviewers, but have commented on the pull request\n * are not explicit reviewers, but have approved the pull request\n\n Each user is wrapped in an object that indicates the user's role and\n whether they have approved the pull request. For performance reasons,\n the API only returns this list when an API requests a pull request by\n id.\n ","items":{"$ref":"#/components/schemas/participant"},"type":"array"},"reason":{"description":"Explains why a pull request was declined. This field is only applicable to pull requests in rejected state.","type":"string"},"rendered":{"additionalProperties":false,"description":"User provided pull request text, interpreted in a markup language and rendered in HTML","properties":{"description":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"},"reason":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"},"title":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"}},"title":"Rendered Pull Request Markup","type":"object"},"reviewers":{"description":"The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL.","items":{"$ref":"#/components/schemas/account"},"type":"array"},"source":{"$ref":"#/components/schemas/pullrequest_endpoint"},"state":{"description":"The pull request's current status.","enum":["OPEN","MERGED","DECLINED","SUPERSEDED"],"type":"string"},"summary":{"additionalProperties":false,"properties":{"html":{"description":"The user's content rendered as HTML.","type":"string"},"markup":{"description":"The type of markup language the raw content is to be interpreted in.","enum":["markdown","creole","plaintext"],"type":"string"},"raw":{"description":"The text as it was typed by a user.","type":"string"}},"type":"object"},"task_count":{"description":"The number of open tasks for a specific pull request.","minimum":0,"type":"integer"},"title":{"description":"Title of the pull request.","type":"string"},"updated_on":{"description":"The ISO8601 timestamp the request was last updated.","format":"date-time","type":"string"}},"title":"Pull Request","type":"object"}]},"pullrequest_comment":{"allOf":[{"$ref":"#/components/schemas/comment"},{"additionalProperties":true,"description":"A pullrequest comment.","properties":{"pullrequest":{"$ref":"#/components/schemas/pullrequest"}},"title":"Pull Request Comment","type":"object"}]},"pullrequest_endpoint":{"additionalProperties":false,"properties":{"branch":{"additionalProperties":false,"properties":{"default_merge_strategy":{"description":"The default merge strategy, when this endpoint is the destination of the pull request.","type":"string"},"merge_strategies":{"description":"Available merge strategies, when this endpoint is the destination of the pull request.","items":{"enum":["merge_commit","squash","fast_forward"],"type":"string"},"type":"array"},"name":{"type":"string"}},"title":"Pull Request Branch","type":"object"},"commit":{"additionalProperties":false,"properties":{"hash":{"pattern":"[0-9a-f]{7,}?","type":"string"}},"title":"Pull Request Commit","type":"object"},"repository":{"$ref":"#/components/schemas/repository"}},"title":"Pull Request Endpoint","type":"object"},"pullrequest_merge_parameters":{"additionalProperties":true,"description":"The metadata that describes a pull request merge.","properties":{"close_source_branch":{"description":"Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False","type":"boolean"},"merge_strategy":{"default":"merge_commit","description":"The merge strategy that will be used to merge the pull request.","enum":["merge_commit","squash","fast_forward"],"type":"string"},"message":{"description":"The commit message that will be used on the resulting commit.","type":"string"},"type":{"type":"string"}},"required":["type"],"title":"Pull Request Merge Parameters","type":"object"},"ref":{"additionalProperties":true,"description":"A ref object, representing a branch or tag in a repository.","properties":{"links":{"additionalProperties":false,"properties":{"commits":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"description":"The name of the ref.","type":"string"},"target":{"$ref":"#/components/schemas/commit"},"type":{"type":"string"}},"required":["type"],"title":"Ref","type":"object"},"report":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A report for a commit.","properties":{"created_on":{"description":"The timestamp when the report was created.","format":"date-time","type":"string"},"data":{"description":"An array of data fields to display information on the report. Maximum 10.","items":{"$ref":"#/components/schemas/report_data"},"type":"array"},"details":{"description":"A string to describe the purpose of the report.","type":"string"},"external_id":{"description":"ID of the report provided by the report creator. It can be used to identify the report as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the report creator for updating or deleting this specific report. Needs to be unique.","type":"string"},"link":{"description":"A URL linking to the results of the report in an external tool.","format":"uri","type":"string"},"logo_url":{"description":"A URL to the report logo. If none is provided, the default insights logo will be used.","format":"uri","type":"string"},"remote_link_enabled":{"description":"If enabled, a remote link is created in Jira for the issue associated with the commit the report belongs to.","type":"boolean"},"report_type":{"description":"The type of the report.","enum":["SECURITY","COVERAGE","TEST","BUG"],"type":"string"},"reporter":{"description":"A string to describe the tool or company who created the report.","type":"string"},"result":{"description":"The state of the report. May be set to PENDING and later updated.","enum":["PASSED","FAILED","PENDING"],"type":"string"},"title":{"description":"The title of the report.","type":"string"},"updated_on":{"description":"The timestamp when the report was updated.","format":"date-time","type":"string"},"uuid":{"description":"The UUID that can be used to identify the report.","type":"string"}},"title":"Commit Report","type":"object"}],"x-bb-default-fields":["uuid","commitHash"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commitHash}/reports/{uuid}"},"report_annotation":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A report for a commit.","properties":{"annotation_type":{"description":"The type of the report.","enum":["VULNERABILITY","CODE_SMELL","BUG"],"type":"string"},"created_on":{"description":"The timestamp when the report was created.","format":"date-time","type":"string"},"details":{"description":"The details to show to users when clicking on the annotation.","type":"string"},"external_id":{"description":"ID of the annotation provided by the annotation creator. It can be used to identify the annotation as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the annotation creator for updating or deleting this specific annotation. Needs to be unique.","type":"string"},"line":{"description":"The line number that the annotation should belong to. If no line number is provided, then it will default to 0 and in a pull request it will appear at the top of the file specified by the path field.","minimum":1,"type":"integer"},"link":{"description":"A URL linking to the annotation in an external tool.","format":"uri","type":"string"},"path":{"description":"The path of the file on which this annotation should be placed. This is the path of the file relative to the git repository. If no path is provided, then it will appear in the overview modal on all pull requests where the tip of the branch is the given commit, regardless of which files were modified.","type":"string"},"result":{"description":"The state of the report. May be set to PENDING and later updated.","enum":["PASSED","FAILED","SKIPPED","IGNORED"],"type":"string"},"severity":{"description":"The severity of the annotation.","enum":["CRITICAL","HIGH","MEDIUM","LOW"],"type":"string"},"summary":{"description":"The message to display to users.","type":"string"},"updated_on":{"description":"The timestamp when the report was updated.","format":"date-time","type":"string"},"uuid":{"description":"The UUID that can be used to identify the annotation.","type":"string"}},"title":"Report Annotation","type":"object"}],"x-bb-default-fields":["uuid"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commit.hash}/reports/{reportUuid}/annotations/{uuid}"},"report_data":{"description":"A key-value element that will be displayed along with the report.","properties":{"title":{"description":"A string describing what this data field represents.","type":"string"},"type":{"description":"The type of data contained in the value field. If not provided, then the value will be detected as a boolean, number or string.","enum":["BOOLEAN","DATE","DURATION","LINK","NUMBER","PERCENTAGE","TEXT"],"type":"string"},"value":{"description":"The value of the data element.","type":"object"}},"title":"Report Data","type":"object"},"repository":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket repository.","properties":{"created_on":{"format":"date-time","type":"string"},"description":{"type":"string"},"fork_policy":{"description":"\nControls the rules for forking this repository.\n\n* **allow_forks**: unrestricted forking\n* **no_public_forks**: restrict forking to private forks (forks cannot\n be made public later)\n* **no_forks**: deny all forking\n","enum":["allow_forks","no_public_forks","no_forks"],"type":"string"},"full_name":{"description":"The concatenation of the repository owner's username and the slugified name, e.g. \"evzijst/interruptingcow\". This is the same string used in Bitbucket URLs.","type":"string"},"has_issues":{"type":"boolean"},"has_wiki":{"type":"boolean"},"is_private":{"type":"boolean"},"language":{"type":"string"},"links":{"additionalProperties":false,"properties":{"avatar":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"clone":{"items":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"type":"array"},"commits":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"downloads":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"forks":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"hooks":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"pullrequests":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"watchers":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"mainbranch":{"$ref":"#/components/schemas/branch"},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/account"},"parent":{"$ref":"#/components/schemas/repository"},"project":{"$ref":"#/components/schemas/project"},"scm":{"enum":["git"],"type":"string"},"size":{"type":"integer"},"updated_on":{"format":"date-time","type":"string"},"uuid":{"description":"The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user.","type":"string"}},"title":"Repository","type":"object"}]},"repository_group_permission":{"additionalProperties":true,"description":"A group's permission for a given repository.","properties":{"group":{"$ref":"#/components/schemas/group"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"permission":{"enum":["read","write","admin","none"],"type":"string"},"repository":{"$ref":"#/components/schemas/repository"},"type":{"type":"string"}},"required":["type"],"title":"Repository Group Permission","type":"object"},"repository_inheritance_state":{"additionalProperties":true,"description":"A json object representing the repository's inheritance state values","properties":{"override_settings":{"type":"object"},"type":{"type":"string"}},"required":["type"],"title":"Repository Inheritance State","type":"object"},"repository_permission":{"additionalProperties":true,"description":"A user's permission for a given repository.","properties":{"permission":{"enum":["read","write","admin","none"],"type":"string"},"repository":{"$ref":"#/components/schemas/repository"},"type":{"type":"string"},"user":{"$ref":"#/components/schemas/user"}},"required":["type"],"title":"Repository Permission","type":"object"},"repository_user_permission":{"additionalProperties":true,"description":"A user's direct permission for a given repository.","properties":{"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"permission":{"enum":["read","write","admin","none"],"type":"string"},"repository":{"$ref":"#/components/schemas/repository"},"type":{"type":"string"},"user":{"$ref":"#/components/schemas/user"}},"required":["type"],"title":"Repository User Permission","type":"object"},"search_code_search_result":{"properties":{"content_match_count":{"format":"int64","readOnly":true,"type":"integer"},"content_matches":{"items":{"$ref":"#/components/schemas/search_content_match"},"readOnly":true,"type":"array"},"file":{"$ref":"#/components/schemas/commit_file"},"path_matches":{"items":{"$ref":"#/components/schemas/search_segment"},"readOnly":true,"type":"array"},"type":{"readOnly":true,"type":"string"}},"type":"object"},"search_content_match":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/search_line"},"readOnly":true,"type":"array"}},"type":"object"},"search_line":{"properties":{"line":{"format":"int32","readOnly":true,"type":"integer"},"segments":{"items":{"$ref":"#/components/schemas/search_segment"},"readOnly":true,"type":"array"}},"type":"object"},"search_result_page":{"properties":{"next":{"format":"uri","readOnly":true,"type":"string"},"page":{"format":"int32","readOnly":true,"type":"integer"},"pagelen":{"format":"int32","readOnly":true,"type":"integer"},"previous":{"format":"uri","readOnly":true,"type":"string"},"query_substituted":{"readOnly":true,"type":"boolean"},"size":{"format":"int64","readOnly":true,"type":"integer"},"values":{"items":{"$ref":"#/components/schemas/search_code_search_result"},"readOnly":true,"type":"array"}},"type":"object"},"search_segment":{"properties":{"match":{"readOnly":true,"type":"boolean"},"text":{"readOnly":true,"type":"string"}},"type":"object"},"snippet":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A snippet object.","properties":{"created_on":{"format":"date-time","type":"string"},"creator":{"$ref":"#/components/schemas/account"},"id":{"minimum":0,"type":"integer"},"is_private":{"type":"boolean"},"owner":{"$ref":"#/components/schemas/account"},"scm":{"description":"The DVCS used to store the snippet.","enum":["git"],"type":"string"},"title":{"type":"string"},"updated_on":{"format":"date-time","type":"string"}},"title":"Snippet","type":"object"}]},"snippet_comment":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A comment on a snippet.","properties":{"links":{"additionalProperties":false,"properties":{"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"snippet":{"$ref":"#/components/schemas/snippet"}},"title":"Snippet Comment","type":"object"}]},"snippet_commit":{"allOf":[{"$ref":"#/components/schemas/base_commit"},{"additionalProperties":true,"description":"","properties":{"links":{"additionalProperties":false,"properties":{"diff":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"snippet":{"$ref":"#/components/schemas/snippet"}},"title":"Snippet Commit","type":"object"}]},"ssh_account_key":{"allOf":[{"$ref":"#/components/schemas/ssh_key"},{"additionalProperties":true,"description":"Represents an SSH public key for a user.","properties":{"owner":{"$ref":"#/components/schemas/account"}},"title":"SSH Account Key","type":"object"}]},"ssh_key":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"Base type for representing SSH public keys.","properties":{"comment":{"description":"The comment parsed from the SSH key (if present)","type":"string"},"created_on":{"format":"date-time","type":"string"},"key":{"description":"The SSH public key value in OpenSSH format.","type":"string"},"label":{"description":"The user-defined label for the SSH key","type":"string"},"last_used":{"format":"date-time","type":"string"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"uuid":{"description":"The SSH key's immutable ID.","type":"string"}},"title":"SSH Key","type":"object"}]},"stg_west_report":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A report for a commit.","type":"object"}],"x-bb-default-fields":["uuid","commitHash"],"x-bb-url":"/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commitHash}/reports/{uuid}"},"subject_types":{"additionalProperties":false,"description":"The mapping of resource/subject types pointing to their individual event types.","properties":{"repository":{"additionalProperties":false,"properties":{"events":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"workspace":{"additionalProperties":false,"properties":{"events":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"}},"title":"Subject Types","type":"object"},"tag":{"allOf":[{"$ref":"#/components/schemas/ref"},{"additionalProperties":true,"description":"A tag object, representing a tag in a repository.","properties":{"date":{"description":"The date that the tag was created, if available","format":"date-time","type":"string"},"message":{"description":"The message associated with the tag, if available.","type":"string"},"tagger":{"$ref":"#/components/schemas/author"}},"title":"Tag","type":"object"}]},"team":{"allOf":[{"$ref":"#/components/schemas/account"},{"additionalProperties":true,"description":"A team object.","properties":{"links":{"$ref":"#/components/schemas/team_links"}},"title":"Team","type":"object"}]},"team_links":{"allOf":[{"$ref":"#/components/schemas/account_links"},{"additionalProperties":true,"description":"Links related to a Team.","properties":{"html":{"$ref":"#/components/schemas/link"},"members":{"$ref":"#/components/schemas/link"},"projects":{"$ref":"#/components/schemas/link"},"repositories":{"$ref":"#/components/schemas/link"},"self":{"$ref":"#/components/schemas/link"}},"title":"Team Links","type":"object"}]},"treeentry":{"additionalProperties":true,"description":"Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.","properties":{"commit":{"$ref":"#/components/schemas/commit"},"path":{"description":"The path in the repository","type":"string"},"type":{"type":"string"}},"required":["type"],"title":"Tree Entry","type":"object"},"user":{"allOf":[{"$ref":"#/components/schemas/account"},{"additionalProperties":true,"description":"A user object.","properties":{"account_id":{"description":"The user's Atlassian account ID.","type":"string"},"account_status":{"description":"The status of the account. Currently the only possible value is \"active\", but more values may be added in the future.","type":"string"},"has_2fa_enabled":{"type":"boolean"},"is_staff":{"type":"boolean"},"links":{"$ref":"#/components/schemas/user_links"},"nickname":{"description":"Account name defined by the owner. Should be used instead of the \"username\" field. Note that \"nickname\" cannot be used in place of \"username\" in URLs and queries, as \"nickname\" is not guaranteed to be unique.","type":"string"},"website":{"type":"string"}},"title":"User","type":"object"}]},"user_links":{"allOf":[{"$ref":"#/components/schemas/account_links"},{"additionalProperties":true,"description":"Links related to a User.","properties":{"html":{"$ref":"#/components/schemas/link"},"repositories":{"$ref":"#/components/schemas/link"},"self":{"$ref":"#/components/schemas/link"}},"title":"User Links","type":"object"}]},"version":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A version as defined in a repository's issue tracker.","properties":{"id":{"type":"integer"},"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"type":"string"}},"title":"Version","type":"object"}]},"webhook_subscription":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Webhook subscription.","properties":{"active":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"description":{"description":"A user-defined description of the webhook.","type":"string"},"events":{"description":"The events this webhook is subscribed to.","items":{"enum":["pullrequest:changes_request_removed","issue:comment_created","repo:push","repo:commit_status_updated","repo:imported","pullrequest:unapproved","repo:updated","pullrequest:rejected","pullrequest:fulfilled","pullrequest:created","pullrequest:approved","repo:transfer","repo:commit_status_created","repo:fork","issue:updated","project:updated","repo:created","issue:created","repo:commit_comment_created","pullrequest:updated","repo:deleted","pullrequest:comment_updated","pullrequest:changes_request_created","pullrequest:comment_deleted","pullrequest:comment_created"],"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"subject":{"$ref":"#/components/schemas/object"},"subject_type":{"description":"The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined.","enum":["repository","workspace"],"type":"string"},"url":{"description":"The URL events get delivered to.","format":"uri","type":"string"},"uuid":{"description":"The webhook's id","type":"string"}},"title":"Webhook Subscription","type":"object"}]},"workspace":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket workspace.\n Workspaces are used to organize repositories.","properties":{"created_on":{"format":"date-time","type":"string"},"is_private":{"description":"Indicates whether the workspace is publicly accessible, or whether it is\nprivate to the members and consequently only visible to members.","type":"boolean"},"links":{"additionalProperties":false,"properties":{"avatar":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"html":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"members":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"owners":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"projects":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"repositories":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"},"snippets":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"name":{"description":"The name of the workspace.","type":"string"},"slug":{"description":"The short label that identifies this workspace.","type":"string"},"updated_on":{"format":"date-time","type":"string"},"uuid":{"description":"The workspace's immutable id.","type":"string"}},"title":"Workspace","type":"object"}]},"workspace_membership":{"allOf":[{"$ref":"#/components/schemas/object"},{"additionalProperties":true,"description":"A Bitbucket workspace membership.\n Links a user to a workspace.","properties":{"links":{"additionalProperties":false,"properties":{"self":{"additionalProperties":false,"description":"A link to a resource related to this object.","properties":{"href":{"format":"uri","type":"string"},"name":{"type":"string"}},"title":"Link","type":"object"}},"type":"object"},"user":{"$ref":"#/components/schemas/account"},"workspace":{"$ref":"#/components/schemas/workspace"}},"title":"Workspace Membership","type":"object"}]}},"securitySchemes":{"api_key":{"description":"API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only available to team accounts and there is only 1 key per account. API Keys do not support scopes and have therefore access to all contents of the account.","in":"header","name":"Authorization","type":"apiKey"},"basic":{"description":"Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username and app password as credentials.","scheme":"basic","type":"http"},"oauth2":{"description":"OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).","flows":{"authorizationCode":{"authorizationUrl":"https://bitbucket.org/site/oauth2/authorize","scopes":{"account":"Read your account information","account:write":"Read and modify your account information","email":"Read your account's primary email address","issue":"Read your repositories' issues","issue:write":"Read and modify your repositories' issues","pipeline":"Access your repositories' build pipelines","pipeline:variable":"Access your repositories' build pipelines and configure their variables","pipeline:write":"Access and rerun your repositories' build pipelines","project":"Read your workspace's project settings and read repositories contained within your workspace's projects","project:admin":"Read and modify settings for projects in your workspace","pullrequest":"Read your repositories and their pull requests","pullrequest:write":"Read and modify your repositories and their pull requests","repository":"Read your repositories","repository:admin":"Administer your repositories","repository:delete":"Delete your repositories","repository:write":"Read and modify your repositories","runner":"Access your workspaces/repositories' runners","runner:write":"Access and edit your workspaces/repositories' runners","snippet":"Read your snippets","snippet:write":"Read and modify your snippets","team":"Read your team membership information","team:write":"Read and modify your team membership information","webhook":"Read and modify your repositories' webhooks","wiki":"Read and modify your repositories' wikis"},"tokenUrl":"https://bitbucket.org/site/oauth2/access_token"}},"type":"oauth2"}}},"x-atlassian-narrative":{"documents":[{"anchor":"authentication","body":"\nThe purpose of this section is to describe how to authenticate when making API calls using the Bitbucket REST API.\n\n-----\n\n* [Oauth 2](#oauth-2)\n * [Making requests](#making-requests)\n * [Repository cloning](#repository-cloning)\n * [Refresh tokens](#refresh-tokens)\n* [Scopes](#scopes)\n* [Basic auth](#basic-auth)\n* [Access Tokens](#access-tokens)\n * [Repository Access Tokens](#repository-access-tokens)\n * [Project Access Tokens](#project-access-tokens)\n * [Workspace Access Tokens](#workspace-access-tokens)\n* [App passwords](#app-passwords)\n\n---\n\n### OAuth 2.0\n\nOur OAuth 2 implementation is merged in with our existing OAuth 1 in\nsuch a way that existing OAuth 1 consumers automatically become\nvalid OAuth 2 clients. The only thing you need to do is edit your\nexisting consumer and configure a callback URL.\n\nOnce that is in place, you'll have the following 2 URLs:\n\n https://bitbucket.org/site/oauth2/authorize\n https://bitbucket.org/site/oauth2/access_token\n\nFor obtaining access/bearer tokens, we support three of RFC-6749's grant\nflows, plus a custom Bitbucket flow for exchanging JWT tokens for access tokens.\nNote that Resource Owner Password Credentials Grant (4.3) is no longer supported.\n\n\n#### 1. Authorization Code Grant (4.1)\n\nThe full-blown 3-LO flow. Request authorization from the end user by\nsending their browser to:\n\n https://bitbucket.org/site/oauth2/authorize?client_id={client_id}&response_type=code\n\nThe callback includes the `?code={}` query parameter that you can swap\nfor an access token:\n\n $ curl -X POST -u \"client_id:secret\" \\\n https://bitbucket.org/site/oauth2/access_token \\\n -d grant_type=authorization_code -d code={code}\n\n\n#### 2. Implicit Grant (4.2)\n\nThis flow is useful for browser-based add-ons that operate without server-side backends.\n\nRequest the end user for authorization by directing the browser to:\n\n https://bitbucket.org/site/oauth2/authorize?client_id={client_id}&response_type=token\n\nThat will redirect to your preconfigured callback URL with a fragment\ncontaining the access token\n(`#access_token={token}&token_type=bearer`) where your page's js can\npull it out of the URL.\n\n\n#### 3. Client Credentials Grant (4.4)\n\nSomewhat like our existing \"2-LO\" flow for OAuth 1. Obtain an access\ntoken that represents not an end user, but the owner of the\nclient/consumer:\n\n $ curl -X POST -u \"client_id:secret\" \\\n https://bitbucket.org/site/oauth2/access_token \\\n -d grant_type=client_credentials\n\n\n#### 4. Bitbucket Cloud JWT Grant (urn:bitbucket:oauth2:jwt)\n\nIf your Atlassian Connect add-on uses JWT authentication, you can swap a\nJWT for an OAuth access token. The resulting access token represents the\naccount for which the add-on is installed.\n\nMake sure you send the JWT token in the Authorization request header\nusing the \"JWT\" scheme (case sensitive). Note that this custom scheme\nmakes this different from HTTP Basic Auth (and so you cannot use \"curl\n-u\").\n\n $ curl -X POST -H \"Authorization: JWT {jwt_token}\" \\\n https://bitbucket.org/site/oauth2/access_token \\\n -d grant_type=urn:bitbucket:oauth2:jwt\n\n\n#### Making Requests\n\nOnce you have an access token, as per RFC-6750, you can use it in a request in any of\nthe following ways (in decreasing order of desirability):\n\n1. Send it in a request header: `Authorization: Bearer {access_token}`\n2. Include it in a (application/x-www-form-urlencoded) POST body as `access_token={access_token}`\n3. Put it in the query string of a non-POST: `?access_token={access_token}`\n\n\n#### Repository Cloning\n\nSince add-ons will not be able to upload their own SSH keys to clone\nwith, access tokens can be used as Basic HTTP Auth credentials to\nclone securely over HTTPS. This is much like GitHub, yet slightly\ndifferent:\n\n $ git clone https://x-token-auth:{access_token}@bitbucket.org/user/repo.git\n\nThe literal string `x-token-auth` as a substitute for username is\nrequired (note the difference with GitHub where the actual token is in\nthe username field).\n\n\n#### Refresh Tokens\n\nOur access tokens expire in one hour. When this happens you'll get 401\nresponses.\n\nMost access tokens grant responses (Implicit and JWT excluded). Therefore, you should include a\nrefresh token that can then be used to generate a new access token,\nwithout the need for end user participation:\n\n $ curl -X POST -u \"client_id:secret\" \\\n https://bitbucket.org/site/oauth2/access_token \\\n -d grant_type=refresh_token -d refresh_token={refresh_token}\n\n\n### Scopes\n\nBitbucket's API applies a number of privilege scopes to endpoints. In order to access an endpoint, a request will need to have the necessary scopes.\n\nScopes are declared in the descriptor as a list of strings, with each string being the name of a unique scope.\n\nA descriptor lacking the `scopes` element is implicitly assumed to require all scopes and as a result, Bitbucket will require end users authorizing/installing the add-on\nto explicitly accept all scopes.\n\nOur best practice suggests you add the scopes your add-on needs, but no more than it needs.\n\nInvalid scope strings will cause the descriptor to be rejected and the installation to fail.\n\nThe available scopes are:\n\n- [project](#project)\n- [project:write](#project-write)\n- [project:admin](#project-admin)\n- [repository](#repository)\n- [repository:write](#repository-write)\n- [repository:admin](#repository-admin)\n- [repository:delete](#repository-delete)\n- [pullrequest](#pullrequest)\n- [pullrequest:write](#pullrequest-write)\n- [issue](#issue)\n- [issue:write](#issue-write)\n- [wiki](#wiki)\n- [webhook](#webhook)\n- [snippet](#snippet)\n- [snippet:write](#snippet-write)\n- [email](#email)\n- [account](#account)\n- [account:write](#account-write)\n- [pipeline](#pipeline)\n- [pipeline:write](#pipeline-write)\n- [pipeline:variable](#pipeline-variable)\n- [runner](#runner)\n- [runner:write](#runner-write)\n\n#### project\n\nProvides access to view the project or projects.\nThis scope implies the [`repository`](#repository) scope, giving read access to all the repositories in a project or projects.\n\n#### project:write\n\nThis scope is deprecated, and has been made obsolete by `project:admin`. Please see the deprecation notice [here](/cloud/bitbucket/deprecation-notice-project-write-scope).\n\n#### project:admin\n\nProvides admin access to a project or projects. No distinction is made between public and private projects. This scope doesn't implicitly grant the [`project`](#project) scope or the [`repository:write`](#repository-write) scope on any repositories under the project. It gives access to the admin features of a project only, not direct access to its repositories' contents.\n\n* ability to create the project\n* ability to update the project\n* ability to delete the project\n\n#### repository\n\nProvides read access to a repository or repositories.\nNote that this scope does not give access to a repository's pull requests.\n\n* access to the repo's source code\n* clone over HTTPS\n* access the file browsing API\n* download zip archives of the repo's contents\n* the ability to view and use the issue tracker on any repo (created issues, comment, vote, etc)\n* the ability to view and use the wiki on any repo (create/edit pages)\n\n#### repository:write\n\nProvides write (not admin) access to a repository or repositories. No distinction is made between public and private repositories. This scope implicitly grants the [`repository`](#repository) scope, which does not need to be requested separately.\nThis scope alone does not give access to the pull requests API.\n\n* push access over HTTPS\n* fork repos\n\n#### repository:admin\n\nProvides admin access to a repository or repositories. No distinction is made between public and private repositories. This scope doesn't implicitly grant the [`repository`](#repository) or the [`repository:write`](#repository-write) scopes. It gives access to the admin features of a repo only, not direct access to its contents. This scope can be used or misused to grant read access to other users, who can then clone the repo, but users that need to read and write source code would also request explicit read or write.\nThis scope comes with access to the following functionality:\n\n* View and manipulate committer mappings\n* List and edit deploy keys\n* Ability to delete the repo\n* View and edit repo permissions\n* View and edit branch permissions\n* Import and export the issue tracker\n* Enable and disable the issue tracker\n* List and edit issue tracker version, milestones and components\n* Enable and disable the wiki\n* List and edit default reviewers\n* List and edit repo links (Jira/Bamboo/Custom)\n* List and edit the repository webhooks\n* Initiate a repo ownership transfer\n\n#### repository:delete\n\nProvides access to delete a repository or repositories.\n\n#### pullrequest\n\nProvides read access to pull requests.\nThis scope implies the [`repository`](#repository) scope, giving read access to the pull request's destination repository.\n\n* see and list pull requests\n* create and resolve tasks\n* comment on pull requests\n\n#### pullrequest:write\n\nImplicitly grants the [`pullrequest`](#pullrequest) scope and adds the ability to create, merge and decline pull requests.\nThis scope also implicitly grants the [`repository:write`](#repository-write) scope, giving write access to the pull request's destination repository. This is necessary to allow merging.\n\n* merge pull requests\n* decline pull requests\n* create pull requests\n* approve pull requests\n\n#### issue\n\nAbility to interact with issue trackers the way non-repo members can.\nThis scope doesn't implicitly grant any other scopes and doesn't give implicit access to the repository.\n\n* view, list and search issues\n* create new issues\n* comment on issues\n* watch issues\n* vote for issues\n\n#### issue:write\n\nThis scope implicitly grants the [`issue`](#issue) scope and adds the ability to transition and delete issues.\nThis scope doesn't implicitly grant any other scopes and doesn't give implicit access to the repository.\n\n* transition issues\n* delete issues\n\n#### wiki\n\nProvides access to wikis. This scope provides both read and write access (wikis are always editable by anyone with access to them).\nThis scope doesn't implicitly grant any other scopes and doesn't give implicit access to the repository.\n\n* view wikis\n* create pages\n* edit pages\n* push to wikis\n* clone wikis\n\n#### webhook\n\nGives access to webhooks. This scope is required for any webhook-related operation.\n\nThis scope gives read access to existing webhook subscriptions on all\nresources the authorization mechanism can access, without needing further scopes.\nFor example:\n\n- A client can list all existing webhook subscriptions on a repository. The [`repository`](#repository) scope is not required.\n- Existing webhook subscriptions for the issue tracker on a repo can be retrieved without the [`issue`](#issue) scope. All that is required is the `webhook` scope.\n\nTo create webhooks, the client will need read access to the resource. Such as: for [`issue:created`](#issue-created), the client will need to\nhave both the `webhook` and the [`issue`](#issue) scope.\n\n* list webhook subscriptions on any accessible repository, user, team, or snippet\n* create/update/delete webhook subscriptions.\n\n#### snippet\n\nProvides read access to snippets.\nNo distinction is made between public and private snippets (public snippets are accessible without any form of authentication).\n\n* view any snippet\n* create snippet comments\n\n#### snippet:write\n\nProvides write access to snippets.\nNo distinction is made between public and private snippets (public snippets are accessible without any form of authentication).\nThis scope implicitly grants the [`snippet`](#snippet) scope which does not need to be requested separately.\n\n* create snippets\n* edit snippets\n* delete snippets\n\n#### email\n\nAbility to see the user's primary email address. This should make it easier to use Bitbucket Cloud as a login provider for apps or external applications.\n\n#### account\n\nWhen used for:\n* **user-related APIs** — Gives read-only access to the user's account information.\nNote that this doesn't include any ability to change any of the data. This scope allows you to view the user's:\n * email addresses\n * language\n * location\n * website\n * full name\n * SSH keys\n * user groups\n* **workspace-related APIs** — Grants access to view the workspace's:\n * users\n * user permissions\n * projects\n\n#### account:write\n\nAbility to change properties on the user's account.\n\n* delete the authorizing user's account\n* manage the user's groups\n* change a user's email addresses\n* change username, display name and avatar\n\n#### pipeline\n\nGives read-only access to pipelines, steps, deployment environments and variables.\n\n#### pipeline:write\n\nGives write access to pipelines. This scope allows a user to:\n* Stop pipelines\n* Rerun failed pipelines\n* Resume halted pipelines\n* Trigger manual pipelines.\n\nThis scope is not needed to trigger a build using a push. Performing a `git push` (or equivalent actions) will trigger the build. The token doing the push only needs the [`repository:write`](#repository-write) scope.\n\nThis doesn't give write access to create variables.\n\n#### pipeline:variable\n\nGives write access to create variables in pipelines at the various levels:\n* Workspace\n* Repository\n* Deployment\n\n#### runner\n\nGives read-only access to pipelines runners setup against a workspace or repository.\n\n#### runner:write\n\nGives write access to create/edit/disable/delete pipelines runners setup against a workspace or repository.\n\n### Basic auth\n\nBasic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported).\nNote that Basic Auth is available only with username and [app password](https://bitbucket.org/account/settings/app-passwords/) as credentials.\n\n### Access Tokens\n\nAccess Tokens are passwords (or tokens) that provide access to a _single_ repository, project or workspace.\nThese tokens can authenticate with Bitbucket APIs for scripting, CI/CD tools, Bitbucket Cloud-connected apps,\nand Bitbucket Cloud integrations.\n\nAccess Tokens are linked to a repository, project, or workspace, not a user account.\nThe level of access provided by the token is set when a repository, or workspace admin creates it,\nby setting permission scopes.\n\nThere are three types of Access Token:\n\n* **Repository Access Tokens** can connect to a single repository, preventing them from accessing any other repositories or workspaces.\n* **Project Access Tokens** can connect to a project, providing access to any repositories within the project.\n* **Workspace Access Tokens** can connect to a single workspace and have access to any projects and repositories within that workspace.\n\nWhen using Bitbucket APIs with an Access Token, the token will be treated as the \"user\" in the\nBitbucket UI and Bitbucket logs. This includes when using the Access Token to leave a comment on a pull request,\npush a commit, or merge a pull request. The Bitbucket UI and API responses will show the\nRepository/Project/Workspace Access Token as a user. The username shown in the Bitbucket UI is the Access\nToken _name_, and a custom icon is used to differentiate it from a regular user in the UI.\n\n#### Considerations for using Access Tokens\n\n* After creation, an Access Token can't be viewed or modified. The token's name, created date,\nlast accessed date, and scopes are visible on the repository, project, or workspace **Access Tokens** page.\n* Access Tokens can access a limited set of Bitbucket's permission scopes.\n* Provided you set the correct permission scopes, you can use an Access Token to clone (`repository`)\nand push (`repository:write`) code to the token's repository or the repositories the token can access.\n* You can't use an Access Token to log into the Bitbucket website.\n* Access Tokens don't require two-step verification.\n* You can set permission scopes (specific access rights) for each Access Token.\n* You can't use an Access Token to manipulate or query repository, project, or workspace permissions.\n* Access Tokens are not listed in any repository or workspace permission API response.\n* Access Tokens are deactivated when deleting the resource tied to it (a repository, project, or workspace).\nRepository Access Tokens are also revoked when transferring the repository to another workspace.\n* Any content created by the Access Token will persist after the Access Token has been revoked.\n* Access Tokens can interact with branch restriction APIs, but the token can't be configured as a user with merge access when using branch restrictions.\n\nThere are some APIs which are inaccessible for Access Tokens, these are:\n\n* [Add a repository deploy key](/cloud/bitbucket/rest/api-group-deployments/#api-repositories-workspace-repo-slug-deploy-keys-post)\n* [Update a repository deploy key](/cloud/bitbucket/rest/api-group-deployments/#api-repositories-workspace-repo-slug-deploy-keys-key-id-put)\n* [Delete a repository deploy key](/cloud/bitbucket/rest/api-group-deployments/#api-repositories-workspace-repo-slug-deploy-keys-key-id-delete)\n\n#### Repository Access Tokens\n\nFor details on creating, managing, and using Repository Access Tokens, visit\n[Repository Access Tokens](https://support.atlassian.com/bitbucket-cloud/docs/repository-access-tokens/).\n\nThe available scopes for Repository Access Tokens are:\n\n- [`repository`](#repository)\n- [`repository:write`](#repository-write)\n- [`repository:admin`](#repository-admin)\n- [`repository:delete`](#repository-delete)\n- [`pullrequest`](#pullrequest)\n- [`pullrequest:write`](#pullrequest-write)\n- [`webhook`](#webhook)\n- [`pipeline`](#pipeline)\n- [`pipeline:write`](#pipeline-write)\n- [`pipeline:variable`](#pipeline-variable)\n- [`runner`](#runner)\n- [`runner:write`](#runner-write)\n\n#### Project Access Tokens\n\nFor details on creating, managing, and using Project Access Tokens, visit\n[Project Access Tokens](https://support.atlassian.com/bitbucket-cloud/docs/project-access-tokens/).\n\nThe available scopes for Project Access Tokens are:\n\n- [`project`](#project)\n- [`repository`](#repository)\n- [`repository:write`](#repository-write)\n- [`repository:admin`](#repository-admin)\n- [`repository:delete`](#repository-delete)\n- [`pullrequest`](#pullrequest)\n- [`pullrequest:write`](#pullrequest-write)\n- [`webhook`](#webhook)\n- [`pipeline`](#pipeline)\n- [`pipeline:write`](#pipeline-write)\n- [`pipeline:variable`](#pipeline-variable)\n- [`runner`](#runner)\n- [`runner:write`](#runner-write)\n\n#### Workspace Access Tokens\n\nFor details on creating, managing, and using Workspace Access Tokens, visit\n[Workspace Access Tokens](https://support.atlassian.com/bitbucket-cloud/docs/workspace-access-tokens/).\n\nThe available scopes for Workspace Access Tokens are:\n\n- [`project`](#project)\n- [`project:admin`](#project-admin)\n- [`repository`](#repository)\n- [`repository:write`](#repository-write)\n- [`repository:admin`](#repository-admin)\n- [`repository:delete`](#repository-delete)\n- [`pullrequest`](#pullrequest)\n- [`pullrequest:write`](#pullrequest-write)\n- [`webhook`](#webhook)\n- [`account`](#account)\n- [`pipeline`](#pipeline)\n- [`pipeline:write`](#pipeline-write)\n- [`pipeline:variable`](#pipeline-variable)\n- [`runner`](#runner)\n- [`runner:write`](#runner-write)\n\n### App passwords\n\nApp passwords allow users to make API calls to their Bitbucket account through apps such as Sourcetree.\n\nSome important points about app passwords:\n\n* You cannot view an app password or adjust permissions after you create the app password. Because app passwords are encrypted on our database and cannot be viewed by anyone. They are essentially designed to be disposable. If you need to change the scopes or lost the password just create a new one.\n* You cannot use them to log into your Bitbucket account.\n* You cannot use app passwords to manage team actions.\n\n App passwords are tied to an individual account's credentials and should not be shared. If you're sharing your app password you're essentially giving direct, authenticated, access to everything that password has been scoped to do with the Bitbucket API's.\n\n* You can use them for API call authentication, even if you don't have two-step verification enabled.\n* You can set permission scopes (specific access rights) for each app password.\n\nFor details on creating, managing, and using App passwords, visit\n[App passwords](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/).\n","description":"How to authenticate API actions","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxOTcuNjQ3MyAxODYuODEzOCI+CiAgPGRlZnM+CiAgICA8c3R5bGU+CiAgICAgIC5jbHMtMSB7CiAgICAgICAgaXNvbGF0aW9uOiBpc29sYXRlOwogICAgICB9CgogICAgICAuY2xzLTIgewogICAgICAgIGZpbGw6ICNkZTM1MGI7CiAgICAgIH0KCiAgICAgIC5jbHMtMyB7CiAgICAgICAgZmlsbDogI2ZmNTYzMDsKICAgICAgfQoKICAgICAgLmNscy00IHsKICAgICAgICBmaWxsOiAjZGZlMWU1OwogICAgICAgIG1peC1ibGVuZC1tb2RlOiBtdWx0aXBseTsKICAgICAgfQoKICAgICAgLmNscy01IHsKICAgICAgICBmaWxsOiAjZmFmYmZjOwogICAgICB9CgogICAgICAuY2xzLTYgewogICAgICAgIGZpbGw6ICNlYmVjZjA7CiAgICAgIH0KCiAgICAgIC5jbHMtNyB7CiAgICAgICAgZmlsbDogbm9uZTsKICAgICAgICBzdHJva2U6ICMwMDY1ZmY7CiAgICAgICAgc3Ryb2tlLW1pdGVybGltaXQ6IDEwOwogICAgICAgIHN0cm9rZS13aWR0aDogMnB4OwogICAgICB9CgogICAgICAuY2xzLTggewogICAgICAgIGZpbGw6ICM1ZTZjODQ7CiAgICAgIH0KCiAgICAgIC5jbHMtOSB7CiAgICAgICAgZmlsbDogIzI1Mzg1ODsKICAgICAgfQoKICAgICAgLmNscy0xMCB7CiAgICAgICAgZmlsbDogIzI2ODRmZjsKICAgICAgfQoKICAgICAgLmNscy0xMSB7CiAgICAgICAgZmlsbDogIzAwNjVmZjsKICAgICAgfQogICAgPC9zdHlsZT4KICA8L2RlZnM+CiAgPHRpdGxlPlNlY3VyaXR5IHdpdGggS2V5PC90aXRsZT4KICA8ZyBjbGFzcz0iY2xzLTEiPgogICAgPGcgaWQ9IkxheWVyXzIiIGRhdGEtbmFtZT0iTGF5ZXIgMiI+CiAgICAgIDxnIGlkPSJPYmplY3RzIj4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik00Mi4wNjcyLDBoLjYxMTRhOCw4LDAsMCwxLDgsOFYyMy4yMzM4YTAsMCwwLDAsMSwwLDBIMzQuMDY3MmEwLDAsMCwwLDEsMCwwVjhBOCw4LDAsMCwxLDQyLjA2NzIsMFoiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xMDguMjIsMGguNjExNGE4LDgsMCwwLDEsOCw4VjIzLjIzMzhhMCwwLDAsMCwxLDAsMEgxMDAuMjJhMCwwLDAsMCwxLDAsMFY4QTgsOCwwLDAsMSwxMDguMjIsMFoiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzQuMzcyMiwwaC42MTE0YTgsOCwwLDAsMSw4LDhWMjMuMjMzOGEwLDAsMCwwLDEsMCwwSDE2Ni4zNzIyYTAsMCwwLDAsMSwwLDBWOEE4LDgsMCwwLDEsMTc0LjM3MjIsMFoiLz4KICAgICAgICA8cmVjdCBjbGFzcz0iY2xzLTIiIHg9IjM0LjA2NzIiIHk9IjIzLjIzMzgiIHdpZHRoPSIxNjMuNTgiIGhlaWdodD0iMTYzLjU4Ii8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0yIiBkPSJNNDIuMDY3MiwwSDU5LjI5YTgsOCwwLDAsMSw4LDhWMjMuMjIyOGEwLDAsMCwwLDEsMCwwSDM0LjA2NzJhMCwwLDAsMCwxLDAsMFY4YTgsOCwwLDAsMSw4LThaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMTA3LjI0NTgsMGgxNy4yMjI4YTgsOCwwLDAsMSw4LDhWMjMuMjIyOGEwLDAsMCwwLDEsMCwwSDk5LjI0NThhMCwwLDAsMCwxLDAsMFY4YTgsOCwwLDAsMSw4LThaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMTcyLjQyNDQsMGgxNy4yMjI4YTgsOCwwLDAsMSw4LDhWMjMuMjIyOGEwLDAsMCwwLDEsMCwwSDE2NC40MjQ0YTAsMCwwLDAsMSwwLDBWOGE4LDgsMCwwLDEsOC04WiIvPgogICAgICAgIDxyZWN0IGNsYXNzPSJjbHMtMyIgeD0iMTcuNDU1OCIgeT0iMjMuMjMzOCIgd2lkdGg9IjE2My41OCIgaGVpZ2h0PSIxNjMuNTgiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTMiIGQ9Ik0yNS40NTU4LDBINDIuNjc4NmE4LDgsMCwwLDEsOCw4VjIzLjIyMjhhMCwwLDAsMCwxLDAsMEgxNy40NTU4YTAsMCwwLDAsMSwwLDBWOEE4LDgsMCwwLDEsMjUuNDU1OCwwWiIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtMyIgZD0iTTkwLjYzNDQsMGgxNy4yMjI4YTgsOCwwLDAsMSw4LDhWMjMuMjIyOGEwLDAsMCwwLDEsMCwwSDgyLjYzNDRhMCwwLDAsMCwxLDAsMFY4QTgsOCwwLDAsMSw5MC42MzQ0LDBaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0zIiBkPSJNMTU1LjgxMywwaDE3LjIyMjhhOCw4LDAsMCwxLDgsOFYyMy4yMjI4YTAsMCwwLDAsMSwwLDBIMTQ3LjgxM2EwLDAsMCwwLDEsMCwwVjhBOCw4LDAsMCwxLDE1NS44MTMsMFoiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTMiIGQ9Ik0yNS40NTU4LDBINDIuNjc4NmE4LDgsMCwwLDEsOCw4VjIzLjIyMjhhMCwwLDAsMCwxLDAsMEgxNy40NTU4YTAsMCwwLDAsMSwwLDBWOEE4LDgsMCwwLDEsMjUuNDU1OCwwWiIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtMyIgZD0iTTkwLjYzNDQsMGgxNy4yMjI4YTgsOCwwLDAsMSw4LDhWMjMuMjIyOGEwLDAsMCwwLDEsMCwwSDgyLjYzNDRhMCwwLDAsMCwxLDAsMFY4QTgsOCwwLDAsMSw5MC42MzQ0LDBaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0zIiBkPSJNMTU1LjgxMywwaDE3LjIyMjhhOCw4LDAsMCwxLDgsOFYyMy4yMjI4YTAsMCwwLDAsMSwwLDBIMTQ3LjgxM2EwLDAsMCwwLDEsMCwwVjhBOCw4LDAsMCwxLDE1NS44MTMsMFoiLz4KICAgICAgICA8cmVjdCBjbGFzcz0iY2xzLTIiIHg9IjM1Ljc1OTYiIHk9IjU2LjgwNjUiIHdpZHRoPSIzMy4yMjI4IiBoZWlnaHQ9IjE1LjYwMzgiLz4KICAgICAgICA8cmVjdCBjbGFzcz0iY2xzLTIiIHg9IjEzMS4yMDE2IiB5PSIxMzYuOTYxNSIgd2lkdGg9IjMzLjIyMjgiIGhlaWdodD0iMTUuNjAzOCIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtNCIgZD0iTTU3LjM3MDksNzEuNjAzNmg3MC43NWE5LDksMCwwLDEsOSw5djM1LjM3NDlhNDQuMzc0OCw0NC4zNzQ4LDAsMCwxLTQ0LjM3NDgsNDQuMzc0OGgwYTQ0LjM3NDgsNDQuMzc0OCwwLDAsMS00NC4zNzQ4LTQ0LjM3NDhWODAuNjAzNkE5LDksMCwwLDEsNTcuMzcwOSw3MS42MDM2WiIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtNSIgZD0iTTY2LjM3MSw2Ni42NjE3aDcwLjc1YTksOSwwLDAsMSw5LDl2MzUuMzc0OWE0NC4zNzQ4LDQ0LjM3NDgsMCwwLDEtNDQuMzc0OCw0NC4zNzQ4aDBBNDQuMzc0OCw0NC4zNzQ4LDAsMCwxLDU3LjM3MSwxMTEuMDM2NlY3NS42NjE3YTksOSwwLDAsMSw5LTlaIi8+CiAgICAgICAgPHBhdGggaWQ9Il9SZWN0YW5nbGVfIiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTYiIGQ9Ik02MS4zNzEsNjYuNjYxN2g3MC43NWE5LDksMCwwLDEsOSw5djM1LjM3NDlhNDQuMzc0OCw0NC4zNzQ4LDAsMCwxLTQ0LjM3NDgsNDQuMzc0OGgwQTQ0LjM3NDgsNDQuMzc0OCwwLDAsMSw1Mi4zNzEsMTExLjAzNjZWNzUuNjYxN0E5LDksMCwwLDEsNjEuMzcxLDY2LjY2MTdaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy03IiBkPSJNOTYuNzQ1OSwxNDcuNzQ0MWEzNi43NDg3LDM2Ljc0ODcsMCwwLDEtMzYuNzA3NC0zNi43MDc0Vjc4LjA1ODRhMy43MzMzLDMuNzMzMywwLDAsMSwzLjcyOS0zLjcyOWg2NS45NTYzYTMuNzMzMywzLjczMzMsMCwwLDEsMy43MjksMy43Mjl2MzIuOTc4NEEzNi43NDg2LDM2Ljc0ODYsMCwwLDEsOTYuNzQ1OSwxNDcuNzQ0MVoiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTQiIGQ9Ik0xMDAuNjg5MywxNjMuMzE2N1YxMTEuMDk3M2EzLjk0NDMsMy45NDQzLDAsMCwwLTcuODg4NywwdjUyLjIyYTIyLjUyNTIsMjIuNTI1MiwwLDAsMC0xOC41NDc5LDIyLjE0YzAsLjQ1Ni4wMTc4LjkwNzguMDQ0NywxLjM1NzFIODIuMjFjLS4wNDE0LS40NDc0LS4wNjg4LS44OTktLjA2ODgtMS4zNTcxYTE0LjYyLDE0LjYyLDAsMCwxLDE0LjU5NzQtMTQuNjA0MWwuMDA2MS4wMDA2LjAwNjgtLjAwMDdBMTQuNjIxMSwxNC42MjExLDAsMCwxLDExMS4zNSwxODUuNDU2NmMwLC40NTgxLS4wMjczLjkxLS4wNjg4LDEuMzU3MWg3LjkxMjhjLjAyNjktLjQ0OTMuMDQ0Ny0uOTAxMS4wNDQ3LTEuMzU3MUEyMi41MjU5LDIyLjUyNTksMCwwLDAsMTAwLjY4OTMsMTYzLjMxNjdaIi8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0yIiB4PSIxNy40NTU4IiB5PSIzNi40NzAyIiB3aWR0aD0iMzMuMjIyOCIgaGVpZ2h0PSIxNS42MDM4Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0yIiB4PSIxNy40NTU4IiB5PSIxNTguMTIxNyIgd2lkdGg9IjMzLjIyMjgiIGhlaWdodD0iMTUuNjAzOCIvPgogICAgICAgIDxyZWN0IGNsYXNzPSJjbHMtMiIgeD0iMTQ3LjgxMyIgeT0iMzYuNDcwMiIgd2lkdGg9IjMzLjIyMjgiIGhlaWdodD0iMTUuNjAzOCIvPgogICAgICAgIDxyZWN0IGNsYXNzPSJjbHMtMiIgeD0iMTUwLjA2NDMiIHk9IjE1Ny41NTEzIiB3aWR0aD0iMzMuMjIyOCIgaGVpZ2h0PSIxNS42MDM4Ii8+CiAgICAgICAgPHBhdGggaWQ9Il9QYXRoXyIgZGF0YS1uYW1lPSImbHQ7UGF0aCZndDsiIGNsYXNzPSJjbHMtOCIgZD0iTTEwNy41MjU0LDEwMS4wMDI3YTExLjc3OTQsMTEuNzc5NCwwLDEsMC0xOS44Niw4LjU1NDhBNC4wNDE3LDQuMDQxNywwLDAsMSw4OC44NSwxMTMuNjJsLTIuMTA0LDcuMjY4MWEzLDMsMCwwLDAsMi44ODE3LDMuODM0MmgxMi4yMzcxYTMsMywwLDAsMCwyLjg4MTctMy44MzQybC0yLjA5NTktNy4yNGE0LjA3NDMsNC4wNzQzLDAsMCwxLDEuMTgwOC00LjA5NDVBMTEuNzE3MiwxMS43MTcyLDAsMCwwLDEwNy41MjU0LDEwMS4wMDI3WiIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtOSIgZD0iTTEwNC43NDYxLDEyMC44ODc3bC0yLjA5NTktNy4yNGE0LjA3NDQsNC4wNzQ0LDAsMCwxLDEuMTgwOC00LjA5NDUsMTEuNzYyOSwxMS43NjI5LDAsMCwwLTUuMDYtMTkuOTMxMywxMS45MSwxMS45MSwwLDAsMC04Ljc5OCwxMC45OTQ5LDExLjcxODUsMTEuNzE4NSwwLDAsMCwzLjY5MjksOC45NDFBNC4wNDE2LDQuMDQxNiwwLDAsMSw5NC44NSwxMTMuNjJsLTMuMjE0LDExLjEwMjNoMTAuMjI4OEEzLDMsMCwwLDAsMTA0Ljc0NjEsMTIwLjg4NzdaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0xMCIgZD0iTTgxLjc5NzUsMTAwLjMxYTMuOTQzOSwzLjk0MzksMCwwLDAtMy45NDQzLTMuOTQ0M0g0MS4wNDE3YTMuOTQ0MywzLjk0NDMsMCwwLDAsMCw3Ljg4ODdINzcuODUzMkEzLjk0MzksMy45NDM5LDAsMCwwLDgxLjc5NzUsMTAwLjMxWiIvPgogICAgICAgIDxwYXRoIGlkPSJfUGF0aF8yIiBkYXRhLW5hbWU9IiZsdDtQYXRoJmd0OyIgY2xhc3M9ImNscy0xMSIgZD0iTTQxLjA0MTYsMTA0LjI1MzlIOTYuODUzMmEzLjk0NDMsMy45NDQzLDAsMCwwLDAtNy44ODg3SDQxLjA0MTZhMy45NDQzLDMuOTQ0MywwLDAsMCwwLDcuODg4N1oiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTEwIiBkPSJNODEuNzk3NSwxMDAuMzFhMy45NDM5LDMuOTQzOSwwLDAsMC0zLjk0NDMtMy45NDQzSDQxLjA0MTdhMy45NDQzLDMuOTQ0MywwLDAsMCwwLDcuODg4N0g3Ny44NTMyQTMuOTQzOSwzLjk0MzksMCwwLDAsODEuNzk3NSwxMDAuMzFaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0xMCIgZD0iTTIyLjQ5MzIsMTIyLjgwMjlBMjIuNDkyOSwyMi40OTI5LDAsMSwxLDQ0Ljk4NTgsMTAwLjMxLDIyLjUxODUsMjIuNTE4NSwwLDAsMSwyMi40OTMyLDEyMi44MDI5Wm0wLTM3LjA5NzJBMTQuNjA0MiwxNC42MDQyLDAsMSwwLDM3LjA5NzIsMTAwLjMxLDE0LjYyMDcsMTQuNjIwNywwLDAsMCwyMi40OTMyLDg1LjcwNTdaIi8+CiAgICAgIDwvZz4KICAgIDwvZz4KICA8L2c+Cjwvc3ZnPgo='","title":"Authentication methods"},{"anchor":"filtering","body":"\nYou can query the 2.0 API for specific objects using a simple language which resembles SQL.\n\nNote that filtering and querying by username has been deprecated, due to privacy changes. \nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-querying) \nfor details.\n\n---\n\n* [Supported endpoints](#supported-endpoints)\n* [Operators](#operators)\n* [Data types](#data-types)\n* [Querying](#querying)\n* [Sorting query results](#sorting-query-results)\n\n----\n\n### Supported endpoints\n\nMost 2.0 API resources that return paginated collections of objects support a single, shared, generic querying language that is used to filter down a result set.\n\nThis includes, but is in no way limited to:\n\n /2.0/repositories/{username}\n /2.0/repositories/{username}/{slug}/refs\n /2.0/repositories/{username}/{slug}/refs/branches\n /2.0/repositories/{username}/{slug}/refs/tags\n /2.0/repositories/{username}/{slug}/forks\n /2.0/repositories/{username}/{slug}/src\n /2.0/repositories/{username}/{slug}/issues\n /2.0/repositories/{username}/{slug}/pullrequests\n\nFiltering and sorting supports several distinct operators and data types as well as basic features, like logical operators (AND, OR).\nAs examples, the following queries could be used on the issue tracker endpoint (`/2.0/repositories/{workspace}/{slug}/issues/`):\n\n\t(state = \"open\" OR state = \"new\") AND assignee = null\n\treporter.nickname != \"evzijst\" AND priority >= \"major\"\n\t(title ~ \"unicode\" OR content.raw ~ \"unicode\") AND created_on > 2015-10-04T14:00:00-07:00\n\nFilter queries can be added to the URL using the q= query parameter. To sort the response, add sort=. Note that the entire query string is put in the q parameter and hence needs to be URL-encoded as shown in the following example:\n\n\t/2.0/repositories/foo/bar/issues?q=state=\"new\"&sort=-updated_on\n\n\n### Operators\n\nFiltering and sorting supports the following operators:\n\n| Operator | Definition | Example |\n|----------|--------------------------------|----------------------------|\n| \"=\" | test for equality | `nickname = \"evzijst\"` |\n| \"!=\" | not equal | `is_private != true` |\n| \"~\" | case-insensitive text contains | `description ~ \"beef\"` |\n| \"!~\" | case-insensitive not contains | `description !~ \"fubar\"` |\n| \">\" | greater than | `priority > \"major\"` |\n| \">=\" | greater than or equal | `priority <= \"trivial\"` |\n| \"<\" | less than | `id < 1234` |\n| \"<=\" | less than or equal | `updated_on <= 2015-03-04` |\n\n### Data types\n\nFiltering and sorting supports the following data types:\n\n| Type | Description | Example |\n|--------------|-----------------------------------------|---------------|\n| **String** | any text inside double quotes | `\"foo\"` |\n| **Number** | arbitrary precision integers and floats | `1, -10.302` |\n| **Null** | to test for the absence of a value | `null` |\n| **boolean** | the unquoted strings true or false | `true, false` |\n| **datetime** | an unquoted [ISO-8601][iso-8601] date time string with the timezone offset, milliseconds and entire time component being optional | `2015-03-04T14:08:59.123+02:00`, `2015-03-04T14:08:59` Date time strings are assumed to be in UTC, unless an explicit timezone offset is provided |\n\n[https://en.wikipedia.org/wiki/ISO_8601]: /iso-8601\n\n### Querying\n\nObjects can be filtered based on their properties. In principle, every element in an object's JSON document schema can be used as a filter criterion.\n\nNote that while the array of objects in a paginated response is wrapped in an\nenvelope with a `values` element, this prefix should not be included in the\nquery fields (so use `/2.0/repositories/foo/bar/issues?q=state=\"new\"`, not\n`/2.0/repositories/foo/bar/issues?q=values.state=\"new\"`).\n\n\n### Examples\n\nFields that contain embedded instances of other object types (e.g. owner is an embedded user object, while parent is an embedded repository) can be traversed recursively. For instance:\n\n\tparent.owner.nickname = \"bitbucket\"\n\nTo find pull requests which merge into master, come from a fork of the repo rather than a branch inside the repo, and on which I am a reviewer:\n\n```\nsource.repository.full_name != \"main/repo\" AND state = \"OPEN\" AND reviewers.nickname = \"evzijst\" AND destination.branch.name = \"master\"\n```\n```\n/2.0/repositories/main/repo/pullrequests?q=source.repository.full_name+%21%3D+%22main%2Frepo%22+AND+state+%3D+%22OPEN%22+AND+reviewers.nickname+%3D+%22evzijst%22+AND+destination.branch.name+%3D+%22master%22\n```\n\nTo find new or on-hold issues related to the UI, created or updated in the last day (SF local time), that have not yet been assigned to anyone:\n\n```\n(state = \"new\" OR state = \"on hold\") AND assignee = null AND component = \"UI\" and updated_on > 2015-11-11T00:00:00-07:00\n```\n```\n/2.0/repositories/main/repo/issues?q=%28state+%3D+%22new%22+OR+state+%3D+%22on+hold%22%29+AND+assignee+%3D+null+AND+component+%3D+%22UI%22+and+updated_on+%3E+2015-11-11T00%3A00%3A00-07%3A00\n```\n\nTo find all tags with the string \"2015\" in the name:\n\n```\nname ~ \"2015\"\n```\n```\n/2.0/repositories/{username}/{slug}/refs/tags?q=name+%7E+%222015%22\n```\nOr all my branches:\n\n```\nname ~ \"erik/\"\n```\n```\n/2.0/repositories/{username}/{slug}/refs/?q=name+%7E+%22erik%2F%22\n```\n### Sorting query results\n\nYou can sort result sets using the ?sort= query parameter, available on the same resources that support filtering:\n\n* In principle, every field that can be queried can also be used as a key for sorting.\n* By default the sort order is ascending. To reverse the order, prefix the field name with a hyphen (e.g. ?sort=-updated_on).\n* Only one field can be sorted on. Compound fields (e.g. sort on state first, followed by updated_on) are not supported.\n\n\n","description":"Query the 2.0 API for specific objects","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMTk0LjE5MTkgMTQ3LjYwOTIiPgogIDxkZWZzPgogICAgPHN0eWxlPgogICAgICAuY2xzLTEgewogICAgICAgIGlzb2xhdGlvbjogaXNvbGF0ZTsKICAgICAgfQoKICAgICAgLmNscy0yIHsKICAgICAgICBmaWxsOiAjY2ZkNGRiOwogICAgICB9CgogICAgICAuY2xzLTMsIC5jbHMtNCB7CiAgICAgICAgZmlsbDogIzg3NzdkOTsKICAgICAgfQoKICAgICAgLmNscy00IHsKICAgICAgICBtaXgtYmxlbmQtbW9kZTogbXVsdGlwbHk7CiAgICAgIH0KCiAgICAgIC5jbHMtNSB7CiAgICAgICAgZmlsbDogIzAwNjVmZjsKICAgICAgfQoKICAgICAgLmNscy02IHsKICAgICAgICBmaWxsOiAjY2NlMGZmOwogICAgICB9CgogICAgICAuY2xzLTcgewogICAgICAgIGZpbGw6IHVybCgjbGluZWFyLWdyYWRpZW50KTsKICAgICAgfQogICAgPC9zdHlsZT4KICAgIDxsaW5lYXJHcmFkaWVudCBpZD0ibGluZWFyLWdyYWRpZW50IiB4MT0iNDE2LjMwODIiIHkxPSI3NS4wNDc5IiB4Mj0iNTg0Ljg1NTYiIHkyPSI3NS4wNDc5IiBncmFkaWVudFRyYW5zZm9ybT0idHJhbnNsYXRlKC00NDMuOTQ2NyAxMjMuMDY4Nikgcm90YXRlKC0xMy43OTc2KSIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPgogICAgICA8c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiNmZmYiLz4KICAgICAgPHN0b3Agb2Zmc2V0PSIwLjY5MDgiIHN0b3AtY29sb3I9IiNmZmYiIHN0b3Atb3BhY2l0eT0iMC4xIi8+CiAgICA8L2xpbmVhckdyYWRpZW50PgogIDwvZGVmcz4KICA8dGl0bGU+TWFnbmlmeWluZyBHbGFzczwvdGl0bGU+CiAgPGcgY2xhc3M9ImNscy0xIj4KICAgIDxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPgogICAgICA8ZyBpZD0iT2JqZWN0cyI+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMTMxLjExMjUsOTQuOTMwN2wtOS44ODc4LTUuOTg4OC04LjMyOTIsMTMuNzUxOSw5Ljg4NzgsNS45ODg4YTE1LjYwMywxNS42MDMsMCwwLDEsNS44OCw2LjM4MzVoMGExNS42MDMsMTUuNjAzLDAsMCwwLDUuODgsNi4zODM1bDQwLjExNDMsMjQuMjk2NGExMi44NjY0LDEyLjg2NjQsMCwwLDAsMTcuNjcwOS00LjM0aDBhMTIuODY2NCwxMi44NjY0LDAsMCwwLTQuMzQtMTcuNjcwOUwxNDcuODc0OSw5OS40MzkyYTE1LjYwMywxNS42MDMsMCwwLDAtOC4zODEyLTIuMjU0MmgwQTE1LjYwMywxNS42MDMsMCwwLDEsMTMxLjExMjUsOTQuOTMwN1oiLz4KICAgICAgICA8cGF0aCBpZD0iX1BhdGhfIiBkYXRhLW5hbWU9IiZsdDtQYXRoJmd0OyIgY2xhc3M9ImNscy0zIiBkPSJNMTMxLjExMjUsOTQuOTMwN2wtMy4wMTE4LTEuODI0MkE4LjAzODgsOC4wMzg4LDAsMCwwLDExNy4wNiw5NS44MTc4aDBhOC4wMzg4LDguMDM4OCwwLDAsMCwyLjcxMTMsMTEuMDQwNWwzLjAxMTgsMS44MjQyYTE1LjYwMywxNS42MDMsMCwwLDEsNS44OCw2LjM4MzVoMGExNS42MDMsMTUuNjAzLDAsMCwwLDUuODgsNi4zODM1bDQwLjExNDMsMjQuMjk2NGExMi44NjY0LDEyLjg2NjQsMCwwLDAsMTcuNjcwOS00LjM0aDBhMTIuODY2NCwxMi44NjY0LDAsMCwwLTQuMzQtMTcuNjcwOUwxNDcuODc0OSw5OS40MzkyYTE1LjYwMywxNS42MDMsMCwwLDAtOC4zODEyLTIuMjU0M2gwQTE1LjYwMywxNS42MDMsMCwwLDEsMTMxLjExMjUsOTQuOTMwN1oiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTQiIGQ9Ik0xMzkuMTQzNyw5Ny4xNzkyYTE1LjU5NzMsMTUuNTk3MywwLDAsMS04LjAzMTItMi4yNDg1bC0zLjAxMTgtMS44MjQyQTguMDM4OCw4LjAzODgsMCwwLDAsMTE3LjA2LDk1LjgxNzhoMGE4LjAzODgsOC4wMzg4LDAsMCwwLDIuNzExMywxMS4wNDA1bDMuMDExOCwxLjgyNDJhMTUuNTk3LDE1LjU5NywwLDAsMSw1LjcwNjksNi4wNjQ4LDY3Ljg0ODEsNjcuODQ4MSwwLDAsMCwxMC42NTM2LTE3LjU2ODFaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy01IiBkPSJNODMuMjUzNywxMzIuNTU2QTY3LjIzNDgsNjcuMjM0OCwwLDAsMSw5LjcxLDMyLjQyOTUsNjYuNzk3NCw2Ni43OTc0LDAsMCwxLDUxLjE4MzcsMS45NjY2bC4wMDA3LDBBNjYuNzk2Miw2Ni43OTYyLDAsMCwxLDEwMi4wNTEsOS43NTI1aDBBNjcuMjM0Niw2Ny4yMzQ2LDAsMCwxLDgzLjI1MzcsMTMyLjU1NloiLz4KICAgICAgICA8cGF0aCBpZD0iX1BhdGhfMiIgZGF0YS1uYW1lPSImbHQ7UGF0aCZndDsiIGNsYXNzPSJjbHMtNiIgZD0iTTIzLjQzOSw0MC43NDgyQTUxLjE5MDgsNTEuMTkwOCwwLDAsMCwxMTEuMDEsOTMuNzg4OSw1MS4xOTA4LDUxLjE5MDgsMCwwLDAsMjMuNDM5LDQwLjc0ODJaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy03IiBkPSJNNzkuNDMzLDExNi45ODJBNTEuMjE2Miw1MS4yMTYyLDAsMCwwLDExOC40MjQxLDY3LjAzN2E0OS4xMzkxLDQ5LjEzOTEsMCwwLDEtNS4wODY3LDIuMjc4OWMtMTUuNzAyOSw1Ljk2MDktMjkuNjg5NSwyLjExLTM2LjQ5ODcuMTMwOC0yMC40MzA3LTUuOTM5LTI0Ljc5LTE3LjM3ODUtMzkuMDQxNC0yNC41ODIzYTQ4LjMwOTIsNDguMzA5MiwwLDAsMC0xNC4wOTM5LTQuNTNjLS4wODYyLjEzOTUtLjE3OTMuMjczLS4yNjQ0LjQxMzVBNTEuMTkwNyw1MS4xOTA3LDAsMCwwLDc5LjQzMywxMTYuOTgyWiIvPgogICAgICA8L2c+CiAgICA8L2c+CiAgPC9nPgo8L3N2Zz4K'","title":"Filter and sort API objects"},{"anchor":"pagination","body":"\nEndpoints that return collections of objects should always apply pagination.\nPaginated collections are always wrapped in the following wrapper object:\n\n```json\n{\n \"size\": 5421,\n \"page\": 2,\n \"pagelen\": 10,\n \"next\": \"https://api.bitbucket.org/2.0/repositories/pypy/pypy/commits?page=3\",\n \"previous\": \"https://api.bitbucket.org/2.0/repositories/pypy/pypy/commits?page=1\",\n \"values\": [\n ...\n ]\n}\n```\n\nPagination is often page-bound, with a query parameter page indicating which\npage is to be returned.\n\nHowever, clients are not expected to construct URLs themselves by manipulating\nthe page number query parameter. Instead, the response contains a link to the\nnext page. This link should be treated as an opaque location that is not to be\nconstructed by clients or even assumed to be predictable. The only contract\naround the next link is that it will return the next chunk of results.\n\nLack of a next link in the response indicates the end of the collection.\n\nThe paginated response contains the following fields:\n\n| Field | Value |\n|------------|----------|\n| `size` | Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. |\n| `page` | Page number of the current results. This is an optional element that is not provided in all responses. |\n| `pagelen` | Current number of objects on the existing page. Globally, the minimum length is 10 and the maximum is 100. Some APIs may specify a different default. |\n| `next` | Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. |\n| `previous` | Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. |\n| `values` | The list of objects. This contains at most `pagelen` objects. |\n\nThe link to the next page is included such that you don't have to hardcode or construct any links. Only values and next are guaranteed (except the last page, which lacks next). This is because the previous and size values can be expensive for some data sets.\n\nIt is important to realize that Bitbucket support both list-based pagination and iterator-based pagination. List-based pagination assumes that the collection is a discrete, immutable, consistently ordered, finite array of objects with a fixed size. Clients navigate a list-based collection by requesting offset-based chunks. In Bitbucket Cloud, list-based responses include the optional size, page, and previous element. The the next and previous links typically resemble something like /foo/bar?page=4.\n\nHowever, not all result sets can be treated as immutable and finite – much like how programming languages tend to distinguish between lists and arrays on one hand and iterators or stream on the other. Where an list-based pagination offers random access into any point in a collection, iterator-based pagination can only navigate forward one element at a time. In Bitbucket such iterator-based pagination contains the next link and pagelen elements, but not necessarily anything else. In these cases, the next link's value often contains an unpredictable hash instead of an explicit page number. The commits resource uses iterator-based pagination.\n","description":"Learn more about pagination","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMjM4LjgyIDE1MS42Ij48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2IyZDRmZjt9LmNscy0ye2ZpbGw6IzRjOWFmZjt9LmNscy0ze2ZpbGw6IzAwNTJjYzt9LmNscy00e29wYWNpdHk6MC42O30uY2xzLTV7ZmlsbDp1cmwoI2xpbmVhci1ncmFkaWVudCk7fS5jbHMtNntmaWxsOnVybCgjbGluZWFyLWdyYWRpZW50LTIpO30uY2xzLTd7ZmlsbDp1cmwoI2xpbmVhci1ncmFkaWVudC0zKTt9LmNscy04e2ZpbGw6dXJsKCNsaW5lYXItZ3JhZGllbnQtNCk7fS5jbHMtOXtmaWxsOnVybCgjbGluZWFyLWdyYWRpZW50LTUpO30uY2xzLTEwLC5jbHMtMTEsLmNscy0xMntmaWxsOm5vbmU7fS5jbHMtMTB7c3Ryb2tlOiMzMzg0ZmY7fS5jbHMtMTAsLmNscy0xMSwuY2xzLTEyLC5jbHMtMTN7c3Ryb2tlLW1pdGVybGltaXQ6MTA7c3Ryb2tlLXdpZHRoOjJweDt9LmNscy0xMXtzdHJva2U6I2ZmYWIwMDt9LmNscy0xMntzdHJva2U6I2ZhZmJmYzt9LmNscy0xM3tmaWxsOiNmZmFiMDA7c3Ryb2tlOiMyNjg0ZmY7fTwvc3R5bGU+PGxpbmVhckdyYWRpZW50IGlkPSJsaW5lYXItZ3JhZGllbnQiIHkxPSI2NS4xNyIgeDI9Ijg2LjM4IiB5Mj0iNjUuMTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj48c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiM0YzlhZmYiLz48c3RvcCBvZmZzZXQ9IjAuMDgiIHN0b3AtY29sb3I9IiM0YzlhZmYiIHN0b3Atb3BhY2l0eT0iMC45NCIvPjxzdG9wIG9mZnNldD0iMC4yNCIgc3RvcC1jb2xvcj0iIzRjOWFmZiIgc3RvcC1vcGFjaXR5PSIwLjc4Ii8+PHN0b3Agb2Zmc2V0PSIwLjQ1IiBzdG9wLWNvbG9yPSIjNGM5YWZmIiBzdG9wLW9wYWNpdHk9IjAuNTMiLz48c3RvcCBvZmZzZXQ9IjAuNTUiIHN0b3AtY29sb3I9IiM0YzlhZmYiIHN0b3Atb3BhY2l0eT0iMC40Ii8+PC9saW5lYXJHcmFkaWVudD48bGluZWFyR3JhZGllbnQgaWQ9ImxpbmVhci1ncmFkaWVudC0yIiB4MT0iMTUyLjQ0IiB5MT0iNjUuMTciIHgyPSIyMzguODIiIHkyPSI2NS4xNyIgeGxpbms6aHJlZj0iI2xpbmVhci1ncmFkaWVudCIvPjxsaW5lYXJHcmFkaWVudCBpZD0ibGluZWFyLWdyYWRpZW50LTMiIHgxPSIxOC44NSIgeTE9IjExOC43OCIgeDI9IjEyNi4wOCIgeTI9IjExLjU2IiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+PHN0b3Agb2Zmc2V0PSIwLjA2IiBzdG9wLWNvbG9yPSIjMDA2NWZmIi8+PHN0b3Agb2Zmc2V0PSIwLjE5IiBzdG9wLWNvbG9yPSIjMDA2NWZmIiBzdG9wLW9wYWNpdHk9IjAuOTQiLz48c3RvcCBvZmZzZXQ9IjAuNDYiIHN0b3AtY29sb3I9IiMwMDY1ZmYiIHN0b3Atb3BhY2l0eT0iMC43OCIvPjxzdG9wIG9mZnNldD0iMC44MiIgc3RvcC1jb2xvcj0iIzAwNjVmZiIgc3RvcC1vcGFjaXR5PSIwLjUzIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjMDA2NWZmIiBzdG9wLW9wYWNpdHk9IjAuNCIvPjwvbGluZWFyR3JhZGllbnQ+PGxpbmVhckdyYWRpZW50IGlkPSJsaW5lYXItZ3JhZGllbnQtNCIgeDE9IjExMi43NSIgeTE9IjExOC43OCIgeDI9IjIxOS45NyIgeTI9IjExLjU2IiB4bGluazpocmVmPSIjbGluZWFyLWdyYWRpZW50LTMiLz48bGluZWFyR3JhZGllbnQgaWQ9ImxpbmVhci1ncmFkaWVudC01IiB4MT0iNTAuOTciIHkxPSIxMzMuNjEiIHgyPSIxODcuODYiIHkyPSItMy4yOCIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPjxzdG9wIG9mZnNldD0iMC42NiIgc3RvcC1jb2xvcj0iIzI1Mzg1OCIvPjxzdG9wIG9mZnNldD0iMC44OCIgc3RvcC1jb2xvcj0iIzI1Mzg1OCIgc3RvcC1vcGFjaXR5PSIwLjgzIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjMjUzODU4IiBzdG9wLW9wYWNpdHk9IjAuNyIvPjwvbGluZWFyR3JhZGllbnQ+PC9kZWZzPjx0aXRsZT5WaWV3IFZlcnNpb25zPC90aXRsZT48ZyBpZD0iTGF5ZXJfMiIgZGF0YS1uYW1lPSJMYXllciAyIj48ZyBpZD0iU29mdHdhcmUiPjxjaXJjbGUgY2xhc3M9ImNscy0xIiBjeD0iOTQuNTMiIGN5PSIxNDcuOTMiIHI9IjMuNjciLz48Y2lyY2xlIGNsYXNzPSJjbHMtMiIgY3g9IjEwNi45NCIgY3k9IjE0Ny45MyIgcj0iMy42NyIvPjxjaXJjbGUgY2xhc3M9ImNscy0zIiBjeD0iMTE5LjM0IiBjeT0iMTQ3LjkzIiByPSIzLjY3Ii8+PGNpcmNsZSBjbGFzcz0iY2xzLTIiIGN4PSIxMzEuNzUiIGN5PSIxNDcuOTMiIHI9IjMuNjciLz48Y2lyY2xlIGNsYXNzPSJjbHMtMSIgY3g9IjE0NC4xNiIgY3k9IjE0Ny45MyIgcj0iMy42NyIvPjxnIGNsYXNzPSJjbHMtNCI+PHJlY3QgaWQ9Il9SZWN0YW5nbGVfIiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTUiIHk9IjI1LjkyIiB3aWR0aD0iODYuMzgiIGhlaWdodD0iNzguNDkiLz48L2c+PGcgY2xhc3M9ImNscy00Ij48cmVjdCBpZD0iX1JlY3RhbmdsZV8yIiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTYiIHg9IjE1Mi40NCIgeT0iMjUuOTIiIHdpZHRoPSI4Ni4zOCIgaGVpZ2h0PSI3OC40OSIvPjwvZz48cmVjdCBpZD0iX1JlY3RhbmdsZV8zIiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTciIHg9IjE2LjI4IiB5PSIxNC4xMiIgd2lkdGg9IjExMi4zNiIgaGVpZ2h0PSIxMDIuMDkiLz48cmVjdCBpZD0iX1JlY3RhbmdsZV80IiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTgiIHg9IjExMC4xOCIgeT0iMTQuMTIiIHdpZHRoPSIxMTIuMzYiIGhlaWdodD0iMTAyLjA5Ii8+PHJlY3QgaWQ9Il9SZWN0YW5nbGVfNSIgZGF0YS1uYW1lPSImbHQ7UmVjdGFuZ2xlJmd0OyIgY2xhc3M9ImNscy05IiB4PSI0Ny42OSIgd2lkdGg9IjE0My40NSIgaGVpZ2h0PSIxMzAuMzQiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iNzkuMTYiIHkxPSIxNi4xOCIgeDI9IjExNy4yNCIgeTI9IjE2LjE4Ii8+PGxpbmUgY2xhc3M9ImNscy0xMCIgeDE9IjYyLjkzIiB5MT0iMTYuMTgiIHgyPSI3Mi42IiB5Mj0iMTYuMTgiLz48bGluZSBjbGFzcz0iY2xzLTExIiB4MT0iNzkuMTYiIHkxPSIyNi45NSIgeDI9IjExNy4yNCIgeTI9IjI2Ljk1Ii8+PGxpbmUgY2xhc3M9ImNscy0xMCIgeDE9IjYyLjkzIiB5MT0iMjYuOTUiIHgyPSI3Mi42IiB5Mj0iMjYuOTUiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iNzkuMTYiIHkxPSIzNy43MiIgeDI9IjE1MC43IiB5Mj0iMzcuNzIiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iNjIuOTMiIHkxPSIzNy43MiIgeDI9IjcyLjYiIHkyPSIzNy43MiIvPjxsaW5lIGNsYXNzPSJjbHMtMTEiIHgxPSIxNTAuNyIgeTE9IjQ4LjQ5IiB4Mj0iMTc1LjU5IiB5Mj0iNDguNDkiLz48bGluZSBjbGFzcz0iY2xzLTEyIiB4MT0iMTEwLjMyIiB5MT0iNDguNDkiIHgyPSIxNDMuMDUiIHkyPSI0OC40OSIvPjxsaW5lIGNsYXNzPSJjbHMtMTEiIHgxPSI3OS4xNiIgeTE9IjQ4LjQ5IiB4Mj0iMTAxLjM3IiB5Mj0iNDguNDkiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iNjIuOTMiIHkxPSI0OC40OSIgeDI9IjcyLjYiIHkyPSI0OC40OSIvPjxsaW5lIGNsYXNzPSJjbHMtMTAiIHgxPSI3OS4xNiIgeTE9IjU5LjI2IiB4Mj0iMTUwLjciIHkyPSI1OS4yNiIvPjxsaW5lIGNsYXNzPSJjbHMtMTAiIHgxPSI2Mi45MyIgeTE9IjU5LjI2IiB4Mj0iNzIuNiIgeTI9IjU5LjI2Ii8+PGxpbmUgY2xhc3M9ImNscy0xMCIgeDE9Ijc5LjE2IiB5MT0iNzAuMDMiIHgyPSIxNzUuNTkiIHkyPSI3MC4wMyIvPjxsaW5lIGNsYXNzPSJjbHMtMTAiIHgxPSI2Mi45MyIgeTE9IjcwLjAzIiB4Mj0iNzIuNiIgeTI9IjcwLjAzIi8+PGxpbmUgY2xhc3M9ImNscy0xMSIgeDE9Ijc5LjE2IiB5MT0iODAuNzkiIHgyPSIxMTcuMjQiIHkyPSI4MC43OSIvPjxsaW5lIGNsYXNzPSJjbHMtMTAiIHgxPSI2Mi45MyIgeTE9IjgwLjc5IiB4Mj0iNzIuNiIgeTI9IjgwLjc5Ii8+PGxpbmUgY2xhc3M9ImNscy0xMyIgeDE9Ijc5LjE2IiB5MT0iOTEuNTYiIHgyPSIxNDkuMDYiIHkyPSI5MS41NiIvPjxsaW5lIGNsYXNzPSJjbHMtMTAiIHgxPSI2Mi45MyIgeTE9IjkxLjU2IiB4Mj0iNzIuNiIgeTI9IjkxLjU2Ii8+PGxpbmUgY2xhc3M9ImNscy0xMCIgeDE9IjYyLjkzIiB5MT0iODAuNzkiIHgyPSI3Mi42IiB5Mj0iODAuNzkiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iNjIuOTMiIHkxPSI5MS41NiIgeDI9IjcyLjYiIHkyPSI5MS41NiIvPjxsaW5lIGNsYXNzPSJjbHMtMTEiIHgxPSI3OS4xNiIgeTE9IjEwMi4zMyIgeDI9IjExNy4yNCIgeTI9IjEwMi4zMyIvPjxsaW5lIGNsYXNzPSJjbHMtMTAiIHgxPSI2Mi45MyIgeTE9IjEwMi4zMyIgeDI9IjcyLjYiIHkyPSIxMDIuMzMiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iMTI1Ljk4IiB5MT0iMTEzLjEiIHgyPSIxNDkuMDYiIHkyPSIxMTMuMSIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSI3OS4xNiIgeTE9IjExMy4xIiB4Mj0iMTE3LjI0IiB5Mj0iMTEzLjEiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iNjIuOTMiIHkxPSIxMTMuMSIgeDI9IjcyLjYiIHkyPSIxMTMuMSIvPjwvZz48L2c+PC9zdmc+'","title":"Pagination"},{"anchor":"partial-response","body":"\nBy default, each endpoint returns the full representation of a resource and in\nsome cases that can be a lot of data. For example, retrieving a list of pull\nrequests can amount to quite a large document.\n\nFor better performance, you can ask the server to only return the fields you\nreally need and to omit unwanted data. To request a partial response and to\nadd or remove specific fields from a response, use the `fields` query\nparameter.\n\n\n### Example\n\nMost API resources embed a substantial list of links pointing to related\nresources. This saves the client from constructing its own URLs, but is\nsomewhat wasteful when the client doesn't need them.\n\nTo significantly reduce the size of the response, use `?fields=-links`:\n\n```json\n$ curl https://api.bitbucket.org/2.0/users/evzijst?fields=-links\n{\n \"nickname\": \"evzijst\",\n \"account_status\": \"active\",\n \"website\": \"\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{a288a0ab-e13b-43f0-a689-c4ef0a249875}\",\n \"created_on\": \"2010-07-07T05:16:36+00:00\",\n \"location\": null,\n \"type\": \"user\"\n}\n```\n\n### Fields parameter syntax\n\nThe `fields` parameter supports 3 modes of operation:\n\n1. Removal of select fields (e.g. `-links`)\n2. Pulling in additional fields not normally returned by an endpoint, while\n still getting all the default fields (e.g. `+reviewers`)\n3. Omitting all fields, except those specified (e.g. `owner.display_name`)\n\nThe fields parameter can contain a list of multiple comma-separated field names\n(e.g. `fields=owner.display_name,uuid,links.self.href`). The parameter itself is\nnot repeated.\n\nAs discussed at [Condensed Versus Full Objects](serialization#representations),\nmost objects that are embedded inside other objects (like how `owner` is an\nembedded `user` object in `repository`) appear in \"condensed\" form that omits\nmany fields. The `fields` parameter allows us to pull in additional fields in\nsuch cases.\n\nFor example, the embedded repository object in a pull request does not normally\ncontain its `owner`. To add that in we can use:\n`+values.destination.repository.owner`.\n\n\n### Wildcards\n\nThe asterisk can be used to match all fields on a particular level. For\nexample, removing all entries from the `links` element can be done like this:\n\n```json\n$ curl https://api.bitbucket.org/2.0/users/evzijst?fields=-links.*\n{\n \"nickname\": \"evzijst\",\n \"account_status\": \"active\",\n \"website\": \"\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{a288a0ab-e13b-43f0-a689-c4ef0a249875}\",\n \"links\": {},\n \"created_on\": \"2010-07-07T05:16:36+00:00\",\n \"location\": null,\n \"type\": \"user\"\n}\n```\n\nWildcards can be used in combination with exclusion and inclusion. For\ninstance, `-*,+foo,+bar` will remove all elements from the root level and then\nadd in `foo` and `bar`.\n\n\n### URL encoding\n\nBe aware that when using the `+foo.bar` syntax in the query string, that the\n\"+\" must be URL encoded as \"%2B\" and so the URL will be:\n\n```\nhttps://api.bitbucket.org/2.0/repositories/evzijst/interruptingcow?fields=%2Bowner.created_on\n```\n\nWithout URL escaping, \"+\" is interpreted as an encoded space which will not\nmatch any fields.\n\n\n### Field discovery\n\nWhile a resource's `self` URL, as well its \"collection\" URL typically return\nthe full object with all its fields, there are some exceptions for fields that\nare overly verbose or costly to generate.\n\nFor instance, a pull request contains the embedded lists of reviewers and\nparticipants. These fields are included from the `self` URL, but not from the\n`/pullrequests` collections resource, as it would impact performance too much.\n\nTo discover any additional fields that might not be included by default,\n`fields=*` can be used.\n\n\n### More examples\n\nIf we want to get a list of all reviewer nicknames on pull requests I created,\nwe could combine a [filter](filtering) with a partial response. This will omit\nall other data from the response:\n\n```\n/2.0/repositories/bitbucket/bitbucket/pullrequests?fields=values.id,values.reviewers.nickname,values.state&q=author.uuid%3D%22%7Bd301aafa-d676-4ee0-88be-962be7417567%7D%22\n{\n \"values\": [\n {\n \"reviewers\": [\n {\n \"nickname\": \"abhin\"\n },\n {\n \"nickname\": \"dtao\"\n },\n {\n \"nickname\": \"csomme\"\n }\n ],\n \"state\": \"OPEN\",\n \"id\": 11355\n },\n {\n \"reviewers\": [\n {\n \"nickname\": \"csomme\"\n },\n {\n \"nickname\": \"abhin\"\n },\n {\n \"nickname\": \"dstevens\"\n }\n ],\n \"state\": \"MERGED\",\n \"id\": 11347\n },\n {\n \"reviewers\": [\n {\n \"nickname\": \"csomme\"\n },\n {\n \"nickname\": \"jmooring\"\n },\n {\n \"nickname\": \"zdavis\"\n },\n {\n \"nickname\": \"flexbox\"\n }\n ],\n \"state\": \"OPEN\",\n \"id\": 11344\n }\n ]\n}\n```\n","description":"Tweak which fields are returned","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMTYyLjQ0ODcgMjEwLjExMTUiPgogIDxkZWZzPgogICAgPHN0eWxlPgogICAgICAuY2xzLTEgewogICAgICAgIGlzb2xhdGlvbjogaXNvbGF0ZTsKICAgICAgfQoKICAgICAgLmNscy0yLCAuY2xzLTYsIC5jbHMtOCB7CiAgICAgICAgZmlsbDogbm9uZTsKICAgICAgfQoKICAgICAgLmNscy0yLCAuY2xzLTggewogICAgICAgIHN0cm9rZTogIzAwNjVmZjsKICAgICAgICBzdHJva2Utd2lkdGg6IDJweDsKICAgICAgfQoKICAgICAgLmNscy0yIHsKICAgICAgICBzdHJva2UtbGluZWpvaW46IHJvdW5kOwogICAgICB9CgogICAgICAuY2xzLTMgewogICAgICAgIGZpbGw6ICNlN2U4ZWM7CiAgICAgIH0KCiAgICAgIC5jbHMtNCB7CiAgICAgICAgZmlsbDogI2ZmZTM4MDsKICAgICAgfQoKICAgICAgLmNscy01IHsKICAgICAgICBmaWxsOiAjZmZmMGIyOwogICAgICB9CgogICAgICAuY2xzLTYgewogICAgICAgIHN0cm9rZTogI2ZmOTkxZjsKICAgICAgICBzdHJva2Utd2lkdGg6IDEuODE1NnB4OwogICAgICB9CgogICAgICAuY2xzLTYsIC5jbHMtOCB7CiAgICAgICAgc3Ryb2tlLW1pdGVybGltaXQ6IDEwOwogICAgICB9CgogICAgICAuY2xzLTcgewogICAgICAgIG1peC1ibGVuZC1tb2RlOiBtdWx0aXBseTsKICAgICAgICBmaWxsOiB1cmwoI2xpbmVhci1ncmFkaWVudCk7CiAgICAgIH0KCiAgICAgIC5jbHMtOSB7CiAgICAgICAgZmlsbDogI2Y0ZjVmNzsKICAgICAgfQogICAgPC9zdHlsZT4KICAgIDxsaW5lYXJHcmFkaWVudCBpZD0ibGluZWFyLWdyYWRpZW50IiB4MT0iMTEzLjM4MTgiIHkxPSI0OS40MyIgeDI9IjE1My43ODkzIiB5Mj0iOS4wMjI1IiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+CiAgICAgIDxzdG9wIG9mZnNldD0iMCIgc3RvcC1jb2xvcj0iI2ZhZmJmYyIvPgogICAgICA8c3RvcCBvZmZzZXQ9IjAuMjc4NiIgc3RvcC1jb2xvcj0iI2VmZjFmMyIvPgogICAgICA8c3RvcCBvZmZzZXQ9IjAuNzY4OCIgc3RvcC1jb2xvcj0iI2QxZDZkZCIvPgogICAgICA8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNjMWM3ZDAiLz4KICAgIDwvbGluZWFyR3JhZGllbnQ+CiAgPC9kZWZzPgogIDx0aXRsZT5Eb2N1bWVudCBUYWJsZTwvdGl0bGU+CiAgPGcgY2xhc3M9ImNscy0xIj4KICAgIDxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPgogICAgICA8ZyBpZD0iT2JqZWN0cyI+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy0yIiB4MT0iMTcuNDcxIiB5MT0iMTcxLjc1NzMiIHgyPSI3OS4yOTgiIHkyPSIxNzEuNzU3MyIvPgogICAgICAgIDxwb2x5Z29uIGlkPSJfUGF0aF8iIGRhdGEtbmFtZT0iJmx0O1BhdGgmZ3Q7IiBjbGFzcz0iY2xzLTMiIHBvaW50cz0iMTYyLjQ0NSAzOC43MTEgMTYyLjQ0NSAyMTAuMTExIDAgMjEwLjExMSAwIDAgMTIzLjcwNCAwIDE2Mi40MTUgMzguNzExIDE2Mi40NDUgMzguNzExIi8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy00IiB4PSIxOC45MTE3IiB5PSI3OC4xNTQyIiB3aWR0aD0iNDcuODQ4NSIgaGVpZ2h0PSI3OS42NTM3Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy01IiB4PSIxOC45MTE3IiB5PSI1MS42MDMiIHdpZHRoPSIxMjMuNDUyOSIgaGVpZ2h0PSIyNi41NTEyIi8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy02IiB4PSIxOC45MTE3IiB5PSI1MS42MDMiIHdpZHRoPSIxMjMuNDUyOSIgaGVpZ2h0PSIxMDYuMjA0OSIvPgogICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtNiIgeDE9IjY2Ljc2MDEiIHkxPSI1MS42MDMiIHgyPSI2Ni43NjAxIiB5Mj0iMTU3LjgwNzkiLz4KICAgICAgICA8bGluZSBjbGFzcz0iY2xzLTYiIHgxPSI5MS4zMjg0IiB5MT0iNTEuNjAzIiB4Mj0iOTEuMzI4NCIgeTI9IjE1Ny44MDc5Ii8+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy02IiB4MT0iMTE1Ljg5NjciIHkxPSI1MS42MDMiIHgyPSIxMTUuODk2NyIgeTI9IjE1Ny44MDc5Ii8+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy02IiB4MT0iMTguOTExNyIgeTE9Ijc4LjE1NDIiIHgyPSIxNDIuMzY0NiIgeTI9Ijc4LjE1NDIiLz4KICAgICAgICA8bGluZSBjbGFzcz0iY2xzLTYiIHgxPSIxOC45MTE3IiB5MT0iMTA0LjcwNTUiIHgyPSIxNDIuMzY0NiIgeTI9IjEwNC43MDU1Ii8+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy02IiB4MT0iMTguOTExNyIgeTE9IjEzMS4yNTY3IiB4Mj0iMTQyLjM2NDYiIHkyPSIxMzEuMjU2NyIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtNyIgcG9pbnRzPSIxNjIuNDQ1IDM4LjcxMSAxNjIuNDE1IDM4LjcxMSAxMjMuODcyIDAuMTY5IDEyMy44NzIgNTkuOTIxIDE2Mi40NDUgMzkuMTM3IDE2Mi40NDUgMzguNzExIi8+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy04IiB4MT0iMTguMzk3MyIgeTE9IjE4MS4zNDQiIHgyPSI3OS4xMTM1IiB5Mj0iMTgxLjM0NCIvPgogICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtOCIgeDE9IjE4LjM5NzMiIHkxPSIxOTAuOTMwNiIgeDI9IjUxLjMwNDkiIHkyPSIxOTAuOTMwNiIvPgogICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtOCIgeDE9IjE4LjM5NzMiIHkxPSIxNzEuNzU3MyIgeDI9Ijc5LjExMzUiIHkyPSIxNzEuNzU3MyIvPgogICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtOCIgeDE9IjE4LjM5NzMiIHkxPSIzNi4xNzA1IiB4Mj0iNzkuMTEzNSIgeTI9IjM2LjE3MDUiLz4KICAgICAgICA8bGluZSBjbGFzcz0iY2xzLTgiIHgxPSIxOC4zOTczIiB5MT0iMjYuNTgzOCIgeDI9Ijc5LjExMzUiIHkyPSIyNi41ODM4Ii8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy05IiBwb2ludHM9IjE2Mi40NDkgMzguNzQyIDEyMy43MDcgMzguNzQyIDEyMy43MDcgMCAxNjIuNDQ5IDM4Ljc0MiIvPgogICAgICA8L2c+CiAgICA8L2c+CiAgPC9nPgo8L3N2Zz4K'","title":"Partial responses"},{"anchor":"serialization","body":"\n----\n\n* [Open API Specification](#open-api-specification)\n* [JSON Schema](#json-schema)\n* [Condensed Versus Full Objects](#condensed-versus-full-objects)\n\n____\n\n\n### Open API Specification\n\nBitbucket uses the [Open API Specification](https://openapis.org) (OAI,\nformerly known as Swagger) to describe its APIs. Our OAI specification schema\nis hosted at [https://api.bitbucket.org/swagger.json](https://api.bitbucket.org/swagger.json)\nand serves as the canonical definition and comprehensive declaration of all\navailable endpoints.\n\nThe OAI specification makes writing client applications easier by:\nauto-generating boilerplate code (like data object classes) and dealing with\nauthentication and error handling.\n\nYou can find a comprehensive set of open tools for the OAI specification at:\n[https://github.com/swagger-api](https://github.com/swagger-api).\n\n\n### JSON Schema\n\nBitbucket uses JSON Schema to describe the layout of every type of object\nconsumed or produced by the API. These schemas are collected under the\n`#definitions` element of our swagger.json file.\n\nWhen an endpoint expects an object as part of a POST or PUT, it also expects\nthe object to validate against the JSON schemas. The same applies to objects\nreturned by an endpoint.\n\n\n### Condensed Versus Full Objects\n\nMost objects in Bitbucket come both in \"full\" and \"partial\" representation.\nThe full representation is when all elements are included. This is the layout\nreturned by a resource's `self` location (e.g. `/2.0/repositories/foo/bar`),\nas well as resource collection endpoints (e.g. `/2.0/repositories`).\n\nHowever, Bitbucket objects often embed other objects. For example, a `repository`\nobject embeds a `user` object for its owner. Likewise, a `pullrequest` object\nembeds its `repository` object.\n\nThese related objects are embedded, or inlined, to reduce the \"chatter\" when\nclients make frequent followup API calls to collect information on common,\nrelated information.\n\nEmbedded related objects are typically limited in their fields to avoid such\nobject graphs from becoming too deep and noisy. They often exclude their own\nnested objects in an attempt to strike a balance between performance and\nutility.\n\nAn object's embedded or condensed representation tends to be standardized,\nmeaning the fields included is the same set, regardless of where the object\nwas embedded.\n","description":"Learn more about object representations","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMjAuNzYyNCAyMDUuNTg2Ij4KICA8ZGVmcz4KICAgIDxzdHlsZT4KICAgICAgLmNscy0xIHsKICAgICAgICBpc29sYXRpb246IGlzb2xhdGU7CiAgICAgIH0KCiAgICAgIC5jbHMtMiwgLmNscy02IHsKICAgICAgICBtaXgtYmxlbmQtbW9kZTogbXVsdGlwbHk7CiAgICAgIH0KCiAgICAgIC5jbHMtMTMsIC5jbHMtMywgLmNscy00LCAuY2xzLTYgewogICAgICAgIGZpbGw6IG5vbmU7CiAgICAgICAgc3Ryb2tlOiAjYzFjN2QwOwogICAgICAgIHN0cm9rZS1saW5lY2FwOiByb3VuZDsKICAgICAgICBzdHJva2UtbWl0ZXJsaW1pdDogMTA7CiAgICAgICAgc3Ryb2tlLXdpZHRoOiAycHg7CiAgICAgIH0KCiAgICAgIC5jbHMtNCB7CiAgICAgICAgc3Ryb2tlLWRhc2hhcnJheTogMy43ODE2IDUuMjk0MzsKICAgICAgfQoKICAgICAgLmNscy01IHsKICAgICAgICBmaWxsOiAjMDA2NWZmOwogICAgICB9CgogICAgICAuY2xzLTYgewogICAgICAgIHN0cm9rZS1kYXNoYXJyYXk6IDMuOTIxOSA1LjQ5MDc7CiAgICAgIH0KCiAgICAgIC5jbHMtNyB7CiAgICAgICAgZmlsbDogIzAwNTJjYzsKICAgICAgfQoKICAgICAgLmNscy04IHsKICAgICAgICBmaWxsOiAjNGM5YWZmOwogICAgICB9CgogICAgICAuY2xzLTkgewogICAgICAgIGZpbGw6ICMwMDQ5YjA7CiAgICAgIH0KCiAgICAgIC5jbHMtMTAgewogICAgICAgIGZpbGw6ICM1N2Q5YTM7CiAgICAgIH0KCiAgICAgIC5jbHMtMTEgewogICAgICAgIGZpbGw6ICM3OWYyYzA7CiAgICAgIH0KCiAgICAgIC5jbHMtMTIgewogICAgICAgIGZpbGw6ICMzNmIzN2U7CiAgICAgIH0KCiAgICAgIC5jbHMtMTMgewogICAgICAgIHN0cm9rZS1kYXNoYXJyYXk6IDMuODY4MSA1LjQxNTQ7CiAgICAgIH0KCiAgICAgIC5jbHMtMTQgewogICAgICAgIGZpbGw6ICM0MjUyNmU7CiAgICAgIH0KCiAgICAgIC5jbHMtMTUgewogICAgICAgIGZpbGw6ICMzNDQ1NjM7CiAgICAgIH0KCiAgICAgIC5jbHMtMTYgewogICAgICAgIGZpbGw6ICM1MDVmNzk7CiAgICAgIH0KICAgIDwvc3R5bGU+CiAgPC9kZWZzPgogIDx0aXRsZT5JbnRlZ3JhdGlvbnM8L3RpdGxlPgogIDxnIGNsYXNzPSJjbHMtMSI+CiAgICA8ZyBpZD0iTGF5ZXJfMiIgZGF0YS1uYW1lPSJMYXllciAyIj4KICAgICAgPGcgaWQ9Ik9iamVjdHMiPgogICAgICAgIDxnIGNsYXNzPSJjbHMtMiI+CiAgICAgICAgICA8Zz4KICAgICAgICAgICAgPGxpbmUgY2xhc3M9ImNscy0zIiB4MT0iNzUuMjExNCIgeTE9IjE4Ny44NTczIiB4Mj0iNzcuMDI0OCIgeTI9IjE4Ny4xMTA5Ii8+CiAgICAgICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtNCIgeDE9IjgxLjkyMDUiIHkxPSIxODUuMDk1NiIgeDI9IjEzOC4yMjEyIiB5Mj0iMTYxLjkyMDMiLz4KICAgICAgICAgICAgPGxpbmUgY2xhc3M9ImNscy0zIiB4MT0iMTQwLjY2OSIgeTE9IjE2MC45MTI2IiB4Mj0iMTQyLjQ4MjQiIHkyPSIxNjAuMTY2MiIvPgogICAgICAgICAgPC9nPgogICAgICAgIDwvZz4KICAgICAgICA8cG9seWdvbiBjbGFzcz0iY2xzLTUiIHBvaW50cz0iMTk0LjUyNiAyNi41NTIgMTc2LjkwMSAzOC4yNDEgMTU5LjI3IDI2LjU1MiAxNzYuOTAxIDE0Ljg3IDE5NC41MjYgMjYuNTUyIi8+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy02IiB4MT0iMTgzLjcxMzUiIHkxPSI0My4yMTg4IiB4Mj0iMTgzLjcxMzUiIHkyPSI5Ny44ODMyIi8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy03IiBwb2ludHM9IjE3Ni45MDEgMzguMjQxIDE3Ni45MDEgNTguMTY2IDE1OS4yNyA0Ni40NzcgMTU5LjI3IDI2LjU1MiAxNzYuOTAxIDM4LjI0MSIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtOCIgcG9pbnRzPSIxOTQuNTI2IDI2LjU1MiAxOTQuNTI2IDQ2LjQ3NyAxNzYuOTAxIDU4LjE2NiAxNzYuOTAxIDM4LjI0MSAxOTQuNTI2IDI2LjU1MiIvPgogICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtNiIgeDE9IjQ3Ljk0ODgiIHkxPSI0Mi4yMTg4IiB4Mj0iMTU5LjExNzIiIHkyPSI0Mi4yMTg4Ii8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy01IiBwb2ludHM9IjIyMC43NjIgOTkuNzUyIDE2Ny44MTcgMTM0Ljg2NCAxMTQuODU0IDk5Ljc1MiAxNjcuODE3IDY0LjY1NyAyMjAuNzYyIDk5Ljc1MiIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtOSIgcG9pbnRzPSIxNjcuODE3IDEzNC44NjQgMTY3LjgxNyAxOTQuNzE4IDExNC44NTQgMTU5LjYwNiAxMTQuODU0IDk5Ljc1MiAxNjcuODE3IDEzNC44NjQiLz4KICAgICAgICA8cG9seWdvbiBjbGFzcz0iY2xzLTgiIHBvaW50cz0iMjIwLjc2MiA5OS43NTIgMjIwLjc2MiAxNTkuNjA2IDE2Ny44MTcgMTk0LjcxOCAxNjcuODE3IDEzNC44NjQgMjIwLjc2MiA5OS43NTIiLz4KICAgICAgICA8cG9seWdvbiBjbGFzcz0iY2xzLTEwIiBwb2ludHM9IjExMC41NDEgMjEuNjA0IDc3Ljk0OSA0My4yMTkgNDUuMzQ1IDIxLjYwNCA3Ny45NDkgMCAxMTAuNTQxIDIxLjYwNCIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtMTEiIHBvaW50cz0iMTEwLjU0MSAyMS42MDQgMTEwLjU0MSA1OC40NDkgNzcuOTQ5IDgwLjA2NCA3Ny45NDkgNDMuMjE5IDExMC41NDEgMjEuNjA0Ii8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy01IiBwb2ludHM9IjE0MS4xOSAxNDguMDczIDE2Ny44MTMgMTMwLjQxNyAxOTQuNDQ0IDE0OC4wNzMgMTY3LjgxMyAxNjUuNzE5IDE0MS4xOSAxNDguMDczIi8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy05IiBwb2ludHM9IjE2Ny44MTMgMTMwLjQxNyAxNjcuODEzIDEwMC4zMjEgMTk0LjQ0NCAxMTcuOTc2IDE5NC40NDQgMTQ4LjA3MyAxNjcuODEzIDEzMC40MTciLz4KICAgICAgICA8cG9seWdvbiBjbGFzcz0iY2xzLTgiIHBvaW50cz0iMTQxLjE5IDE0OC4wNzMgMTQxLjE5IDExNy45NzYgMTY3LjgxMyAxMDAuMzIxIDE2Ny44MTMgMTMwLjQxNyAxNDEuMTkgMTQ4LjA3MyIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtMTIiIHBvaW50cz0iNDUuMzQ1IDIxLjYwNCA0NS4zNDUgNDQuOTg0IDU3LjIzMSA1Mi44NjQgNTcuMjMxIDY2LjI5NiA3Ny45NDkgODAuMDY0IDc3Ljk0OSA0My4yMTkgNDUuMzQ1IDIxLjYwNCIvPgogICAgICAgIDxnIGNsYXNzPSJjbHMtMiI+CiAgICAgICAgICA8Zz4KICAgICAgICAgICAgPGxpbmUgY2xhc3M9ImNscy0zIiB4MT0iMjQuNjQzOCIgeTE9Ijg2Ljk1NDQiIHgyPSIyNi4wMTU3IiB5Mj0iODUuNTUzMSIvPgogICAgICAgICAgICA8bGluZSBjbGFzcz0iY2xzLTEzIiB4MT0iMjkuODA0IiB5MT0iODEuNjgzNCIgeDI9IjYwLjM4MTEiIHkyPSI1MC40NDkyIi8+CiAgICAgICAgICAgIDxsaW5lIGNsYXNzPSJjbHMtMyIgeDE9IjYyLjI3NTIiIHkxPSI0OC41MTQzIiB4Mj0iNjMuNjQ3IiB5Mj0iNDcuMTEzIi8+CiAgICAgICAgICA8L2c+CiAgICAgICAgPC9nPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtNSIgcG9pbnRzPSIzNS4yNTUgODkuNjQ1IDE3LjczNiAxMDEuNDkyIDAgODkuOTYyIDE3LjUyNSA3OC4xMjEgMzUuMjU1IDg5LjY0NSIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtNyIgcG9pbnRzPSIxNy43MzYgMTAxLjQ5MiAxNy45MTUgMTIxLjQxNiAwLjE3OSAxMDkuODg3IDAgODkuOTYyIDE3LjczNiAxMDEuNDkyIi8+CiAgICAgICAgPGxpbmUgY2xhc3M9ImNscy02IiB4MT0iMjAuNTg0OSIgeTE9IjEwNS41MzA1IiB4Mj0iNjUuODc0OSIgeTI9IjE3MS4zNjgxIi8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy04IiBwb2ludHM9IjM1LjI1NSA4OS42NDUgMzUuNDM0IDEwOS41NjkgMTcuOTE1IDEyMS40MTYgMTcuNzM2IDEwMS40OTIgMzUuMjU1IDg5LjY0NSIvPgogICAgICAgIDxwb2x5Z29uIGNsYXNzPSJjbHMtMTQiIHBvaW50cz0iOTIuMzk0IDE3My44MTUgNzQuODc1IDE4NS42NjIgNTcuMTM5IDE3NC4xMzIgNzQuNjY0IDE2Mi4yOTEgOTIuMzk0IDE3My44MTUiLz4KICAgICAgICA8cG9seWdvbiBjbGFzcz0iY2xzLTE1IiBwb2ludHM9Ijc0Ljg3NSAxODUuNjYyIDc1LjA1NCAyMDUuNTg2IDU3LjMxOSAxOTQuMDU3IDU3LjEzOSAxNzQuMTMyIDc0Ljg3NSAxODUuNjYyIi8+CiAgICAgICAgPHBvbHlnb24gY2xhc3M9ImNscy0xNiIgcG9pbnRzPSI5Mi4zOTQgMTczLjgxNSA5Mi41NzQgMTkzLjczOSA3NS4wNTQgMjA1LjU4NiA3NC44NzUgMTg1LjY2MiA5Mi4zOTQgMTczLjgxNSIvPgogICAgICA8L2c+CiAgICA8L2c+CiAgPC9nPgo8L3N2Zz4K'","title":"Schemas and Serialization"},{"anchor":"uri-uuid","body":"\nYou should be familiar with REST architecture before writing an integration. Read this overview page to gain a good understanding of Bitbucket's REST implementation.\n\n----\n\n* [URI structure](#uri-structure)\n* [HTTP methods](#http-methods)\n* [UUID](#universally-unique-identifier)\n * [User object and UUID](#user-object-and-uuid)\n * [Repository object and UUID](#repository-object-and-uuid)\n * [Team object and UUID](#team-object-and-uuid)\n* [Standard error responses](#standardized-error-responses)\n* [Standard ISO-8601 timestamps](#standard-iso-8601-timestamps)\n\n----\n\n\n### URI structure\n\nAll Bitbucket Cloud requests start with the `https://api.bitbucket.org/2.0` prefix (for the 2.0 API) and `https://api.bitbucket.org/1.0` prefix (1.0 API).\n\nThe next segment of the URI path depends on the endpoint of the request. For example, using the curl command and the repositories endpoint you can list all the issues on Bitbucket's tutorial repository:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/tutorials/tutorials.bitbucket.org\n```\nGiven a specific endpoint, you can then drill down to a particular aspect or resource of that endpoint. The issues resource on a repository is an example:\n\n```\ncurl https://api.bitbucket.org/1.0/repositories/tutorials/tutorials.bitbucket.org/issues\n```\n\n#### HTTP methods\n\nA given endpoint or resource has a series of actions (or methods) associated with it. The Bitbucket service supports these standard HTTP methods:\n\n| Call | Description |\n|------|-------------|\n| GET | Retrieves information. |\n| PUT | Updates existing information. |\n| POST | Creates new information. |\n| DELETE | Removes existing information. |\n\nFor example, you can call use the POST action on the issues resource and create an issue on the issue tracker.\n\n**Specifying content length**\n\nYou can get a `411 Length Required` response. If this happens, the API requires a Content-Length header but the client is not sending it. You should add the header yourself, for example using the curl client:\n\n```\ncurl -r PUT --header \"Content-Length: 0\" -u user:app_password https://api.bitbucket.org/1.0/emails/rap@atlassian.com\n```\n\n### Universally Unique Identifier\n\nUUID's provide a single point of recognition for users, teams, and repositories. The UUID is distinct from the username, team name, and repository name fields and remains the same even when those fields change. For example when a user changes their username or moves a repository you will need to modify calls which use those identifiers but not if you are pointing to the UUID.\n\n#### UUID examples and structure\n\nUUID's work with both the 1.0 and 2.0 APIs for the user, team, and repository objects. The following examples the following characters are replacements for curly brackets: `%7B` replaces `{` and `%7D` replaces `}`. You will see this structure in the following example sections.\n\n#### User object and UUID\n\nWhen you make a call using either the username or the UUID for that user the response is the same.\n\n**Call with username**:\n\n```\ncurl https://api.bitbucket.org/2.0/users/tutorials\n```\n\n***Call with UUID for the user**:\n\n```\ncurl https://api.bitbucket.org/2.0/users/%7Bc788b2da-b7a2-404c-9e26-d3f077557007%7D\n```\n\n**Response**\n```JSON\n{\n \"username\": \"tutorials\",\n \"nickname\": \"tutorials\",\n \"account_status\": \"active\",\n \"website\": \"https://tutorials.bitbucket.org/\",\n \"display_name\": \"tutorials account\",\n \"uuid\": \"{c788b2da-b7a2-404c-9e26-d3f077557007}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials\"\n },\n \"repositories\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/tutorials\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/tutorials\"\n },\n \"followers\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/followers\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2013/Nov/25/tutorials-avatar-1563784409-6_avatar.png\"\n },\n \"following\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/following\"\n }\n },\n \"created_on\": \"2011-12-20T16:34:07.132459+00:00\",\n \"location\": \"Santa Monica, CA\",\n \"type\": \"user\"\n}\n```\n\n#### Repository object and UUID\n\nOnce you have the UUID for a repository you no longer need a username or team name to make the API call so long as you use an empty field. This helps you resolve repositories no matter if the username or team name changes.\n\n**Call with team name (1team) and repository name (moxie)**:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/1team/moxie\n```\n**Call with UUID and empty field**:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/%7B%7D/%7B21fa9bf8-b5b2-4891-97ed-d590bad0f871%7D\n```\n\n**Call with UUID and teamname**:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/1team/%7B21fa9bf8-b5b2-4891-97ed-d590bad0f871%7D\n```\n\n**Response**\n\n```JSON\n{\n \"created_on\": \"2013-11-08T01:11:03.222520+00:00\",\n \"description\": \"\",\n \"fork_policy\": \"allow_forks\",\n \"full_name\": \"1team/moxie\",\n \"has_issues\": false,\n \"has_wiki\": false,\n \"is_private\": false,\n \"language\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/1team/moxie/avatar/32/\"\n },\n \"branches\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/refs/branches\"\n },\n \"clone\": [\n {\n \"href\": \"https://bitbucket.org/1team/moxie.git\",\n \"name\": \"https\"\n },\n {\n \"href\": \"ssh://git@bitbucket.org/1team/moxie.git\",\n \"name\": \"ssh\"\n }\n ],\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/commits\"\n },\n \"downloads\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/downloads\"\n },\n \"forks\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/forks\"\n },\n \"hooks\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/hooks\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/1team/moxie\"\n },\n \"pullrequests\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/pullrequests\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie\"\n },\n \"tags\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/refs/tags\"\n },\n \"watchers\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/1team/moxie/watchers\"\n }\n },\n \"name\": \"moxie\",\n \"owner\": {\n \"display_name\": \"the team\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/1team/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/1team/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/teams/1team\"\n }\n },\n \"type\": \"team\",\n \"username\": \"1team\",\n \"uuid\": \"{aa559944-83c9-4963-a9a8-69ac8d9cf5d2}\"\n },\n \"project\": {\n \"key\": \"PROJ\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/user/1team/projects/PROJ/avatar/32\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/account/user/1team/projects/PROJ\"\n }\n },\n \"name\": \"Untitled project\",\n \"type\": \"project\",\n \"uuid\": \"{ab52aaeb-16ad-4fb0-bb1d-47e4f00367ff}\"\n },\n \"scm\": \"git\",\n \"size\": 33348,\n \"type\": \"repository\",\n \"updated_on\": \"2013-11-08T01:11:03.263237+00:00\",\n \"uuid\": \"{21fa9bf8-b5b2-4891-97ed-d590bad0f871}\",\n \"website\": \"\"\n}\n```\n\n#### Team object and UUID\n\nThis example shows a call for a list of team members using both the team name and with the UUID for the team object. As the call is unauthenticated in the following example the response object will only show members with public profiles. The response is the same in either case.\n\n**Call with teamname**\n\n```\ncurl https://api.bitbucket.org/2.0/teams/1team/members\n```\n**Call with UUID for team object**\n\n```\ncurl https://api.bitbucket.org/2.0/teams/%7Baa559944-83c9-4963-a9a8-69ac8d9cf5d2%7D/members\n```\n\n**Response**\n\n```JSON\n{\n \"page\": 1,\n \"pagelen\": 50,\n \"size\": 2,\n \"values\": [\n {\n \"created_on\": \"2011-12-20T16:34:07.132459+00:00\",\n \"display_name\": \"tutorials account\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/tutorials/avatar/32/\"\n },\n \"followers\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/followers\"\n },\n \"following\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/following\"\n },\n \"hooks\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/hooks\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/tutorials/\"\n },\n \"repositories\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/tutorials\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials\"\n },\n \"snippets\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/tutorials\"\n }\n },\n \"location\": null,\n \"type\": \"user\",\n \"username\": \"tutorials\",\n \"nickname\": \"tutorials\",\n \"account_status\": \"active\",\n \"uuid\": \"{c788b2da-b7a2-404c-9e26-d3f077557007}\",\n \"website\": \"https://tutorials.bitbucket.org/\"\n },\n {\n \"created_on\": \"2013-12-10T14:44:13+00:00\",\n \"display_name\": \"Dan Stevens [Atlassian]\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/dans9190/avatar/32/\"\n },\n \"followers\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/dans9190/followers\"\n },\n \"following\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/dans9190/following\"\n },\n \"hooks\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/dans9190/hooks\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/dans9190/\"\n },\n \"repositories\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/dans9190\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/dans9190\"\n },\n \"snippets\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/dans9190\"\n }\n },\n \"location\": null,\n \"type\": \"user\",\n \"username\": \"dans9190\",\n \"nickname\": \"dans9190\",\n \"account_status\": \"active\",\n \"uuid\": \"{1cd06601-cd0e-4fce-be03-e9ac226978b7}\",\n \"website\": \"\"\n }\n ]\n}\n```\n\n### Standardized error responses\n\nThe 2.0 API standardizes the error response layout. The 2.0 API serves a JSON\nobject along with the appropriate HTTP status code. The JSON object provides a\ndetailed problem description.\n\n```json\n{\n \"type\": \"error\",\n \"error\": {\n \"message\": \"Bad request\",\n \"fields\": {\n \"src\": [\n \"This field is required.\"\n ]\n },\n \"detail\": \"You must specify a valid source branch when creating a pull request.\",\n \"id\": \"d23a1cc5178f7637f3d9bf2d13824258\",\n \"data\": {\n \"extra\": \"Optional, endpoint-specific data to further augment the error.\"\n }\n }\n}\n```\n\nThis object contains an error element which contains the following nested\nelements:\n\n| Element | Description |\n|---------|-------------|\n| message | A short description of the problem. This element is always present. Its value may be localized. |\n| fields | This optional element is used in response to POST or PUT operations in which clients have provided invalid input. It contains a list of one or more client-provided fields that failed validation. The values may be localized. |\n| detail | An optional detailed explanation of the failure. Its value may be localized.\n| id | An optional unique error identifier that identifies the error in Bitbucket's logging system. If you feel you hit a bug in an API and this field is provided, please mention it if you decide to contact support as it will greatly help us narrow down the problem. |\n\n### Standard ISO-8601 timestamps\n\nAll 2.0 APIs use standardized ISO-8601 timestamps. In most cases, our APIs return UTC timestamps and for these, the timezone offset part will be 00:00. In rare cases where the original localized timestamp has significance, the timezone offset may identify the event's original timezone.\n","description":"URL's, UUID's, errors, and timestamps","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMTc5LjI2IDE3Ny42NSI+PGRlZnM+PHN0eWxlPi5jbHMtMXtmaWxsOnVybCgjbGluZWFyLWdyYWRpZW50KTt9LmNscy0ye2ZpbGw6IzA5MWU0Mjt9LmNscy0xMCwuY2xzLTExLC5jbHMtMywuY2xzLTQsLmNscy05e2ZpbGw6bm9uZTt9LmNscy0ze3N0cm9rZTojOTljMWZmO30uY2xzLTMsLmNscy00e3N0cm9rZS1saW5lY2FwOnJvdW5kO3N0cm9rZS1saW5lam9pbjpyb3VuZDtzdHJva2Utd2lkdGg6MDt9LmNscy0xMiwuY2xzLTQsLmNscy05e3N0cm9rZTojZTVlOGVjO30uY2xzLTV7ZmlsbDojMzQ0NTYzO30uY2xzLTZ7ZmlsbDojZmY4YjAwO30uY2xzLTd7ZmlsbDojZmZjNDAwO30uY2xzLTh7ZmlsbDojMDA2NWZmO30uY2xzLTEwLC5jbHMtMTEsLmNscy0xMiwuY2xzLTEzLC5jbHMtOXtzdHJva2UtbWl0ZXJsaW1pdDoxMDtzdHJva2Utd2lkdGg6MnB4O30uY2xzLTEwe3N0cm9rZTojZmZhYjAwO30uY2xzLTExLC5jbHMtMTN7c3Ryb2tlOiMwMDY1ZmY7fS5jbHMtMTJ7ZmlsbDojOTljMWZmO30uY2xzLTEze2ZpbGw6I2U1ZThlYzt9PC9zdHlsZT48bGluZWFyR3JhZGllbnQgaWQ9ImxpbmVhci1ncmFkaWVudCIgeDE9IjAuNCIgeTE9IjE3OC4wNSIgeDI9IjE3OC44NSIgeTI9Ii0wLjQiIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj48c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiMwOTFlNDIiLz48c3RvcCBvZmZzZXQ9IjAuMDciIHN0b3AtY29sb3I9IiMwZDIyNDUiLz48c3RvcCBvZmZzZXQ9IjAuNDkiIHN0b3AtY29sb3I9IiMxZjMyNTMiLz48c3RvcCBvZmZzZXQ9IjAuNzkiIHN0b3AtY29sb3I9IiMyNTM4NTgiLz48L2xpbmVhckdyYWRpZW50PjwvZGVmcz48dGl0bGU+Q29kZTwvdGl0bGU+PGcgaWQ9IkxheWVyXzIiIGRhdGEtbmFtZT0iTGF5ZXIgMiI+PGcgaWQ9IlNvZnR3YXJlIj48cmVjdCBpZD0iX1JlY3RhbmdsZV8iIGRhdGEtbmFtZT0iJmx0O1JlY3RhbmdsZSZndDsiIGNsYXNzPSJjbHMtMSIgd2lkdGg9IjE3OS4yNiIgaGVpZ2h0PSIxNzcuNjUiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xNzkuMjYsMjYuNjRIMFY3MS43NUExNjYuNDEsMTY2LjQxLDAsMCwwLDYzLjI0LDU5LjUxYTE4OC40MSwxODguNDEsMCwwLDAsMTcuMzktOC4zNmMxOC40NC05LjQzLDQ4LjM3LTE3LjksOTguNjItMTNabS0xNTkuNDQsMzRoMFptMC0xNC4wOGgwWiIvPjxsaW5lIGNsYXNzPSJjbHMtMyIgeDE9IjE5LjgxIiB5MT0iNDYuNTgiIHgyPSIyNS4wNyIgeTI9IjQ2LjU4Ii8+PGxpbmUgY2xhc3M9ImNscy0zIiB4MT0iMjUuMDciIHkxPSI2MC42NiIgeDI9IjE5LjgxIiB5Mj0iNjAuNjYiLz48bGluZSBjbGFzcz0iY2xzLTMiIHgxPSIxOS44MSIgeTE9Ijc0Ljc0IiB4Mj0iMjUuMDciIHkyPSI3NC43NCIvPjxsaW5lIGNsYXNzPSJjbHMtMyIgeDE9IjI1LjA3IiB5MT0iODguODIiIHgyPSIxOS44MSIgeTI9Ijg4LjgyIi8+PGxpbmUgY2xhc3M9ImNscy0zIiB4MT0iMjUuMDciIHkxPSIxMDIuODkiIHgyPSIxOS44MSIgeTI9IjEwMi44OSIvPjxsaW5lIGNsYXNzPSJjbHMtMyIgeDE9IjI1LjA3IiB5MT0iMTE2Ljk3IiB4Mj0iMTkuODEiIHkyPSIxMTYuOTciLz48bGluZSBjbGFzcz0iY2xzLTMiIHgxPSIyNS4wNyIgeTE9IjEzMS4wNSIgeDI9IjE5LjgxIiB5Mj0iMTMxLjA1Ii8+PGxpbmUgY2xhc3M9ImNscy0zIiB4MT0iMjUuMDciIHkxPSIxNDUuMTMiIHgyPSIxOS44MSIgeTI9IjE0NS4xMyIvPjxsaW5lIGNsYXNzPSJjbHMtMyIgeDE9IjI1LjA3IiB5MT0iMTU5LjIxIiB4Mj0iMTkuODEiIHkyPSIxNTkuMjEiLz48bGluZSBjbGFzcz0iY2xzLTQiIHgxPSI1NS44OSIgeTE9IjEzMS4wNSIgeDI9IjkzLjk5IiB5Mj0iMTMxLjA1Ii8+PGxpbmUgY2xhc3M9ImNscy00IiB4MT0iNTUuODkiIHkxPSIxNDUuMTMiIHgyPSIxMzkuNjciIHkyPSIxNDUuMTMiLz48cmVjdCBjbGFzcz0iY2xzLTUiIHdpZHRoPSIxNzkuMjYiIGhlaWdodD0iMjYuNjQiLz48Y2lyY2xlIGNsYXNzPSJjbHMtNiIgY3g9IjEzLjUiIGN5PSIxMi4wOCIgcj0iNS4xMSIvPjxjaXJjbGUgY2xhc3M9ImNscy03IiBjeD0iMzAuMTgiIGN5PSIxMi4wOCIgcj0iNS4xMSIvPjxjaXJjbGUgY2xhc3M9ImNscy04IiBjeD0iNDYuODYiIGN5PSIxMi4wOCIgcj0iNS4xMSIvPjxwYXRoIGNsYXNzPSJjbHMtOSIgZD0iTTc1LjQxLDg4LjgyIi8+PHBhdGggY2xhc3M9ImNscy05IiBkPSJNMzIuODksODguODIiLz48bGluZSBjbGFzcz0iY2xzLTEwIiB4MT0iMzIuODkiIHkxPSI3NC43NCIgeDI9Ijc1LjQxIiB5Mj0iNzQuNzQiLz48bGluZSBjbGFzcz0iY2xzLTExIiB4MT0iMzIuODkiIHkxPSI2MC42NiIgeDI9Ijc1LjQxIiB5Mj0iNjAuNjYiLz48bGluZSBjbGFzcz0iY2xzLTkiIHgxPSIzMi44OSIgeTE9IjQ2LjU4IiB4Mj0iNTUuODkiIHkyPSI0Ni41OCIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSIxOS44MSIgeTE9IjQ2LjU4IiB4Mj0iMjUuMDciIHkyPSI0Ni41OCIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSIxOS44MSIgeTE9IjYwLjY2IiB4Mj0iMjUuMDciIHkyPSI2MC42NiIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSIxOS44MSIgeTE9Ijc0Ljc0IiB4Mj0iMjUuMDciIHkyPSI3NC43NCIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSIxOS44MSIgeTE9Ijg4LjgyIiB4Mj0iMjUuMDciIHkyPSI4OC44MiIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSIxOS44MSIgeTE9IjEwMi44OSIgeDI9IjI1LjA3IiB5Mj0iMTAyLjg5Ii8+PGxpbmUgY2xhc3M9ImNscy0xMiIgeDE9IjE5LjgxIiB5MT0iMTE2Ljk3IiB4Mj0iMjUuMDciIHkyPSIxMTYuOTciLz48bGluZSBjbGFzcz0iY2xzLTEyIiB4MT0iMTkuODEiIHkxPSIxMzEuMDUiIHgyPSIyNS4wNyIgeTI9IjEzMS4wNSIvPjxsaW5lIGNsYXNzPSJjbHMtMTIiIHgxPSIxOS44MSIgeTE9IjE0NS4xMyIgeDI9IjI1LjA3IiB5Mj0iMTQ1LjEzIi8+PGxpbmUgY2xhc3M9ImNscy0xMiIgeDE9IjE5LjgxIiB5MT0iMTU5LjIxIiB4Mj0iMjUuMDciIHkyPSIxNTkuMjEiLz48bGluZSBpZD0iX0xpbmVfIiBkYXRhLW5hbWU9IiZsdDtMaW5lJmd0OyIgY2xhc3M9ImNscy0xMCIgeDE9Ijg0LjI0IiB5MT0iMTE2Ljk3IiB4Mj0iMTU2LjY1IiB5Mj0iMTE2Ljk3Ii8+PHBhdGggY2xhc3M9ImNscy05IiBkPSJNMzIuODksMTE3aDBaIi8+PGxpbmUgY2xhc3M9ImNscy0xMCIgeDE9IjEwMiIgeTE9IjEzMS4wNSIgeDI9IjE2My42MiIgeTI9IjEzMS4wNSIvPjxsaW5lIGNsYXNzPSJjbHMtMTMiIHgxPSI1NS44OSIgeTE9IjEzMS4wNSIgeDI9IjkzLjk5IiB5Mj0iMTMxLjA1Ii8+PGxpbmUgY2xhc3M9ImNscy0xMyIgeDE9IjU1Ljg5IiB5MT0iMTQ1LjEzIiB4Mj0iMTM5LjY3IiB5Mj0iMTQ1LjEzIi8+PGxpbmUgY2xhc3M9ImNscy05IiB4MT0iNzguOSIgeTE9IjE1OS4yMSIgeDI9IjExMy41MSIgeTI9IjE1OS4yMSIvPjxsaW5lIGNsYXNzPSJjbHMtOSIgeDE9IjU5LjYxIiB5MT0iODguODIiIHgyPSI5OS4zMyIgeTI9Ijg4LjgyIi8+PGxpbmUgY2xhc3M9ImNscy05IiB4MT0iNTkuNjEiIHkxPSIxMDIuODkiIHgyPSI5OS4zMyIgeTI9IjEwMi44OSIvPjxjaXJjbGUgY2xhc3M9ImNscy02IiBjeD0iMTMuNSIgY3k9IjEyLjA4IiByPSI1LjExIi8+PGNpcmNsZSBjbGFzcz0iY2xzLTciIGN4PSIzMC4xOCIgY3k9IjEyLjA4IiByPSI1LjExIi8+PGNpcmNsZSBjbGFzcz0iY2xzLTgiIGN4PSI0Ni44NiIgY3k9IjEyLjA4IiByPSI1LjExIi8+PC9nPjwvZz48L3N2Zz4='","title":"URI, UUID, and structures"},{"anchor":"cors-hypermedia","body":"\nThis section describes [Cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) (CORS), what content types we support in requests and responses, and hyperlinking resources in each json responses.\n\n\n----\n\n* [CORS](#cors)\n* [Supported content types](#supported-content-types)\n* [Resource links](#resource-links)\n\n----\n\n### Cors\n\nThe Bitbucket API supports Cross-origin resource sharing to allow requests for restricted resources across domains. For more information you can refer to:\n\n* [Wikipedia article on CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)\n* [W3C CORS recommendation](https://www.w3.org/TR/cors/)\n\nSending a general request from the api to bitbucket.com:\n\n`curl -i https://api.bitbucket.org -H \"origin: http://bitbucket.com\"`\n\nGives this result:\n\n HTTP/1.1 302 FOUND\n Server: nginx/1.6.2\n Vary: Cookie\n Cache-Control: max-age=900\n Content-Type: text/html; charset=utf-8\n Strict-Transport-Security: max-age=31536000\n Date: Tue, 21 Jun 2016 17:54:37 GMT\n Location: http://confluence.atlassian.com/x/IYBGDQ\n X-Served-By: app-110\n X-Static-Version: 2c820eb0d2b3\n ETag: \"d41d8cd98f00b204e9800998ecf8427e\"\n X-Content-Type-Options: nosniff\n X-Render-Time: 0.00379920005798\n Connection: Keep-Alive\n X-Version: 2c820eb0d2b3\n X-Frame-Options: SAMEORIGIN\n X-Request-Count: 383\n X-Cache-Info: cached\n Content-Length: 0\n\nSending the same request with the CORS check -X OPTIONS in the call:\n\n`curl -i https://api.bitbucket.org -H \"origin: http://bitbucket.com\" -X OPTIONS`\n\nGives this result:\n\n HTTP/1.1 302 FOUND\n Server: nginx/1.6.2\n Vary: Cookie\n Cache-Control: max-age=900\n Content-Type: text/html; charset=utf-8\n Access-Control-Expose-Headers: Accept-Ranges, Content-Encoding, Content-Length, Content-Type, ETag, Last-Modified\n Strict-Transport-Security: max-age=31536000\n Date: Tue, 21 Jun 2016 18:04:30 GMT\n Access-Control-Max-Age: 86400\n Location: http://confluence.atlassian.com/x/IYBGDQ\n X-Served-By: app-111\n Access-Control-Allow-Origin: *\n X-Static-Version: 2c820eb0d2b3\n ETag: \"d41d8cd98f00b204e9800998ecf8427e\"\n X-Content-Type-Options: nosniff\n X-Render-Time: 0.00371098518372\n Connection: keep-alive\n X-Version: 2c820eb0d2b3\n X-Frame-Options: SAMEORIGIN\n X-Request-Count: 357\n Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, OPTIONS\n Access-Control-Allow-Headers: Accept, Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, Origin, Range, X-CsrftokenX-Requested-With\n X-Cache-Info: not cacheable; request wasn't a GET or HEAD\n Content-Length: 0\n\n\n\n### Supported content types\n\nThe default and primary content type for 2.0 APIs is JSON. This applies both to responses from the server and to the request bodies provided by the client.\n\nUnless documented otherwise, whenever creating a new (POST) or modifying an existing (PUT) object, your client must provide the object's normal representation. Not every object element can be mutated. For example, a repository's created_on date is an auto-generated, immutable field. Your client can omit immutable fields from a request body.\n\nIn some cases, a resource might also accept regular application/x-www-url-form-encoded POST and PUT bodies. Such bodies can be more convenient in scripts and command line usage. Requests bodies can contain contain nested elements or they can be flat (without nested elements). Clients can send flat request bodies as either as application/json or as application/x-www-url-form-encoded. Nested objects always require JSON.\n\n### Resource links\n\nEvery 2.0 object contains a links element that points to related resources or alternate representations. Use links to quickly discover and traverse to related objects. Links serve a \"self-documenting\" function for each endpoint. For example, the following request for a specific user:\n\n\n`$ curl https://api.bitbucket.org/2.0/users/tutorials`\n\n```json\n{\n \"username\": \"tutorials\",\n \"nickname\": \"tutorials\",\n \"account_status\": \"active\",\n \"website\": \"https://tutorials.bitbucket.org/\",\n \"display_name\": \"tutorials account\",\n \"uuid\": \"{c788b2da-b7a2-404c-9e26-d3f077557007}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials\"\n },\n \"repositories\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/tutorials\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/tutorials\"\n },\n \"followers\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/followers\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2013/Nov/25/tutorials-avatar-1563784409-6_avatar.png\"\n },\n \"following\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/tutorials/following\"\n }\n },\n \"created_on\": \"2011-12-20T16:34:07.132459+00:00\",\n \"location\": \"Santa Monica, CA\",\n \"type\": \"user\"\n}\n```\nLinks can be actual REST API resources or they can be informational. In this example, informative resources include the user's avatar and the HTML URL for the user's Bitbucket account. Your client should avoid hardcoding an API's URL and instead use the URLs returned in API responses.\n\nA link's key is its `rel` (relationship) attribute and it contains a mandatory href element. For example, the following link:\n\n```json\n\"self\": {\n \"href\": \"https://api.bitbucket.org/api/2.0/users/tutorials\"\n}\n```\n\nThe rel for this link is self and the href is https://api.bitbucket.org/api/2.0/users/tutorials. A single rel key can contain an list (array) of href objects. Your client should anticipate that any rel key can contain one or more href objects.\n\nFinally, links can also contain optional elements. Two common optional elements are the name element and the title element. They are often used to disambiguate links that share the same rel key. In the example below, the repository object that contains a clone link with two href objects. Each object contains the optional name element to clarify its use.\n\n```json\n\"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/bitbucket\"\n },\n \"clone\": [\n {\n \"href\": \"https://api.bitbucket.org/evzijst/bitbucket.git\",\n \"name\": \"https\"\n },\n {\n \"href\": \"ssh://git@bitbucket.org/erik/bitbucket.git\",\n \"name\": \"ssh\"\n }\n ],\n ...\n}\n```\nLinks can support [URI Templates](https://tools.ietf.org/html/rfc6570); Those that do contain a `\"templated\": \"true\"` element.\n","description":"Learn about resources and linking","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMjM2LjYgMjE4LjQzIj48ZGVmcz48c3R5bGU+LmNscy0xe2lzb2xhdGlvbjppc29sYXRlO30uY2xzLTIsLmNscy0zLC5jbHMtNHtmaWxsOm5vbmU7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLW1pdGVybGltaXQ6MTA7c3Ryb2tlLXdpZHRoOjExcHg7fS5jbHMtMntzdHJva2U6dXJsKCNsaW5lYXItZ3JhZGllbnQpO30uY2xzLTN7c3Ryb2tlOnVybCgjTmV3X0dyYWRpZW50X1N3YXRjaF8xNCk7fS5jbHMtNHtzdHJva2U6dXJsKCNOZXdfR3JhZGllbnRfU3dhdGNoXzEpO30uY2xzLTV7ZmlsbDojNDI1MjZlO30uY2xzLTZ7ZmlsbDojZmY1NjMwO30uY2xzLTEwLC5jbHMtNywuY2xzLTh7bWl4LWJsZW5kLW1vZGU6bXVsdGlwbHk7fS5jbHMtN3tmaWxsOnVybCgjbGluZWFyLWdyYWRpZW50LTIpO30uY2xzLTh7ZmlsbDp1cmwoI2xpbmVhci1ncmFkaWVudC0zKTt9LmNscy05e2ZpbGw6IzAwNjVmZjt9LmNscy0xMHtmaWxsOnVybCgjbGluZWFyLWdyYWRpZW50LTQpO308L3N0eWxlPjxsaW5lYXJHcmFkaWVudCBpZD0ibGluZWFyLWdyYWRpZW50IiB5MT0iMTY3Ljg3IiB4Mj0iMTkxLjU2IiB5Mj0iMTY3Ljg3IiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjNTA1Zjc5Ii8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjMzQ0NTYzIi8+PC9saW5lYXJHcmFkaWVudD48bGluZWFyR3JhZGllbnQgaWQ9Ik5ld19HcmFkaWVudF9Td2F0Y2hfMTQiIHgxPSIxMTIuODMiIHkxPSIxMzEuNzIiIHgyPSIyMzYuNiIgeTI9IjEzMS43MiIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPjxzdG9wIG9mZnNldD0iMCIgc3RvcC1jb2xvcj0iIzAwNTJjYyIvPjxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iIzI2ODRmZiIvPjwvbGluZWFyR3JhZGllbnQ+PGxpbmVhckdyYWRpZW50IGlkPSJOZXdfR3JhZGllbnRfU3dhdGNoXzEiIHgxPSI0NS4wNiIgeTE9Ijg2LjY5IiB4Mj0iMTY4Ljg4IiB5Mj0iODYuNjkiIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj48c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiNkZTM1MGIiLz48c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNmZjc0NTIiLz48L2xpbmVhckdyYWRpZW50PjxsaW5lYXJHcmFkaWVudCBpZD0ibGluZWFyLWdyYWRpZW50LTIiIHgxPSIzNDQ3LjkzIiB5MT0iLTkxOC43OSIgeDI9IjM0NTEuNCIgeTI9Ii0xMDMyLjc2IiBncmFkaWVudFRyYW5zZm9ybT0idHJhbnNsYXRlKC01NzIuMzggMzcwNC4yOSkgcm90YXRlKC02NC4zNCkiIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj48c3RvcCBvZmZzZXQ9IjAuMzEiIHN0b3AtY29sb3I9IiNjMWM3ZDAiIHN0b3Atb3BhY2l0eT0iMCIvPjxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iI2MxYzdkMCIvPjwvbGluZWFyR3JhZGllbnQ+PGxpbmVhckdyYWRpZW50IGlkPSJsaW5lYXItZ3JhZGllbnQtMyIgeDE9IjM1MDYuNiIgeTE9Ii03OTYuNjYiIHgyPSIzNTEwLjA3IiB5Mj0iLTkxMC42MyIgeGxpbms6aHJlZj0iI2xpbmVhci1ncmFkaWVudC0yIi8+PGxpbmVhckdyYWRpZW50IGlkPSJsaW5lYXItZ3JhZGllbnQtNCIgeDE9IjM1ODEuNjgiIHkxPSItOTA2LjgyIiB4Mj0iMzU4NS4xNiIgeTI9Ii0xMDIwLjc5IiB4bGluazpocmVmPSIjbGluZWFyLWdyYWRpZW50LTIiLz48L2RlZnM+PHRpdGxlPldlYmhvb2tzPC90aXRsZT48ZyBjbGFzcz0iY2xzLTEiPjxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPjxnIGlkPSJTb2Z0d2FyZSI+PHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMTg2LjA2LDE2Ny44N0gxMTcuNzJBMjcuNTgsMjcuNTgsMCwwLDAsOTIuMjQsMTg1YTQ1LjA2LDQ1LjA2LDAsMSwxLTQxLjY4LTYyLjE5Ii8+PHBhdGggY2xhc3M9ImNscy0zIiBkPSJNMTE4LjMzLDUwLjUybDM0LjE1LDU5LjE4YTI3LjU5LDI3LjU5LDAsMCwwLDI3LjU4LDEzLjUxLDQ1LjA2LDQ1LjA2LDAsMSwxLTMzLDY3LjE5Ii8+PHBhdGggY2xhc3M9ImNscy00IiBkPSJNNTAuNTYsMTY3Ljg3bDM0LjE4LTU5LjE2YTI3LjU5LDI3LjU5LDAsMCwwLTIuMDktMzAuNjQsNDUuMDYsNDUuMDYsMCwxLDEsNzQuNy01Ii8+PHBhdGggY2xhc3M9ImNscy01IiBkPSJNMTg2LjA2LDE5OS42NmEzMS43OSwzMS43OSwwLDEsMSwzMS43OS0zMS43OUEzMS44MiwzMS44MiwwLDAsMSwxODYuMDYsMTk5LjY2WiIvPjxnIGlkPSJfR3JvdXBfIiBkYXRhLW5hbWU9IiZsdDtHcm91cCZndDsiPjxwYXRoIGNsYXNzPSJjbHMtNiIgZD0iTTQ5LjU2LDE5OS42NGEzMS43OSwzMS43OSwwLDEsMSwzMi43Ny0zMC43N0EzMS44MiwzMS44MiwwLDAsMSw0OS41NiwxOTkuNjRaIi8+PC9nPjxwYXRoIGNsYXNzPSJjbHMtNyIgZD0iTTU0LjEyLDE4MC4zNmE1OC45LDU4LjksMCwwLDAtMS41OS0xMS4yN3MtMi4zNS05LjQ0LTcuMzMtMTYuODNhNDMuODksNDMuODksMCwwLDAtMTEuNzMtMTEuMTcsMzEuNzcsMzEuNzcsMCwwLDAsMjkuMjgsNTYuMTNDNTguMjksMTkyLjQ0LDU0LjY4LDE4Ni45LDU0LjEyLDE4MC4zNloiLz48cGF0aCBjbGFzcz0iY2xzLTgiIGQ9Ik0xODkuNjIsMTgwLjM2QTU4LjksNTguOSwwLDAsMCwxODgsMTY5LjA4cy0yLjM1LTkuNDQtNy4zMy0xNi44M0E0My44OSw0My44OSwwLDAsMCwxNjksMTQxLjA4YTMxLjc3LDMxLjc3LDAsMCwwLDI5LjI4LDU2LjEzQzE5My43OSwxOTIuNDQsMTkwLjE4LDE4Ni45LDE4OS42MiwxODAuMzZaIi8+PGcgaWQ9Il9Hcm91cF8yIiBkYXRhLW5hbWU9IiZsdDtHcm91cCZndDsiPjxwYXRoIGNsYXNzPSJjbHMtOSIgZD0iTTg5LjksMzMuNzhhMzIuNDYsMzIuNDYsMCwxLDEsMTEuODgsNDQuMzRBMzIuNDksMzIuNDksMCwwLDEsODkuOSwzMy43OFoiLz48L2c+PHBhdGggY2xhc3M9ImNscy0xMCIgZD0iTTEyMi4yMyw2Ni4xM2E1OC45LDU4LjksMCwwLDAtMS41OS0xMS4yN3MtMi4zNS05LjQ0LTcuMzMtMTYuODNjLTMuMzctNS05LjA2LTkuNzktMTUuNDMtMTMuNDhBMzIuNDQsMzIuNDQsMCwwLDAsMTI4Ljc3LDgwLjZDMTI1LjMxLDc2LjM5LDEyMi43LDcxLjYxLDEyMi4yMyw2Ni4xM1oiLz48L2c+PC9nPjwvZz48L3N2Zz4='","title":"Cors and hypermedia"},{"anchor":"bb-connect","body":"\nYou can use the Atlassian Connect for Bitbucket Cloud to build add-ons which\ncan connect with the Bitbucket UI and your own application set. An add-on could\nbe an integration with another existing service, new features for the Atlassian\napplication, or even a new product that runs within the Atlassian application.\n\nFor complete information see:\n[Atlassian Connect for Bitbucket Cloud](https://developer.atlassian.com/bitbucket/index.html)\n","description":"Build Bitbucket add-ons with Connect","icon":"data:image/svg+xml;base64,b'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMjU3LjMxNjMgMTYyLjU5OTQiPgogIDxkZWZzPgogICAgPHN0eWxlPgogICAgICAuY2xzLTEgewogICAgICAgIGlzb2xhdGlvbjogaXNvbGF0ZTsKICAgICAgfQoKICAgICAgLmNscy0yIHsKICAgICAgICBmaWxsOiAjMzQ0NTYzOwogICAgICB9CgogICAgICAuY2xzLTMgewogICAgICAgIGZpbGw6ICMxZGI5ZDQ7CiAgICAgIH0KCiAgICAgIC5jbHMtNCB7CiAgICAgICAgZmlsbDogIzAwNTdkODsKICAgICAgfQoKICAgICAgLmNscy01LCAuY2xzLTcsIC5jbHMtOSB7CiAgICAgICAgbWl4LWJsZW5kLW1vZGU6IG11bHRpcGx5OwogICAgICB9CgogICAgICAuY2xzLTUgewogICAgICAgIGZpbGw6IHVybCgjTjc1KTsKICAgICAgfQoKICAgICAgLmNscy02IHsKICAgICAgICBmaWxsOiAjMDA2NWZmOwogICAgICB9CgogICAgICAuY2xzLTcgewogICAgICAgIGZpbGw6IHVybCgjTjc1LTIpOwogICAgICB9CgogICAgICAuY2xzLTggewogICAgICAgIGZpbGw6IHVybCgjbGluZWFyLWdyYWRpZW50KTsKICAgICAgfQoKICAgICAgLmNscy05IHsKICAgICAgICBmaWxsOiB1cmwoI043NS0zKTsKICAgICAgfQoKICAgICAgLmNscy0xMCB7CiAgICAgICAgZmlsbDogdXJsKCNUMjAwLVQ3NSk7CiAgICAgIH0KICAgIDwvc3R5bGU+CiAgICA8bGluZWFyR3JhZGllbnQgaWQ9Ik43NSIgeDE9Ii0yMTg5LjU1NiIgeTE9IjI4MDguMjI4NCIgeDI9Ii0yMDkxLjE1NTEiIHkyPSIyODA4LjIyODQiIGdyYWRpZW50VHJhbnNmb3JtPSJtYXRyaXgoMC4xNjgxLCAwLjk4NTgsIDAuOTg1OCwgLTAuMTY4MSwgLTIzNzMuNzM2LCAyNzIyLjEyNzgpIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+CiAgICAgIDxzdG9wIG9mZnNldD0iMCIgc3RvcC1jb2xvcj0iI2U1ZThlYyIvPgogICAgICA8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNlNWU4ZWMiIHN0b3Atb3BhY2l0eT0iMC4xIi8+CiAgICA8L2xpbmVhckdyYWRpZW50PgogICAgPGxpbmVhckdyYWRpZW50IGlkPSJONzUtMiIgZGF0YS1uYW1lPSJONzUiIHgxPSItMjE2OC41OTQ3IiB5MT0iMjkzNS4wNTU2IiB4Mj0iLTIwNzAuMTkzNyIgeTI9IjI5MzUuMDU1NiIgeGxpbms6aHJlZj0iI043NSIvPgogICAgPGxpbmVhckdyYWRpZW50IGlkPSJsaW5lYXItZ3JhZGllbnQiIHgxPSIxOTAuMzU0NyIgeTE9IjE1OS45NjciIHgyPSIyNTkuOTQ4NyIgeTI9IjkwLjM3MyIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPgogICAgICA8c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiMzNDQ1NjMiLz4KICAgICAgPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjNWU2Yzg0Ii8+CiAgICA8L2xpbmVhckdyYWRpZW50PgogICAgPGxpbmVhckdyYWRpZW50IGlkPSJONzUtMyIgZGF0YS1uYW1lPSJONzUiIHgxPSItMjI1Ny4zOTc3IiB5MT0iMjg4NC4yMjYzIiB4Mj0iLTIxNTguOTk2NyIgeTI9IjI4ODQuMjI2MyIgeGxpbms6aHJlZj0iI043NSIvPgogICAgPGxpbmVhckdyYWRpZW50IGlkPSJUMjAwLVQ3NSIgeDE9IjEyNi4wMjU3IiB5MT0iODUuMTA4IiB4Mj0iMTk1LjYxOTciIHkyPSIxNS41MTQiIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KICAgICAgPHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjM2RjN2RjIi8+CiAgICAgIDxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iIzljZTNlZSIvPgogICAgPC9saW5lYXJHcmFkaWVudD4KICA8L2RlZnM+CiAgPHRpdGxlPkFkZCBPbiBCbG9ja3MgMjwvdGl0bGU+CiAgPGcgY2xhc3M9ImNscy0xIj4KICAgIDxnIGlkPSJMYXllcl8yIiBkYXRhLW5hbWU9IkxheWVyIDIiPgogICAgICA8ZyBpZD0iT2JqZWN0cyI+CiAgICAgICAgPHJlY3QgaWQ9Il9SZWN0YW5nbGVfIiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTIiIHg9IjEyOC42NTgxIiB5PSI4Ny43NDA1IiB3aWR0aD0iNjQuMzI5MSIgaGVpZ2h0PSI3NC44NTkiLz4KICAgICAgICA8cmVjdCBpZD0iX1JlY3RhbmdsZV8yIiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTMiIHg9IjY0LjMyOTEiIHk9IjEyLjg4MTUiIHdpZHRoPSI2NC4zMjkxIiBoZWlnaHQ9Ijc0Ljg1OSIvPgogICAgICAgIDxyZWN0IGlkPSJfUmVjdGFuZ2xlXzMiIGRhdGEtbmFtZT0iJmx0O1JlY3RhbmdsZSZndDsiIGNsYXNzPSJjbHMtNCIgeT0iODcuNzQwNSIgd2lkdGg9IjY0LjMyOTEiIGhlaWdodD0iNzQuODU5Ii8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy01IiBkPSJNNjQuMzI5MSw4Ny43NEg1OC42NTIzYTYyLjc4NzcsNjIuNzg3NywwLDAsMC0yNC41Njg0LDIwLjc2MjFjLTguMjYwNywxMi4xOTYtNC4zNDM3LDE4LjI0MTUtMTEuNjYzNywzMS42Mzk1QzE2LjUxLDE1MC45Niw4LjA1MSwxNTcuODIsMCwxNjIuNTU2di4wNDM1aDY0LjMyOVoiLz4KICAgICAgICA8cmVjdCBpZD0iX1JlY3RhbmdsZV80IiBkYXRhLW5hbWU9IiZsdDtSZWN0YW5nbGUmZ3Q7IiBjbGFzcz0iY2xzLTYiIHg9IjY0LjMyOTEiIHk9Ijg3Ljc0MDUiIHdpZHRoPSI2NC4zMjkxIiBoZWlnaHQ9Ijc0Ljg1OSIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtNyIgZD0iTTE5Mi45ODcyLDg3Ljc0SDE4My4zNDNhNjIuNzg3Nyw2Mi43ODc3LDAsMCwwLTI0LjU2ODQsMjAuNzYyMWMtOC4yNjA3LDEyLjE5Ni00LjM0MzgsMTguMjQxNS0xMS42NjM3LDMxLjYzOTVhNTYuNzI0Niw1Ni43MjQ2LDAsMCwxLTE4LjQ1MjcsMTkuOTF2Mi41NDc0aDY0LjMyOVoiLz4KICAgICAgICA8cmVjdCBjbGFzcz0iY2xzLTgiIHg9IjE5Mi45ODcyIiB5PSI4Ny43NDA1IiB3aWR0aD0iNjQuMzI5MSIgaGVpZ2h0PSI3NC44NTkiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTkiIGQ9Ik0xMjguNjU4MiwxMi44ODE1SDExNi41OUE2MS45NjQ2LDYxLjk2NDYsMCwwLDAsMTAxLjMyMzMsMjguMjE1QzkzLjA2MjUsNDAuNDEwOSw5Ni45Nzk0LDQ2LjQ1NjUsODkuNjYsNTkuODU0NCw4My4wMzE2LDcxLjk4NTcsNzMuMTk3LDc5LjE1MTQsNjQuMzI5MSw4My45MTA4djMuODNoNjQuMzI5MVoiLz4KICAgICAgICA8cmVjdCBjbGFzcz0iY2xzLTEwIiB4PSIxMjguNjU4MSIgeT0iMTIuODgxNSIgd2lkdGg9IjY0LjMyOTEiIGhlaWdodD0iNzQuODU5Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy00IiB4PSIxMC4xNjA1IiB5PSI3NC44NTkiIHdpZHRoPSIyNC43NTM2IiBoZWlnaHQ9IjEyLjg4MTUiLz4KICAgICAgICA8cmVjdCBjbGFzcz0iY2xzLTQiIHg9IjUxLjk1MjMiIHk9Ijc0Ljg1OSIgd2lkdGg9IjI0Ljc1MzYiIGhlaWdodD0iMTIuODgxNSIvPgogICAgICAgIDxyZWN0IGNsYXNzPSJjbHMtNCIgeD0iOTMuNzQ0MSIgeT0iNzQuODU5IiB3aWR0aD0iMjQuNzUzNiIgaGVpZ2h0PSIxMi44ODE1Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0yIiB4PSIxMzguODE4NiIgeT0iNzQuODU5IiB3aWR0aD0iMjQuNzUzNiIgaGVpZ2h0PSIxMi44ODE1Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0yIiB4PSIxODAuNjEwNCIgeT0iNzQuODU5IiB3aWR0aD0iMjQuNzUzNiIgaGVpZ2h0PSIxMi44ODE1Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0yIiB4PSIyMjIuNDAyMiIgeT0iNzQuODU5IiB3aWR0aD0iMjQuNzUzNiIgaGVpZ2h0PSIxMi44ODE1Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0zIiB4PSI3NC40ODk1IiB3aWR0aD0iMjQuNzUzNiIgaGVpZ2h0PSIxMi44ODE1Ii8+CiAgICAgICAgPHJlY3QgY2xhc3M9ImNscy0zIiB4PSIxMTYuMjgxNCIgd2lkdGg9IjI0Ljc1MzYiIGhlaWdodD0iMTIuODgxNSIvPgogICAgICAgIDxyZWN0IGNsYXNzPSJjbHMtMyIgeD0iMTU4LjA3MzIiIHdpZHRoPSIyNC43NTM2IiBoZWlnaHQ9IjEyLjg4MTUiLz4KICAgICAgPC9nPgogICAgPC9nPgogIDwvZz4KPC9zdmc+Cg=='","title":"Atlassian Connect"}]},"x-revision":"823a155d590f"}