openapi.yml

openapi: 3.0.1
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"
servers:
- url: https://api.bitbucket.org/2.0
tags:
- description: ""
  name: users
- description: ""
  name: teams
- description: ""
  name: repositories
- description: |-
    Browse the source code in the repository and
                                  create new commits by uploading.
  name: source
- description: ""
  name: refs
- description: ""
  name: commits
- description: ""
  name: pullrequests
- description: |-
    The issue resources provide functionality for getting information on
    issues in an issue tracker, creating new issues, updating them and deleting
    them.

    You can access public issues without authentication, but you can't gain access
    to private repositories' issues. By authenticating, you will get the ability
    to create issues, as well as access to updating data or deleting issues you
    have access to.
  name: issue_tracker
- description: ""
  name: wiki
- description: ""
  name: downloads
- description: ""
  name: snippets
- description: |
    Webhooks provide a way to configure Bitbucket Cloud to make requests to
    your server (or another external service) whenever certain events occur in
    Bitbucket Cloud.

    A webhook consists of:

    * A subject -- The resource that generates the events. Currently, this resource
      is the repository, user account, or team where you create the webhook.
    * One or more event -- The default event is a repository push, but you can
      select multiple events that can trigger the webhook.
    * A URL -- The endpoint where you want Bitbucket to send the event payloads
      when a matching event happens.

    There are two parts to getting a webhook to work: creating the webhook and
    triggering the webhook. After you create a webhook for an event, every time
    that event occurs, Bitbucket sends a payload request that describes the event
    to the specified URL. Thus, you can think of webhooks as a kind of
    notification system.

    Use webhooks to integrate applications with Bitbucket Cloud. The following
    use cases provides examples of when you would want to use webhooks:

    * Every time a user pushes commits in a repository, you may want to notify
      your CI server to start a build.
    * Every time a user pushes commits or creates a pull request, you may want to
      display a notification in your application.
  name: webhooks
- description: |
    Commit statuses provide a way to tag commits with meta data,
    like automated build results.
  name: commitstatuses
- description: |
    Repository owners and administrators can set branch management
    rules on a repository that control what can be pushed by whom.
    Through these rules, you can enforce a project or team
    workflow. For example, owners or administrators can:

    * Limit push powers
    * Prevent branch (bookmark) deletion
    * Prevent history re-writes (Git only)
  name: branchrestrictions
- description: |
    Bitbucket Cloud projects make it easier for teams to focus on
    a goal, product, or process by organizing their repositories.
  name: projects
- description: |
    Bitbucket Pipelines brings continuous delivery to Bitbucket
    Cloud, empowering teams with full branching to deployment
    visibility and faster feedback loops.
  name: pipelines
- description: |
    Teams are deploying code faster than ever, thanks to continuous
    delivery practices and tools like Bitbucket Pipelines. Bitbucket
    Deployments gives teams visibility into their deployment
    environments and helps teams to track how far changes have
    progressed in their deployment pipeline.
  name: deployments
paths:
  /repositories/{workspace}/{repo_slug}/branching-model:
    get:
      description: |-
        Return the branching model as applied to the repository. This view is
        read-only. The branching model settings can be changed using the
        [settings](branching-model/settings#get) API.

        The returned object:

        1. Always has a `development` property. `development.branch` contains
           the actual repository branch object that is considered to be the
           `development` branch. `development.branch` will not be present
           if it does not exist.
        2. Might have a `production` property. `production` will not
           be present when `production` is disabled.
           `production.branch` contains the actual branch object that is
           considered to be the `production` branch. `production.branch` will
           not be present if it does not exist.
        3. Always has a `branch_types` array which contains all enabled branch
           types.

        Example body:

        ```
        {
          "development": {
            "name": "master",
            "branch": {
              "type": "branch",
              "name": "master",
              "target": {
                "hash": "16dffcb0de1b22e249db6799532074cf32efe80f"
              }
            },
            "use_mainbranch": true
          },
          "production": {
            "name": "production",
            "branch": {
              "type": "branch",
              "name": "production",
              "target": {
                "hash": "16dffcb0de1b22e249db6799532074cf32efe80f"
              }
            },
            "use_mainbranch": false
          },
          "branch_types": [
            {
              "kind": "release",
              "prefix": "release/"
            },
            {
              "kind": "hotfix",
              "prefix": "hotfix/"
            },
            {
              "kind": "feature",
              "prefix": "feature/"
            },
            {
              "kind": "bugfix",
              "prefix": "bugfix/"
            }
          ],
          "type": "branching_model",
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/.../branching-model"
            }
          }
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - branching_model
      x-tags:
      - tag: branching_model
  /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}:
    delete:
      description: Delete an application property value stored against a commit.
      operationId: deleteCommitHostedPropertyValue
      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 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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
    get:
      description: Retrieve an application property value stored against a commit.
      operationId: getCommitHostedPropertyValue
      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 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: {}
          description: The value of the property.
      tags:
      - properties
      x-tags:
      - tag: properties
    put:
      description: Update an application property value stored against a commit.
      operationId: updateCommitHostedPropertyValue
      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 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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
  /user:
    get:
      description: Returns the currently logged in user.
      responses:
        200:
          content:
            application/json:
              example:
                uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                account_status: active
                links:
                  followers:
                    href: https://api.bitbucket.org/2.0/users/example-username/followers
                  following:
                    href: https://api.bitbucket.org/2.0/users/example-username/following
                  html:
                    href: https://bitbucket.org/example-username/
                  snippets:
                    href: https://api.bitbucket.org/2.0/snippets/example-username
                  self:
                    href: https://api.bitbucket.org/2.0/users/example-username
                  avatar:
                    href: https://bitbucket.org/account/example-username/avatar/
                  repositories:
                    href: https://api.bitbucket.org/2.0/repositories/example-username
                account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                nickname: example-username
                created_on: 2018-06-20T23:17:33.616037+00:00
                display_name: Example Username
                is_staff: false
                username: example-username
                type: user
              schema:
                $ref: '#/components/schemas/user'
          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: []
      tags:
      - users
      x-tags:
      - tag: users
  /repositories/{workspace}/{repo_slug}/downloads/{filename}:
    delete:
      description: Deletes the specified download artifact from the repository.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: filename
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository:write
      - basic: []
      - api_key: []
      tags:
      - downloads
      x-tags:
      - tag: downloads
    get:
      description: |-
        Return a redirect to the contents of a download artifact.

        This endpoint returns the actual file contents and not the artifact's
        metadata.

            $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt
            Hello World
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: filename
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - downloads
      x-tags:
      - tag: downloads
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes:
    get:
      description: |-
        Returns the list of all changes that have been made to the specified
        issue. Changes are returned in chronological order with the oldest
        change first.

        Each time an issue is edited in the UI or through the API, an immutable
        change record is created under the `/issues/123/changes` endpoint. It
        also has a comment associated with the change.

        Note that this operation is changing significantly, due to privacy changes.
        See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-the-issue-changes-api)
        for details.

        ```
        $ curl -s https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes - | jq .

        {
          "pagelen": 20,
          "values": [
            {
              "changes": {
                "priority": {
                  "new": "trivial",
                  "old": "major"
                },
                "assignee": {
                  "new": "",
                  "old": "evzijst"
                },
                "assignee_account_id": {
                  "new": "",
                  "old": "557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443"
                },
                "kind": {
                  "new": "enhancement",
                  "old": "bug"
                }
              },
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes/2"
                },
                "html": {
                  "href": "https://bitbucket.org/evzijst/dogslow/issues/1#comment-2"
                }
              },
              "issue": {
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1"
                  }
                },
                "type": "issue",
                "id": 1,
                "repository": {
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/repositories/evzijst/dogslow"
                    },
                    "html": {
                      "href": "https://bitbucket.org/evzijst/dogslow"
                    },
                    "avatar": {
                      "href": "https://bitbucket.org/evzijst/dogslow/avatar/32/"
                    }
                  },
                  "type": "repository",
                  "name": "dogslow",
                  "full_name": "evzijst/dogslow",
                  "uuid": "{988b17c6-1a47-4e70-84ee-854d5f012bf6}"
                },
                "title": "Updated title"
              },
              "created_on": "2018-03-03T00:35:28.353630+00:00",
              "user": {
                "username": "evzijst",
                "nickname": "evzijst",
                "display_name": "evzijst",
                "type": "user",
                "uuid": "{aaa7972b-38af-4fb1-802d-6e3854c95778}",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/users/evzijst"
                  },
                  "html": {
                    "href": "https://bitbucket.org/evzijst/"
                  },
                  "avatar": {
                    "href": "https://bitbucket.org/account/evzijst/avatar/32/"
                  }
                }
              },
              "message": {
                "raw": "Removed assignee, changed kind and priority.",
                "markup": "markdown",
                "html": "<p>Removed assignee, changed kind and priority.</p>",
                "type": "rendered"
              },
              "type": "issue_change",
              "id": 2
            }
          ],
          "page": 1
        }
        ```

        Changes support [filtering and sorting](../../../meta/filtering) that
        can be used to search for specific changes. For instance, to see
        when an issue transitioned to "resolved":

        ```
        $ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \
           -G --data-urlencode='q=changes.state.new = "resolved"'
        ```

        This resource is only available on repositories that have the issue
        tracker enabled.

        N.B.

        The `changes.assignee` and `changes.assignee_account_id` fields are not
        a `user` object. Instead, they contain the raw `username` and
        `account_id` of the user. This is to protect the integrity of the audit
        log even after a user account gets deleted.

        The `changes.assignee` field is deprecated will disappear in the
        future. Use `changes.assignee_account_id` instead.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response. See
          [filtering and sorting](../../../meta/filtering) for details.
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property to sort results. See
          [filtering and sorting](../../../meta/filtering#query-sort)
          for details.
        in: query
        name: sort
        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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    post:
      description: |-
        Makes a change to the specified issue.

        For example, to change an issue's state and assignee, create a new
        change object that modifies these fields:

        ```
        curl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \
          -s -u evzijst -X POST -H "Content-Type: application/json" \
          -d '{
            "changes": {
              "assignee_account_id": {
                "new": "557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443"
              },
              "state": {
                "new": 'resolved"
              }
            }
            "message": {
              "raw": "This is now resolved."
            }
          }'
        ```

        The above example also includes a custom comment to go alongside the
        change. This comment will also be visible on the issue page in the UI.

        The fields of the `changes` object are strings, not objects. This
        allows for immutable change log records, even after user accounts,
        milestones, or other objects recorded in a change entry, get renamed or
        deleted.

        The `assignee_account_id` field stores the account id. When POSTing a
        new change and changing the assignee, the client should therefore use
        the user's account_id in the `changes.assignee_account_id.new` field.

        This call requires authentication. Private repositories or private
        issue trackers require the caller to authenticate with an account that
        has appropriate authorization.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/patch/{spec}:
    get:
      description: |-
        Produces a raw patch for a single commit (diffed against its first
        parent), or a patch-series for a revspec of 2 commits (e.g.
        `3a8b42..9ff173` where the first commit represents the source and the
        second commit the destination).

        In case of the latter (diffing a revspec), a patch series is returned
        for the commits on the source branch (`3a8b42` and its ancestors in
        our example). For Mercurial, a single patch is returned that combines
        the changes of all commits on the source branch.

        While similar to diffs, patches:

        * Have a commit header (username, commit message, etc)
        * Do not support the `path=foo/bar.py` query parameter

        The raw patch is returned as-is, in whatever encoding the files in the
        repository use. It is not decoded into unicode. As such, the
        content-type is `text/plain`.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: spec
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content: {}
          description: The raw patches
        555:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: |-
            If the diff was too large and timed out.

            Since this endpoint does not employ any form of pagination, but
            instead returns the diff as a single document, it can run into
            trouble on very large diffs. If Bitbucket times out in cases
            like these, a 555 status code is returned.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /users/{username}/members:
    get:
      description: |-
        Returns all members of the specified team. Any member of any of the
        team's groups is considered a member of the team. This includes users
        in groups that may not actually have access to any of the team's
        repositories.

        This operation has been deprecated due to privacy changes.
        See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/)
        for details.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                nickname: example-username
                links:
                  html:
                    href: https://bitbucket.org/example-username/
                  self:
                    href: https://api.bitbucket.org/2.0/users/example-username
                  avatar:
                    href: https://bitbucket.org/account/example-username/avatar/
                account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                account_status: active
                type: user
                username: example-username
                display_name: Example Username
              schema:
                $ref: '#/components/schemas/user'
          description: All members
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: When the team does not exist, or multiple teams with the same
            name exist that differ only in casing and the URL did not match the exact
            casing of a particular one.
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - tag: teams
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}:
    delete:
      description: Deletes a specific pull request comment.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          description: Successful deletion.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If the authenticated user does not have access to delete 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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    get:
      description: Returns a specific pull request comment.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_pullrequest_comments'
          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 pull request does not exist.
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    put:
      description: Updates a specific pull request comment.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/comment'
        description: The contents of the updated comment.
        required: true
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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 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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}:
    delete:
      description: Delete an application property value stored against a pull request.
      operationId: deletePullRequestHostedPropertyValue
      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 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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
    get:
      description: Retrieve an application property value stored against a pull request.
      operationId: getPullRequestHostedPropertyValue
      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 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: {}
          description: The value of the property.
      tags:
      - properties
      x-tags:
      - tag: properties
    put:
      description: Update an application property value stored against a pull request.
      operationId: updatePullRequestHostedPropertyValue
      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 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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
  /repositories/{workspace}/{repo_slug}/issues:
    get:
      description: Returns the issues in the issue tracker.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    post:
      description: |-
        Creates a new issue.

        This call requires authentication. Private repositories or private
        issue trackers require the caller to authenticate with an account that
        has appropriate authorization.

        The authenticated user is used for the issue's `reporter` field.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/downloads:
    get:
      description: Returns a list of download links associated with the repository.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - downloads
      x-tags:
      - tag: downloads
    post:
      description: |-
        Upload new download artifacts.

        To upload files, perform a `multipart/form-data` POST containing one
        or more `files` fields:

            $ echo Hello World > hello.txt
            $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt

        When a file is uploaded with the same name as an existing artifact,
        then the existing file will be replaced.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository:write
      - basic: []
      - api_key: []
      tags:
      - downloads
      x-tags:
      - tag: downloads
  /repositories/{workspace}/{repo_slug}/deploy-keys:
    get:
      description: |-
        Returns all deploy-keys belonging to a repository.

        Example:
        ```
        $ curl -H "Authorization <auth header>" \
        https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys

        Output:
        {
            "pagelen": 10,
            "values": [
                {
                    "id": 123,
                    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5",
                    "label": "mykey",
                    "type": "deploy_key",
                    "created_on": "2018-08-15T23:50:59.993890+00:00",
                    "repository": {
                        "full_name": "mleu/test",
                        "name": "test",
                        "type": "repository",
                        "uuid": "{85d08b4e-571d-44e9-a507-fa476535aa98}"
                    },
                    "links":{
                        "self":{
                            "href": "https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123"
                        }
                    }
                    "last_used": null,
                    "comment": "mleu@C02W454JHTD8"
                }
            ],
            "page": 1,
            "size": 1
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_deploy_keys'
          description: Deploy keys matching the repository
        403:
          content: {}
          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: []
      tags:
      - deploy
      x-tags:
      - tag: deploy
    post:
      description: |-
        Create a new deploy key in a repository.

        Example:
        ```
        $ curl -XPOST \
        -H "Authorization <auth header>" \
        -H "Content-type: application/json" \
        https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys -d \
        '{
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8",
            "label": "mydeploykey"
        }'

        Output:
        {
            "id": 123,
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5",
            "label": "mydeploykey",
            "type": "deploy_key",
            "created_on": "2018-08-15T23:50:59.993890+00:00",
            "repository": {
                "full_name": "mleu/test",
                "name": "test",
                "type": "repository",
                "uuid": "{85d08b4e-571d-44e9-a507-fa476535aa98}"
            },
            "links":{
                "self":{
                    "href": "https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123"
                }
            }
            "last_used": null,
            "comment": "mleu@C02W454JHTD8"
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deploy_key'
          description: The deploy key that was created
        400:
          content: {}
          description: Invalid deploy key inputs
        403:
          content: {}
          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: []
      tags:
      - deploy
      x-tags:
      - tag: deploy
  /repositories/{workspace}/{repo_slug}/commits:
    get:
      description: |-
        These are the repository's commits. They are paginated and returned
        in reverse chronological order, similar to the output of `git log` and
        `hg log`. Like these tools, the DAG can be filtered.

        ## GET /repositories/{workspace}/{repo_slug}/commits/

        Returns all commits in the repo in topological order (newest commit
        first). All branches and tags are included (similar to
        `git log --all` and `hg log`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/master

        Returns all commits on rev `master` (similar to `git log master`,
        `hg log master`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/dev?exclude=master

        Returns all commits on ref `dev`, except those that are reachable on
        `master` (similar to `git log dev ^master`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/?exclude=master

        Returns all commits in the repo that are not on master
        (similar to `git log --all ^master`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar

        Returns all commits that are on refs `foo` or `bar`, but not on `fu` or
        `fubar` (similar to `git log foo bar ^fu ^fubar`).

        An optional `path` parameter can be specified that will limit the
        results to commits that affect that path. `path` can either be a file
        or a directory. If a directory is specified, commits are returned that
        have modified any file in the directory tree rooted by `path`. It is
        important to note that if the `path` parameter is specified, the commits
        returned by this endpoint may no longer be a DAG, parent commits that
        do not modify the path will be omitted from the response.

        ## GET /repositories/{workspace}/{repo_slug}/commits/?path=README.md&include=foo&include=bar&exclude=master

        Returns all commits that are on refs `foo` or `bar`, but not on `master`
        that changed the file README.md.

        ## GET /repositories/{workspace}/{repo_slug}/commits/?path=src/&include=foo&include=bar&exclude=master

        Returns all commits that are on refs `foo` or `bar`, but not on `master`
        that changed to a file in any file in the directory src or its children.

        Because the response could include a very large number of commits, it
        is paginated. Follow the 'next' link in the response to navigate to the
        next page of commits. As with other paginated resources, do not
        construct your own links.

        When the include and exclude parameters are more than can fit in a
        query string, clients can use a `x-www-form-urlencoded` POST instead.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
    post:
      description: |-
        Identical to `GET /repositories/{workspace}/{repo_slug}/commits`,
        except that POST allows clients to place the include and exclude
        parameters in the request body to avoid URL length issues.

        **Note that this resource does NOT support new commit creation.**
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /repositories/{workspace}/{repo_slug}/commit/{node}/approve:
    delete:
      description: |-
        Redact the authenticated user's approval of the specified commit.

        This operation is only available to users that have explicit access to
        the repository. In contrast, just the fact that a repository is
        publicly accessible to users does not give them the ability to approve
        commits.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - commits
      x-tags:
      - tag: commits
    post:
      description: |-
        Approve the specified commit as the authenticated user.

        This operation is only available to users that have explicit access to
        the repository. In contrast, just the fact that a repository is
        publicly accessible to users does not give them the ability to approve
        commits.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /teams/{username}/following:
    get:
      description: Returns the list of accounts this team is following.
      parameters:
      - description: The team's username
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          description: A paginated list of user objects.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If no team exists for the specified name, or if the specified
            account is a personal account, not a team account.
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - tag: teams
  /repositories/{workspace}/{repo_slug}/branching-model/settings:
    get:
      description: |-
        Return the branching model configuration for a repository. The returned
        object:

        1. Always has a `development` property for the development branch.
        2. Always a `production` property for the production branch. The
           production branch can be disabled.
        3. The `branch_types` contains all the branch types.

        This is the raw configuration for the branching model. A client
        wishing to see the branching model with its actual current branches may
        find the [active model API](../branching-model#get) more useful.

        Example body:

        ```
        {
          "development": {
            "is_valid": true,
            "name": null,
            "use_mainbranch": true
          },
          "production": {
            "is_valid": true,
            "name": "production",
            "use_mainbranch": false,
            "enabled": false
          },
          "branch_types": [
            {
              "kind": "release",
              "enabled": true,
              "prefix": "release/"
            },
            {
              "kind": "hotfix",
              "enabled": true,
              "prefix": "hotfix/"
            },
            {
              "kind": "feature",
              "enabled": true,
              "prefix": "feature/"
            },
            {
              "kind": "bugfix",
              "enabled": false,
              "prefix": "bugfix/"
            }
          ],
          "type": "branching_model_settings",
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/.../branching-model/settings"
            }
          }
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - branching_model
      x-tags:
      - tag: branching_model
    put:
      description: |-
        Update the branching model configuration for a repository.

        The `development` branch can be configured to a specific branch or to
        track the main branch. When set to a specific branch it must
        currently exist. Only the passed properties will be updated. The
        properties not passed will be left unchanged. A request without a
        `development` property will leave the development branch unchanged.

        It is possible for the `development` branch to be invalid. This
        happens when it points at a specific branch that has been
        deleted. This is indicated in the `is_valid` field for the branch. It is
        not possible to update the settings for `development` if that
        would leave the branch in an invalid state. Such a request will be
        rejected.

        The `production` branch can be a specific branch, the main
        branch or disabled. When set to a specific branch it must currently
        exist. The `enabled` property can be used to enable (`true`) or
        disable (`false`) it. Only the passed properties will be updated. The
        properties not passed will be left unchanged. A request without a
        `production` property will leave the production branch unchanged.

        It is possible for the `production` branch to be invalid. This
        happens when it points at a specific branch that has been
        deleted. This is indicated in the `is_valid` field for the branch. A
        request that would leave `production` enabled and invalid will be
        rejected. It is possible to update `production` and make it invalid if
        it would also be left disabled.

        The `branch_types` property contains the branch types to be updated.
        Only the branch types passed will be updated. All updates will be
        rejected if it would leave the branching model in an invalid state.
        For branch types this means that:

        1. The prefixes for all enabled branch types are valid. For example,
           it is not possible to use '*' inside a Git prefix.
        2. A prefix of an enabled branch type must not be a prefix of another
           enabled branch type. This is to ensure that a branch can be easily
           classified by its prefix unambiguously.

        It is possible to store an invalid prefix if that branch type would be
        left disabled. Only the passed properties will be updated. The
        properties not passed will be left unchanged. Each branch type must
        have a `kind` property to identify it.

        Example Body:

        ```
            {
              "development": {
                "use_mainbranch": true
              },
              "production": {
                "enabled": true,
                "use_mainbranch": false,
                "name": "production"
              },
              "branch_types": [
                {
                  "kind": "bugfix",
                  "enabled": true,
                  "prefix": "bugfix/"
                },
                {
                  "kind": "feature",
                  "enabled": true,
                  "prefix": "feature/"
                },
                {
                  "kind": "hotfix",
                  "prefix": "hotfix/"
                },
                {
                  "kind": "release",
                  "enabled": false,
                }
              ]
            }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - branching_model
      x-tags:
      - tag: branching_model
  /teams/{username}/search/code:
    get:
      operationId: searchAccount
      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
        schema:
          default: 1
          format: int32
          type: integer
      - description: How many search results to retrieve per page
        in: query
        name: pagelen
        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 following reasons:
            * the specified type of target account doesn't match the actual account type;
            * malformed pagination properties;
            * missing or malformed search query, in the latter case an error key will be returned in `error.data.key` property.
        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 the repositories of the specified team
      tags:
      - search
      x-tags:
      - tag: search
  /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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    put:
      description: Update the pipelines configuration for a repository.
      operationId: updateRepositoryPipelineConfig
      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
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /teams/{username}/projects/:
    get:
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_projects'
          description: A paginated list of projects that belong to the specified team.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The requesting user isn't authorized to read the list of projects
            for the specified team.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: A team doesn't exist at this location.
      security:
      - oauth2:
        - project
      - basic: []
      - api_key: []
      tags:
      - projects
      x-tags:
      - tag: projects
    post:
      description: |-
        Creates a new project.

        Note that the avatar has to be embedded as either a data-url
        or a URL to an external image as shown in the examples below:

        ```
        $ body=$(cat << EOF
        {
            "name": "Mars Project",
            "key": "MARS",
            "description": "Software for colonizing mars.",
            "links": {
                "avatar": {
                    "href": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/..."
                }
            },
            "is_private": false
        }
        EOF
        )
        $ curl -H "Content-Type: application/json" \
               -X POST \
               -d "$body" \
               https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .
        {
          // Serialized project document
        }
        ```

        or even:

        ```
        $ body=$(cat << EOF
        {
            "name": "Mars Project",
            "key": "MARS",
            "description": "Software for colonizing mars.",
            "links": {
                "avatar": {
                    "href": "http://i.imgur.com/72tRx4w.gif"
                }
            },
            "is_private": false
        }
        EOF
        )
        $ curl -H "Content-Type: application/json" \
               -X POST \
               -d "$body" \
               https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .
        {
          // Serialized project document
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/project'
        required: true
      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 team doesn't exist at this location.
      security:
      - oauth2:
        - project:write
      - basic: []
      - api_key: []
      tags:
      - projects
      x-tags:
      - tag: projects
  /repositories/{workspace}/{repo_slug}/hooks:
    get:
      description: Returns a paginated list of webhooks installed on this repository.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: webhooks
    post:
      description: |-
        Creates a new webhook on the specified repository.

        Example:

        ```
        $ curl -X POST -u credentials -H 'Content-Type: application/json'           https://api.bitbucket.org/2.0/repositories/username/slug/hooks           -d '
            {
              "description": "Webhook Description",
              "url": "https://example.com/",
              "active": true,
              "events": [
                "repo:push",
                "issue:created",
                "issue:updated"
              ]
            }'
        ```

        Note that this call requires the webhook scope, as well as any scope
        that applies to the events that the webhook subscribes to. In the
        example above that means: `webhook`, `repository` and `issue`.

        Also note that the `url` must properly resolve and cannot be an
        internal, non-routed address.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: webhooks
  /teams/{username}/permissions:
    get:
      description: "Returns an object for each team permission a user on the team\
        \ has.\n\nPermissions returned are effective permissions â\x80\x94 if a user\
        \ is a member of\nmultiple groups with distinct roles, only the highest level\
        \ is returned.\n\nPermissions can be:\n\n* `admin`\n* `collaborator`\n\nOnly\
        \ users with admin permission for the team may access this resource.\n\nExample:\n\
        \n```\n$ curl https://api.bitbucket.org/2.0/teams/atlassian_tutorial/permissions\n\
        \n{\n  \"pagelen\": 10,\n  \"values\": [\n    {\n      \"permission\": \"\
        admin\",\n      \"type\": \"team_permission\",\n      \"user\": {\n      \
        \  \"type\": \"user\",\n        \"username\": \"evzijst\",\n        \"nickname\"\
        : \"evzijst\",\n        \"display_name\": \"Erik van Zijst\",\n        \"\
        uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n      },\n      \"team\"\
        : {\n        \"username\": \"bitbucket\",\n        \"display_name\": \"Atlassian\
        \ Bitbucket\",\n        \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"\
        \n      }\n    },\n    {\n      \"permission\": \"collaborator\",\n      \"\
        type\": \"team_permission\",\n      \"user\": {\n        \"type\": \"user\"\
        ,\n        \"username\": \"seanaty\",\n        \"nickname\": \"seanaty\",\n\
        \        \"display_name\": \"Sean Conaty\",\n        \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\
        \n      },\n      \"team\": {\n        \"username\": \"bitbucket\",\n    \
        \    \"display_name\": \"Atlassian Bitbucket\",\n        \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"\
        \n      }\n    }\n  ],\n  \"page\": 1,\n  \"size\": 2\n}\n```\n\nResults may\
        \ be further [filtered or sorted](../../../meta/filtering) by\nteam, user,\
        \ or permission by adding the following query string\nparameters:\n\n* `q=user.username=\"\
        evzijst\"` or `q=permission=\"admin\"`\n* `sort=team.display_name`\n\nNote\
        \ that the query parameter values need to be URL escaped so that `=`\nwould\
        \ become `%3D`."
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property sort the result by as per
          [filtering and sorting](../../../meta/filtering#query-sort).
        in: query
        name: sort
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_team_permissions'
          description: Repositories owned by a team.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The requesting user isn't an admin of the team.
      security:
      - oauth2:
        - team
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /snippets/{username}/{encoded_id}/comments:
    get:
      description: |-
        Used to retrieve a paginated list of all comments for a specific
        snippet.

        This resource works identical to commit and pull request comments.

        The default sorting is oldest to newest and can be overridden with
        the `sort` query parameter.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    post:
      description: |-
        Creates a new comment.

        The only required field in the body is `content.raw`.

        To create a threaded reply to an existing comment, include `parent.id`.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/snippet'
        description: The contents of the new comment.
        required: true
      responses:
        201:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snippet'
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /users/{username}/search/code:
    get:
      operationId: searchAccount
      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
        schema:
          default: 1
          format: int32
          type: integer
      - description: How many search results to retrieve per page
        in: query
        name: pagelen
        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 following reasons:
            * the specified type of target account doesn't match the actual account type;
            * malformed pagination properties;
            * missing or malformed search query, in the latter case an error key will be returned in `error.data.key` property.
        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 the repositories of the specified user
      tags:
      - search
      x-tags:
      - tag: search
  /teams/{username}/permissions/repositories:
    get:
      description: "Returns an object for each repository permission for all of a\n\
        teamâ\x80\x99s repositories.\n\nIf the username URL parameter refers to a\
        \ user account instead of\na team account, an object containing the repository\
        \ permissions\nof all the username's repositories will be returned.\n\nPermissions\
        \ returned are effective permissions â\x80\x94 the highest level of\npermission\
        \ the user has. This does not include public repositories that\nusers are\
        \ not granted any specific permission in, and does not\ndistinguish between\
        \ direct and indirect 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/teams/atlassian_tutorial/permissions/repositories\n\
        \n{\n  \"pagelen\": 10,\n  \"values\": [\n    {\n      \"type\": \"repository_permission\"\
        ,\n      \"user\": {\n        \"type\": \"user\",\n        \"username\": \"\
        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      \"type\"\
        : \"repository_permission\",\n      \"user\": {\n        \"type\": \"user\"\
        ,\n        \"username\": \"seanaty\",\n        \"display_name\": \"Sean Conaty\"\
        ,\n        \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n      },\n\
        \      \"repository\": {\n        \"type\": \"repository\",\n        \"name\"\
        : \"geordi\",\n        \"full_name\": \"bitbucket/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](../../../../meta/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 `=`\n\
        would become `%3D`."
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property sort the result by as per
          [filtering and sorting](../../../../meta/filtering#query-sort).
        in: query
        name: sort
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_repository_permissions'
          description: List of team's repository permissions.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The requesting user isn't an admin of the team.
      security:
      - oauth2:
        - team
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /repositories/{workspace}/{repo_slug}/refs/tags:
    get:
      description: |-
        Returns the tags in the repository.

        By default, results will be in the order the underlying source control system returns them and identical to
        the ordering one sees when running "$ hg tags" or "$ git tag --list". Note that this follows simple
        lexical ordering of the ref names.

        This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are
        sorted ["v10", "v11", "v9"] instead of ["v9", "v10", "v11"].

        Sorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,
        Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.
      parameters:
      - description: |2

          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |2

          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2-

          Field by which the results should be sorted as per
          [filtering and sorting](../../../../../../meta/filtering). The `name`
          field is handled specially for tags in that, if specified as the sort field, it
          uses a natural sort order instead of the default lexicographical sort order. For example,
          it 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
            access to it.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The specified repository does not exist.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - refs
      x-tags:
      - tag: refs
    post:
      description: |-
        Creates a new tag in the specified repository.

        The payload of the POST should consist of a JSON document that
        contains the name of the tag and the target hash.

        ```
        curl https://api.bitbucket.org/2.0/repositories/jdoe/myrepo/refs/tags \
        -s -u jdoe -X POST -H "Content-Type: application/json" \
        -d '{
            "name" : "new-tag-name",
            "target" : {
                "hash" : "a1b2c3d4e5f6",
            }
        }'
        ```

        This endpoint does support using short hash prefixes for the commit
        hash, but it may return a 400 response if the provided prefix is
        ambiguous. Using a full commit hash is the preferred approach.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - refs
      x-tags:
      - tag: refs
  /users/{username}/followers:
    get:
      description: |-
        Returns the list of accounts that are following this user.

        This operation has been deprecated due to privacy changes.
        See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/) for details.
      parameters:
      - description: The account's username
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          description: A paginated list of user objects.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If no account exists for the specified name, or if the specified
            account is a team account, not a personal account.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - tag: users
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits:
    get:
      description: |-
        Returns a paginated list of the pull request's commits.

        These are the commits that are being merged into the destination
        branch when the pull requests gets accepted.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_pullrequests_commits'
          description: Ok.
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}:
    delete:
      description: Delete a schedule.
      operationId: deleteRepositoryPipelineSchedule
      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 schedule.
        in: path
        name: schedule_uuid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          description: The schedule was deleted.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The account, repository or schedule was not found.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    get:
      description: Retrieve a schedule by its UUID.
      operationId: getRepositoryPipelineSchedule
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    put:
      description: Update a schedule.
      operationId: updateRepositoryPipelineSchedule
      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 schedule.
        in: path
        name: schedule_uuid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipeline_schedule'
        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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /users/{username}/hooks/{uid}:
    delete:
      description: |-
        Deletes the specified webhook subscription from the given user
        account.

        Note that the username path parameter has been deprecated due to
        [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        Use the account's UUID or account_id instead.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The installed webhook's id
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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 user does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: webhooks
    get:
      description: |-
        Returns the webhook with the specified id installed on the given
        user account.

        Note that the username path parameter has been deprecated due to
        [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        Use the account's UUID or account_id instead.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The installed webhook's id.
        in: path
        name: uid
        required: true
        schema:
          type: string
      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 user does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: webhooks
    put:
      description: |-
        Updates the specified webhook subscription.

        The following properties can be mutated:

        * `description`
        * `url`
        * `active`
        * `events`

        Note that the username path parameter has been deprecated due to
        [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        Use the account's UUID or account_id instead.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The installed webhook's id
        in: path
        name: uid
        required: true
        schema:
          type: string
      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 user does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: webhooks
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}:
    get:
      description: Returns the specified pull request.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                source:
                  branch:
                    name: branch_magnificent_internet
                  commit:
                    hash: c184aab5708b
                    type: commit
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/c184aab5708b
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/c184aab5708b
                  repository:
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                    type: repository
                    links:
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                description: Everything is awesome!
                id: 1
                title: Change a cooperative standard to a smiling disease
                summary:
                  html: <p>Everything is awesome!</p>
                  type: rendered
                  markup: markdown
                  raw: Everything is awesome!
                task_count: 0
                type: pullrequest
                comment_count: 0
                author:
                  display_name: Example Username
                  type: user
                  username: example-username
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  nickname: example-username
                  links:
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    html:
                      href: https://bitbucket.org/example-username/
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                reason: ""
                updated_on: 2018-06-20T23:17:33.616037+00:00
                created_on: 2018-06-20T23:17:33.616037+00:00
                reviewers: []
                destination:
                  repository:
                    type: repository
                    links:
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                  commit:
                    hash: 230269fdfabd
                    type: commit
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabd
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/230269fdfabd
                  branch:
                    name: master
                links:
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/commits
                  approve:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/approve
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1
                  merge:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/merge
                  comments:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/comments
                  decline:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/decline
                  diff:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/diff
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs/pull-requests/1
                  activity:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/activity
                  statuses:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/statuses
                close_source_branch: true
                participants: []
                state: OPEN
              schema:
                $ref: '#/components/schemas/pullrequest'
          description: The pull request object
        401:
          content: {}
          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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    put:
      description: |-
        Mutates the specified pull request.

        This can be used to change the pull request's branches or description.

        Only open pull requests can be mutated.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullrequest'
        description: The pull request that is to be updated.
        required: false
      responses:
        200:
          content:
            application/json:
              example:
                state: OPEN
                close_source_branch: true
                participants: []
                links:
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/commits
                  approve:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/approve
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1
                  merge:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/merge
                  comments:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/comments
                  decline:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/decline
                  diff:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/diff
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs/pull-requests/1
                  activity:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/activity
                  statuses:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/statuses
                destination:
                  repository:
                    name: bits_and_bobs
                    full_name: example-username/bits_and_bobs
                    type: repository
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                  commit:
                    type: commit
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabd
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/230269fdfabd
                    hash: 230269fdfabd
                  branch:
                    name: master
                reviewers: []
                created_on: 2018-06-20T23:17:33.616037+00:00
                updated_on: 2018-06-20T23:17:33.616037+00:00
                reason: ""
                author:
                  type: user
                  username: example-username
                  display_name: Example Username
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  links:
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    html:
                      href: https://bitbucket.org/example-username/
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  nickname: example-username
                comment_count: 0
                type: pullrequest
                task_count: 0
                summary:
                  type: rendered
                  html: <p>Everything is awesome!</p>
                  raw: Everything is awesome!
                  markup: markdown
                id: 1
                title: Change a cooperative standard to a smiling disease
                description: Everything is awesome!
                source:
                  repository:
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                    type: repository
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                  branch:
                    name: branch_magnificent_internet
                  commit:
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/c184aab5708b
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/c184aab5708b
                    type: commit
                    hash: c184aab5708b
              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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote:
    delete:
      description: Retract your vote.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - issue:write
        - account:write
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    get:
      description: |-
        Check whether the authenticated user has voted for this issue.
        A 204 status code indicates that the user has voted, while a 404
        implies they haven't.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - issue
        - account
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    put:
      description: |-
        Vote for this issue.

        To cast your vote, do an empty PUT. The 204 status code indicates that
        the operation was successful.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - issue
        - account:write
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log:
    get:
      description: |-
        Retrieve the log file for a given step of a pipeline.

        This 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: 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 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: {}
          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).
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /teams/{username}/hooks:
    get:
      description: Returns a paginated list of webhooks installed on this team.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      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 admin on the specified
            team.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If the specified team does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - hasMore: "true"
        tag: teams
      - tag: webhooks
    post:
      description: |-
        Creates a new webhook on the specified team.

        Team webhooks are fired for events from all repositories belonging to
        that team account.

        Note that only admins can install webhooks on teams.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        201:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_subscription'
          description: The newly installed webhook.
          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 is not an admin on the specified
            team.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If the specified team does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - hasMore: "true"
        tag: teams
      - tag: webhooks
  /users/{username}/following:
    get:
      description: |-
        Returns the list of accounts this user is following.

        This operation has been deprecated due to privacy changes.
        See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/) for details.
      parameters:
      - description: The user's username
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          description: A paginated list of user objects.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If no user exists for the specified name, or if the specified
            account is a team account, not a personal account.
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - tag: users
  /repositories/{workspace}/{repo_slug}/src:
    get:
      description: |-
        This endpoint redirects the client to the directory listing of the
        root directory on the main branch.

        This is equivalent to directly hitting
        [/2.0/repositories/{workspace}/{repo_slug}/src/{node}/{path}](src/%7Bnode%7D/%7Bpath%7D)
        without having to know the name or SHA1 of the repo's main branch.

        To create new commits, [POST to this endpoint](#post)
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: Instead of returning the file's contents, return the (json) meta
          data for it.
        in: query
        name: format
        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
            returned (unless the `format=meta` query parameter was provided,
            in which case a json document containing the file's meta data is
            returned). If the path matches a directory, then a paginated
            list of file and directory entries is returned (if the
            `format=meta` query parameter was provided, then the json document
            containing the directory's meta data is returned).
        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: []
      tags:
      - source
      x-tags:
      - hasMore: "true"
        tag: source
      - tag: repositories
    post:
      description: |-
        This endpoint is used to create new commits in the repository by
        uploading files.

        To add a new file to a repository:

        ```
        $ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \
          -F /repo/path/to/image.png=@image.png
        ```

        This will create a new commit on top of the main branch, inheriting the
        contents of the main branch, but adding (or overwriting) the
        `image.png` file to the repository in the `/repo/path/to` directory.

        To create a commit that deletes files, use the `files` parameter:

        ```
        $ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \
          -F files=/file/to/delete/1.txt \
          -F files=/file/to/delete/2.txt
        ```

        You can add/modify/delete multiple files in a request. Rename/move a
        file by deleting the old path and adding the content at the new path.

        This endpoint accepts `multipart/form-data` (as in the examples above),
        as well as `application/x-www-form-urlencoded`.

        ## multipart/form-data

        A `multipart/form-data` post contains a series of "form fields" that
        identify both the individual files that are being uploaded, as well as
        additional, optional meta data.

        Files are uploaded in file form fields (those that have a
        `Content-Disposition` parameter) whose field names point to the remote
        path in the repository where the file should be stored. Path field
        names are always interpreted to be absolute from the root of the
        repository, regardless whether the client uses a leading slash (as the
        above `curl` example did).

        File contents are treated as bytes and are not decoded as text.

        The commit message, as well as other non-file meta data for the
        request, is sent along as normal form field elements. Meta data fields
        share the same namespace as the file objects. For `multipart/form-data`
        bodies that should not lead to any ambiguity, as the
        `Content-Disposition` header will contain the `filename` parameter to
        distinguish between a file named "message" and the commit message field.

        ## application/x-www-form-urlencoded

        It is also possible to upload new files using a simple
        `application/x-www-form-urlencoded` POST. This can be convenient when
        uploading pure text files:

        ```
        $ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src \
          --data-urlencode "/path/to/me.txt=Lorem ipsum." \
          --data-urlencode "message=Initial commit" \
          --data-urlencode "author=Erik van Zijst <erik.van.zijst@gmail.com>"
        ```

        There could be a field name clash if a client were to upload a file
        named "message", as this filename clashes with the meta data property
        for the commit message. To avoid this and to upload files whose names
        clash with the meta data properties, use a leading slash for the files,
        e.g. `curl --data-urlencode "/message=file contents"`.

        When an explicit slash is omitted for a file whose path matches that of
        a meta data parameter, then it is interpreted as meta data, not as a
        file.

        ## Executables and links

        While this API aims to facilitate the most common use cases, it is
        possible to perform some more advanced operations like creating a new
        symlink in the repository, or creating an executable file.

        Files can be supplied with a `x-attributes` value in the
        `Content-Disposition` header. For example, to upload an executable
        file, as well as create a symlink from `README.txt` to `README`:

        ```
        --===============1438169132528273974==
        Content-Type: text/plain; charset="us-ascii"
        MIME-Version: 1.0
        Content-Transfer-Encoding: 7bit
        Content-ID: "bin/shutdown.sh"
        Content-Disposition: attachment; filename="shutdown.sh"; x-attributes:"executable"

        #!/bin/sh
        halt

        --===============1438169132528273974==
        Content-Type: text/plain; charset="us-ascii"
        MIME-Version: 1.0
        Content-Transfer-Encoding: 7bit
        Content-ID: "/README.txt"
        Content-Disposition: attachment; filename="README.txt"; x-attributes:"link"

        README
        --===============1438169132528273974==--
        ```

        Links are files that contain the target path and have
        `x-attributes:"link"` set.

        When overwriting links with files, or vice versa, the newly uploaded
        file determines both the new contents, as well as the attributes. That
        means uploading a file without specifying `x-attributes="link"` will
        create a regular file, even if the parent commit hosted a symlink at
        the same path.

        The same applies to executables. When modifying an existing executable
        file, the form-data file element must include
        `x-attributes="executable"` in order to preserve the executable status
        of the file.

        Note that this API does not support the creation or manipulation of
        subrepos / submodules.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The commit message. When omitted, Bitbucket uses a canned string.
        in: query
        name: message
        schema:
          type: string
      - description: |2-

          The raw string to be used as the new commit's author.
          This string follows the format
          `Erik van Zijst <evzijst@atlassian.com>`.

          When omitted, Bitbucket uses the authenticated user's
          full/display name and primary email address. Commits cannot
          be created anonymously.
        in: query
        name: author
        schema:
          type: string
      - description: |2-

          A comma-separated list of SHA1s of the commits that should
          be the parents of the newly created commit.

          When omitted, the new commit will inherit from and become
          a child of the main branch's tip/HEAD commit.

          When more than one SHA1 is provided, the first SHA1
          identifies the commit from which the content will be
          inherited.

          When more than 2 parents are provided on a Mercurial repo,
          a 400 is returned as Mercurial does not support octopus merges.
        in: query
        name: parents
        schema:
          type: string
      - description: |2

          Optional field that declares the files that the request is
          manipulating. When adding a new file to a repo, or when
          overwriting an existing file, the client can just upload
          the full contents of the file in a normal form field and
          the use of this `files` meta data field is redundant.
          However, when the `files` field contains a file path that
          does not have a corresponding, identically-named form
          field, then Bitbucket interprets that as the client wanting
          to replace the named file with the null set and the file is
          deleted instead.

          Paths in the repo that are referenced in neither files nor
          an individual file field, remain unchanged and carry over
          from the parent to the new commit.

          This API does not support renaming as an explicit feature.
          To rename a file, simply delete it and recreate it under
          the new name in the same commit.
        in: query
        name: files
        schema:
          type: string
      - description: |2

          The name of the branch that the new commit should be
          created on. When omitted, the commit will be created on top
          of the main branch and will become the main branch's new
          HEAD/tip.

          When a branch name is provided that already exists in the
          repo, then the commit will be created on top of that
          branch. In this case, if a parent SHA1 was also provided,
          then it is asserted that the parent is the branch's
          tip/HEAD at the time the request is made. When this is not
          the case, a 409 is returned.

          This API cannot be used to create new anonymous heads in
          Mercurial repos.

          When a new branch name is specified (that does not already
          exist in the repo), and no parent SHA1s are provided, then
          the new commit will inherit from the current main branch's
          tip/HEAD commit, but not advance the main branch. The new
          commit will be the new branch. When the request also
          specifies a parent SHA1, then the new commit and branch
          are created directly on top of the parent commit,
          regardless of the state of the main branch.

          When a branch name is not specified, but a parent SHA1 is
          provided, then Bitbucket asserts that it represents the
          main branch's current HEAD/tip, or a 409 is returned.

          When a branch name is not specified and the repo is empty,
          the new commit will become the repo's root commit and will
          be on the main branch.

          When a branch name is specified and the repo is empty, the
          new commit will become the repo's root commit and also
          define the repo's main branch going forward.

          This API cannot be used to create additional root commits
          in non-empty repos.

          The branch field cannot be repeated.

          As a side effect, this API can be used to create a new
          branch without modifying any files, by specifying a new
          branch name in this field, together with parents, but
          omitting the files fields, while not sending any files.
          This will create a new commit and branch with the same
          contents as the first parent. The diff of this commit
          against its first parent will be empty.
        in: query
        name: files
        schema:
          type: string
      - description: |2

          The name of the branch that the new commit should be
          created on. When omitted, the commit will be created on top
          of the main branch and will become the main branch's new
          head.

          When a branch name is provided that already exists in the
          repo, then the commit will be created on top of that
          branch. In this case, *if* a parent SHA1 was also provided,
          then it is asserted that the parent is the branch's
          tip/HEAD at the time the request is made. When this is not
          the case, a 409 is returned.

          This API cannot be used to create new anonymous heads in
          Mercurial repositories.

          When a new branch name is specified (that does not already
          exist in the repo), and no parent SHA1s are provided, then
          the new commit will inherit from the current main branch's
          tip/HEAD commit, but not advance the main branch. The new
          commit will be the new branch. When the request *also*
          specifies a parent SHA1, then the new commit and branch
          are created directly on top of the parent commit,
          regardless of the state of the main branch.

          When a branch name is not specified, but a parent SHA1 is
          provided, then Bitbucket asserts that it represents the
          main branch's current HEAD/tip, or a 409 is returned.

          When a branch name is not specified and the repo is empty,
          the new commit will become the repo's root commit and will
          be on the main branch.

          When a branch name is specified and the repo is empty, the
          new commit will become the repo's root commit and also
          define the repo's main branch going forward.

          This API cannot be used to create additional root commits
          in non-empty repos.

          The branch field cannot be repeated.

          As a side effect, this API can be used to create a new
          branch without modifying any files, by specifying a new
          branch name in this field, together with `parents`, but
          omitting the `files` fields, while not sending any files.
          This will create a new commit and branch with the same
          contents as the first parent. The diff of this commit
          against its first parent will be empty.
        in: query
        name: branch
        schema:
          type: string
      responses:
        200:
          content: {}
          description: |2+

        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If the repository does not exist.
      security:
      - oauth2:
        - repository:write
      - basic: []
      - api_key: []
      tags:
      - source
      x-tags:
      - hasMore: "true"
        tag: source
      - tag: repositories
  /snippets/{username}/{encoded_id}/comments/{comment_id}:
    delete:
      description: |-
        Deletes a snippet comment.

        Comments can only be removed by their author.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    get:
      description: Returns the specific snippet comment.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    put:
      description: |-
        Updates a comment.

        Comments can only be updated by their author.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        200:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes/:
    post:
      description: Update an environment
      operationId: updateEnvironmentForRepository
      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 environment UUID.
        in: path
        name: environment_uuid
        required: true
        schema:
          type: string
      responses:
        202:
          content: {}
          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.
      tags:
      - deployments
      x-tags:
      - tag: deployments
  /repositories/{workspace}/{repo_slug}/issues/import:
    get:
      description: |-
        When using GET, this endpoint reports the status of the current import task. Request example:

        ```
        $ curl -u <username> -X GET https://api.bitbucket.org/2.0/repositories/<owner_username>/<repo_slug>/issues/import
        ```

        After the job has been scheduled, but before it starts executing, this endpoint's response is:

        ```
        < HTTP/1.1 202 Accepted
        {
            "type": "issue_job_status",
            "status": "PENDING",
            "phase": "Attachments",
            "total": 15,
            "count": 0,
            "percent": 0
        }
        ```

        Once it starts running, it is a 202 response with status STARTED and progress filled.

        After it is finished, it becomes a 200 response with status SUCCESS or FAILURE.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - repository:admin
        - issue:write
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
    post:
      description: |-
        A POST request to this endpoint will import the zip file given by the archive parameter into the repository. All
        existing issues will be deleted and replaced by the contents of the imported zip file.

        Imports are done through a multipart/form-data POST. There is one valid and required form field, with the name
        "archive," which needs to be a file field:

        ```
        $ curl -u <username> -X POST -F archive=@/path/to/file.zip https://api.bitbucket.org/2.0/repositories/<owner_username>/<repo_slug>/issues/import
        ```

        When the import job is accepted, here is example output:

        ```
        < HTTP/1.1 202 Accepted

        {
            "type": "issue_job_status",
            "status": "ACCEPTED",
            "phase": "Attachments",
            "total": 15,
            "count": 0,
            "percent": 0
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - repository:admin
        - issue:write
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /teams/{username}/repositories:
    get:
      description: |-
        All repositories owned by a user/team. This includes private
        repositories, but filtered down to the ones that the calling user has
        access to.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: teams
  /snippets/{username}/{encoded_id}/{node_id}/files/{path}:
    get:
      description: |-
        Retrieves the raw contents of a specific file in the snippet. The
        `Content-Disposition` header will be "attachment" to avoid issues with
        malevolent executable files.

        The file's mime type is derived from its filename and returned in the
        `Content-Type` header.

        Note that for text files, no character encoding is included as part of
        the content type.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      - in: path
        name: node_id
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        200:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /user/permissions/repositories:
    get:
      description: "Returns an object for each repository the caller has explicit\
        \ access\nto and their effective permission â\x80\x94 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\ndirect and indirect 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        \"username\": \"\
        evzijst\",\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](../../../meta/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 `=`\n\
        would become `%3D`."
      parameters:
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property sort the result by as per
          [filtering and sorting](../../../meta/filtering#query-sort).
        in: query
        name: sort
        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
      - basic: []
      - api_key: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
  /repositories/{workspace}/{repo_slug}/hooks/{uid}:
    delete:
      description: |-
        Deletes the specified webhook subscription from the given
        repository.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The installed webhook's id
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: webhooks
    get:
      description: |-
        Returns the webhook with the specified id installed on the specified
        repository.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The installed webhook's id.
        in: path
        name: uid
        required: true
        schema:
          type: string
      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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: webhooks
    put:
      description: |-
        Updates the specified webhook subscription.

        The following properties can be mutated:

        * `description`
        * `url`
        * `active`
        * `events`
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The installed webhook's id
        in: path
        name: uid
        required: true
        schema:
          type: string
      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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: webhooks
  /repositories/{workspace}/{repo_slug}/environments/:
    get:
      description: Find environments
      operationId: getEnvironmentsForRepository
      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_environments'
          description: The matching environments.
      tags:
      - deployments
      x-tags:
      - tag: deployments
    post:
      description: Create an environment.
      operationId: createEnvironment
      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
      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.
      tags:
      - deployments
      x-tags:
      - tag: deployments
  /teams/{username}/pipelines_config/variables/{variable_uuid}:
    delete:
      description: Delete a team level variable.
      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:
          content: {}
          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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    get:
      description: Retrieve a team level variable.
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    put:
      description: Update a team level variable.
      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:
        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 or the variable was not found.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/default-reviewers:
    get:
      description: |-
        Returns the repository's default reviewers.

        These are the users that are automatically added as reviewers on every
        new pull request that is created.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content: {}
          description: The paginated list of default reviewers
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve:
    delete:
      description: |-
        Redact the authenticated user's approval of the specified pull
        request.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          description: An empty response indicating the authenticated user's approval
            has been withdrawn.
        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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    post:
      description: Approve the specified pull request as the authenticated user.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/participant'
          description: The `participant` object recording that the authenticated user
            approved the pull request.
        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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/milestones/{milestone_id}:
    get:
      description: Returns the specified issue tracker milestone object.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The milestone's id
        in: path
        name: milestone_id
        required: true
        schema:
          type: integer
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/milestones:
    get:
      description: |-
        Returns the milestones that have been defined in the issue tracker.

        This resource is only available on repositories that have the issue
        tracker enabled.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/issues/export:
    post:
      description: |-
        A POST request to this endpoint initiates a new background celery task that archives the repo's issues.

        For example, you can run:

        curl -u <username> -X POST http://api.bitbucket.org/2.0/repositories/<owner_username>/<repo_slug>/
        issues/export

        When the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the
        'Location' response header. This url is the endpoint for where the user can obtain their zip files."
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        202:
          content: {}
          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:
        - repository:admin
        - issue
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /user/emails:
    get:
      description: |-
        Returns all the authenticated user's email addresses. Both
        confirmed and unconfirmed.
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - email
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - tag: users
  /repositories/{workspace}/{repo_slug}/refs/branches:
    get:
      description: |-
        Returns a list of all open branches within the specified repository.
        Results will be in the order the source control manager returns them.

        ```
        $ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/refs/branches | jq .
        {
          "pagelen": 10,
          "values": [
            {
              "heads": [
                {
                  "hash": "f1a0933ce59e809f190602655e22ae6ec107c397",
                  "type": "commit",
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397"
                    },
                    "html": {
                      "href": "https://bitbucket.org/seanfarley/mercurial/commits/f1a0933ce59e809f190602655e22ae6ec107c397"
                    }
                  }
                }
              ],
              "type": "named_branch",
              "name": "default",
              "links": {
                "commits": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commits/default"
                },
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/refs/branches/default"
                },
                "html": {
                  "href": "https://bitbucket.org/seanfarley/mercurial/branch/default"
                }
              },
              "target": {
                "hash": "f1a0933ce59e809f190602655e22ae6ec107c397",
                "repository": {
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial"
                    },
                    "html": {
                      "href": "https://bitbucket.org/seanfarley/mercurial"
                    },
                    "avatar": {
                      "href": "https://bitbucket.org/seanfarley/mercurial/avatar/32/"
                    }
                  },
                  "type": "repository",
                  "name": "mercurial",
                  "full_name": "seanfarley/mercurial",
                  "uuid": "{73dcbd61-e506-4fc1-9ecd-31be2b6d6031}"
                },
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397"
                  },
                  "comments": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397/comments"
                  },
                  "patch": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/patch/f1a0933ce59e809f190602655e22ae6ec107c397"
                  },
                  "html": {
                    "href": "https://bitbucket.org/seanfarley/mercurial/commits/f1a0933ce59e809f190602655e22ae6ec107c397"
                  },
                  "diff": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/diff/f1a0933ce59e809f190602655e22ae6ec107c397"
                  },
                  "approve": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397/approve"
                  },
                  "statuses": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397/statuses"
                  }
                },
                "author": {
                  "raw": "Martin von Zweigbergk <martinvonz@google.com>",
                  "type": "author",
                  "user": {
                    "username": "martinvonz",
                    "nickname": "martinvonz",
                    "display_name": "Martin von Zweigbergk",
                    "type": "user",
                    "uuid": "{fdb0e657-3ade-4fad-a136-95f1ffe4a5ac}",
                    "links": {
                      "self": {
                        "href": "https://api.bitbucket.org/2.0/users/martinvonz"
                      },
                      "html": {
                        "href": "https://bitbucket.org/martinvonz/"
                      },
                      "avatar": {
                        "href": "https://bitbucket.org/account/martinvonz/avatar/32/"
                      }
                    }
                  }
                },
                "parents": [
                  {
                    "hash": "5523aabb85c30ebc2b8e29aadcaf5e13fa92b375",
                    "type": "commit",
                    "links": {
                      "self": {
                        "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/5523aabb85c30ebc2b8e29aadcaf5e13fa92b375"
                      },
                      "html": {
                        "href": "https://bitbucket.org/seanfarley/mercurial/commits/5523aabb85c30ebc2b8e29aadcaf5e13fa92b375"
                      }
                    }
                  }
                ],
                "date": "2018-02-01T18:44:49+00:00",
                "message": "config: replace a for-else by any()",
                "type": "commit"
              }
            },
            {
              "heads": [
                {
                  "hash": "1d60ad093792706e1dc7a52b20942593f2c19655",
                  "type": "commit",
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/1d60ad093792706e1dc7a52b20942593f2c19655"
                    },
                    "html": {
                      "href": "https://bitbucket.org/seanfarley/mercurial/commits/1d60ad093792706e1dc7a52b20942593f2c19655"
                    }
                  }
                }
              ],
              "type": "named_branch",
              "name": "stable",
              "links": {
                "commits": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commits/stable"
                },
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/refs/branches/stable"
                },
                "html": {
                  "href": "https://bitbucket.org/seanfarley/mercurial/branch/stable"
                }
              },
              "target": {
                "hash": "1d60ad093792706e1dc7a52b20942593f2c19655",
                "repository": {
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial"
                    },
                    "html": {
                      "href": "https://bitbucket.org/seanfarley/mercurial"
                    },
                    "avatar": {
                      "href": "https://bitbucket.org/seanfarley/mercurial/avatar/32/"
                    }
                  },
                  "type": "repository",
                  "name": "mercurial",
                  "full_name": "seanfarley/mercurial",
                  "uuid": "{73dcbd61-e506-4fc1-9ecd-31be2b6d6031}"
                },
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/1d60ad093792706e1dc7a52b20942593f2c19655"
                  },
                  "comments": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/1d60ad093792706e1dc7a52b20942593f2c19655/comments"
                  },
                  "patch": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/patch/1d60ad093792706e1dc7a52b20942593f2c19655"
                  },
                  "html": {
                    "href": "https://bitbucket.org/seanfarley/mercurial/commits/1d60ad093792706e1dc7a52b20942593f2c19655"
                  },
                  "diff": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/diff/1d60ad093792706e1dc7a52b20942593f2c19655"
                  },
                  "approve": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/1d60ad093792706e1dc7a52b20942593f2c19655/approve"
                  },
                  "statuses": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/1d60ad093792706e1dc7a52b20942593f2c19655/statuses"
                  }
                },
                "author": {
                  "raw": "Augie Fackler <raf@durin42.com>",
                  "type": "author",
                  "user": {
                    "username": "durin42",
                    "nickname": "durin42",
                    "display_name": "Augie Fackler",
                    "type": "user",
                    "uuid": "{e07dc61f-bb05-4218-b43a-d991f26be65a}",
                    "links": {
                      "self": {
                        "href": "https://api.bitbucket.org/2.0/users/durin42"
                      },
                      "html": {
                        "href": "https://bitbucket.org/durin42/"
                      },
                      "avatar": {
                        "href": "https://bitbucket.org/account/durin42/avatar/32/"
                      }
                    }
                  }
                },
                "parents": [
                  {
                    "hash": "56a0da11bde519d79168e890df4bcf0da62f0a7b",
                    "type": "commit",
                    "links": {
                      "self": {
                        "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/56a0da11bde519d79168e890df4bcf0da62f0a7b"
                      },
                      "html": {
                        "href": "https://bitbucket.org/seanfarley/mercurial/commits/56a0da11bde519d79168e890df4bcf0da62f0a7b"
                      }
                    }
                  }
                ],
                "date": "2018-02-01T19:13:41+00:00",
                "message": "Added signature for changeset d334afc585e2",
                "type": "commit"
              }
            }
          ],
          "page": 1,
          "size": 2
        }
        ```

        Branches support [filtering and sorting](../../../../../meta/filtering)
        that can be used to search for specific branches. For instance, to find
        all branches that have "stab" in their name:

        ```
        curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/refs/branches -G --data-urlencode 'q=name ~ "stab"'
        ```

        By default, results will be in the order the underlying source control system returns them and identical to
        the ordering one sees when running "$ hg branches" or "$ git branch --list". Note that this follows simple
        lexical ordering of the ref names.

        This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are
        sorted ["v10", "v11", "v9"] instead of ["v9", "v10", "v11"].

        Sorting can be changed using the ?q= query parameter. When using ?q=name to explicitly sort on ref name,
        Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.
      parameters:
      - description: |2

          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |2

          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2-

          Field by which the results should be sorted as per
          [filtering and sorting](../../../../../../meta/filtering). The `name`
          field is handled specially for branches in that, if specified as the sort field, it
          uses a natural sort order instead of the default lexicographical sort order. For example,
          it 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
            access to it.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The specified repository does not exist.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - refs
      x-tags:
      - tag: refs
    post:
      description: |-
        Creates a new branch in the specified repository.

        The payload of the POST should consist of a JSON document that
        contains the name of the tag and the target hash.

        ```
        curl https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/branches \
        -s -u seanfarley -X POST -H "Content-Type: application/json" \
        -d '{
            "name" : "smf/create-feature",
            "target" : {
                "hash" : "default",
            }
        }'
        ```

        This call requires authentication. Private repositories require the
        caller to authenticate with an account that has appropriate
        authorization.

        For Git, the branch name should not include any prefixes (e.g.
        refs/heads). This endpoint does support using short hash prefixes for
        the commit hash, but it may return a 400 response if the provided
        prefix is ambiguous. Using a full commit hash is the preferred
        approach.

        For Mercurial, the authenticated user making this call is the author of
        the new branch commit and the date is current datetime of the call.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        201:
          content:
            application/json:
              example:
                target:
                  message: Kickass commit message!
                  date: 2018-06-20T23:17:33+00:00
                  repository:
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                    type: repository
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                  links:
                    approve:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2/approve
                    self:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2
                    comments:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2/comments
                    diff:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/diff/230269fdfabdb5562a991f351b5dd6425de232d2
                    html:
                      href: https://bitbucket.org/example-username/bits_and_bobs/commits/230269fdfabdb5562a991f351b5dd6425de232d2
                    patch:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/patch/230269fdfabdb5562a991f351b5dd6425de232d2
                    statuses:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2/statuses
                  parents: []
                  type: commit
                  hash: 230269fdfabdb5562a991f351b5dd6425de232d2
                  author:
                    type: author
                    user:
                      display_name: Example Username
                      type: user
                      username: example-username
                      nickname: example-username
                      account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                      links:
                        html:
                          href: https://bitbucket.org/example-username/
                        avatar:
                          href: https://bitbucket.org/account/example-username/avatar/
                        self:
                          href: https://api.bitbucket.org/2.0/users/example-username
                      uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                    raw: Example Username <brian_stamm@gmail.com>
                name: master
                type: branch
                links:
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches/master
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits/master
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs/branch/master
              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
            access to it.
        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: []
      tags:
      - refs
      x-tags:
      - tag: refs
  /addon/linkers/{linker_key}:
    get:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
  /snippets/{username}/{encoded_id}/watchers:
    get:
      deprecated: true
      description: Returns a paginated list of all users watching a specific snippet.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/versions/{version_id}:
    get:
      description: Returns the specified issue tracker version object.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        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
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}:
    delete:
      description: Deletes the specified comment.
      parameters:
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          The ID of the issue that is being queried.
        in: path
        name: issue_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/issue_comment'
        description: The updated comment.
        required: true
      responses:
        204:
          content: {}
          description: Indicates successful deletion.
      security:
      - oauth2:
        - issue:write
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    get:
      description: Returns the specified issue comment object.
      parameters:
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          The ID of the issue that is being queried.
        in: path
        name: issue_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/issue_comment'
          description: The issue comment.
      security:
      - oauth2:
        - issue
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    put:
      description: |-
        Updates the content of the specified issue comment. Note that only
        the `content.raw` field can be modified.

        ```
        $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \
          -X PUT -u evzijst \
          -H 'Content-Type: application/json' \
          -d '{"content": {"raw": "Lorem ipsum."}'
        ```
      parameters:
      - in: path
        name: comment_id
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          The ID of the issue that is being queried.
        in: path
        name: issue_id
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments:
    get:
      description: |-
        Returns all attachments for this issue.

        This returns the files' meta data. This does not return the files'
        actual contents.

        The files are always ordered by their upload date.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The issue's id
        in: path
        name: issue_id
        required: true
        schema:
          type: integer
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_issue_attachments'
          description: A paginated list of all attachments for this issue.
        401:
          content: {}
          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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    post:
      description: |-
        Upload new issue attachments.

        To upload files, perform a `multipart/form-data` POST containing one
        or more file fields.

        When a file is uploaded with the same name as an existing attachment,
        then the existing file will be replaced.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The issue's id
        in: path
        name: issue_id
        required: true
        schema:
          type: integer
      responses:
        201:
          content: {}
          description: An empty response document.
          headers:
            Location:
              description: The URL to the issue's collection of attachments.
              schema:
                type: string
        400:
          content: {}
          description: If no files were uploaded, or if the wrong `Content-Type` was
            used.
        401:
          content: {}
          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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /snippets/{username}/{encoded_id}/{revision}/patch:
    get:
      description: |-
        Returns the patch of the specified commit against its first
        parent.

        Note that this resource is different in functionality from the `diff`
        resource.

        The differences between a diff and a patch are:

        * patches have a commit header with the username, message, etc
        * diffs support the optional `path=foo/bar.py` query param to filter the
          diff to just that one file diff (not supported for patches)
        * for a merge, the diff will show the diff between the merge commit and
          its first parent (identical to how PRs work), while patch returns a
          response containing separate patches for each commit on the second
          parent's ancestry, up to the oldest common ancestor (identical to
          its reachability).

        Note that the character encoding of the contents of the patch is
        unspecified as Git and Mercurial do not track this, making it hard for
        Bitbucket to reliably determine this.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - 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
      responses:
        200:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/refs/tags/{name}:
    delete:
      description: |-
        Delete a tag in the specified repository.

        For Git, the tag name should not include any prefixes (e.g. refs/tags).
        For Mercurial, this adds a commit to the main branch that removes the
        specified tag.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - 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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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
            access to it.
        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: []
      tags:
      - refs
      x-tags:
      - tag: refs
    get:
      description: |-
        Returns the specified tag.

        ```
        $ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8 -G | jq .
        {
          "name": "3.8",
          "links": {
            "commits": {
              "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commits/3.8"
            },
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8"
            },
            "html": {
              "href": "https://bitbucket.org/seanfarley/hg/commits/tag/3.8"
            }
          },
          "tagger": {
            "raw": "Matt Mackall <mpm@selenic.com>",
            "type": "author",
            "user": {
              "username": "mpmselenic",
              "nickname": "mpmselenic",
              "display_name": "Matt Mackall",
              "type": "user",
              "uuid": "{a4934530-db4c-419c-a478-9ab4964c2ee7}",
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/users/mpmselenic"
                },
                "html": {
                  "href": "https://bitbucket.org/mpmselenic/"
                },
                "avatar": {
                  "href": "https://bitbucket.org/account/mpmselenic/avatar/32/"
                }
              }
            }
          },
          "date": "2016-05-01T18:52:25+00:00",
          "message": "Added tag 3.8 for changeset f85de28eae32",
          "type": "tag",
          "target": {
            "hash": "f85de28eae32e7d3064b1a1321309071bbaaa069",
            "repository": {
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg"
                },
                "html": {
                  "href": "https://bitbucket.org/seanfarley/hg"
                },
                "avatar": {
                  "href": "https://bitbucket.org/seanfarley/hg/avatar/32/"
                }
              },
              "type": "repository",
              "name": "hg",
              "full_name": "seanfarley/hg",
              "uuid": "{c75687fb-e99d-4579-9087-190dbd406d30}"
            },
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069"
              },
              "comments": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/comments"
              },
              "patch": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/patch/f85de28eae32e7d3064b1a1321309071bbaaa069"
              },
              "html": {
                "href": "https://bitbucket.org/seanfarley/hg/commits/f85de28eae32e7d3064b1a1321309071bbaaa069"
              },
              "diff": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/diff/f85de28eae32e7d3064b1a1321309071bbaaa069"
              },
              "approve": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/approve"
              },
              "statuses": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/statuses"
              }
            },
            "author": {
              "raw": "Sean Farley <sean@farley.io>",
              "type": "author",
              "user": {
                "username": "seanfarley",
                "nickname": "seanfarley",
                "display_name": "Sean Farley",
                "type": "user",
                "uuid": "{a295f8a8-5876-4d43-89b5-3ad8c6c3c51d}",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/users/seanfarley"
                  },
                  "html": {
                    "href": "https://bitbucket.org/seanfarley/"
                  },
                  "avatar": {
                    "href": "https://bitbucket.org/account/seanfarley/avatar/32/"
                  }
                }
              }
            },
            "parents": [
              {
                "hash": "9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2",
                "type": "commit",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2"
                  },
                  "html": {
                    "href": "https://bitbucket.org/seanfarley/hg/commits/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2"
                  }
                }
              }
            ],
            "date": "2016-05-01T04:21:17+00:00",
            "message": "debian: alphabetize build deps",
            "type": "commit"
          }
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - 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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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
            access to it.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The specified repository or tag does not exist.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - refs
      x-tags:
      - tag: refs
  /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}:
    get:
      description: Retrieve a given step of a pipeline.
      operationId: getPipelineStepForRepository
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}:
    delete:
      description: |-
        Deletes the repository. This is an irreversible operation.

        This does not affect its forks.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          If a repository has been moved to a new location, use this parameter to
          show users a friendly message in the Bitbucket UI that the repository
          has moved to a new location. However, a GET to this endpoint will still
          return a 404.
        in: query
        name: redirect_to
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
    get:
      description: Returns the object describing this repository.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                has_wiki: false
                is_private: true
                slug: bits_and_bobs
                uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                links:
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits
                  branches:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches
                  downloads:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/downloads
                  watchers:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/watchers
                  clone:
                  - name: https
                    href: https://bitbucket.org/example-username/bits_and_bobs.git
                  - href: git@bitbucket.org:example-username/bits_and_bobs.git
                    name: ssh
                  avatar:
                    href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                  source:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/src
                  pullrequests:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                  tags:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/tags
                  forks:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/forks
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs
                size: 33348
                full_name: example-username/bits_and_bobs
                created_on: 2018-06-20T23:17:33.616037+00:00
                website: www.example.com
                updated_on: 2018-06-20T23:17:33.616037+00:00
                owner:
                  nickname: example-username
                  links:
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    html:
                      href: https://bitbucket.org/example-username/
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  display_name: Example Username
                  type: user
                  username: example-username
                language: python
                mainbranch:
                  name: master
                  type: branch
                type: repository
                has_issues: false
                fork_policy: allow_forks
                scm: git
                name: bits_and_bobs
                description: A repository for my bits and bobs
              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: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
    post:
      description: |-
        Creates a new repository.

        Note: In order to set the project for the newly created repository,
        pass in either the project key or the project UUID as part of the
        request body as shown in the examples below:

        ```
        $ curl -X POST -H "Content-Type: application/json" -d '{
            "scm": "git",
            "project": {
                "key": "MARS"
            }
        }' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding
        ```

        or

        ```
        $ curl -X POST -H "Content-Type: application/json" -d '{
            "scm": "git",
            "project": {
                "key": "{ba516952-992a-4c2d-acbd-17d502922f96}"
            }
        }' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding
        ```

        The project must only be assigned for repositories belonging to a team.
        If the repository owner is a team and the project is not provided, the
        repository is automatically assigned to the oldest project in the team.

        Note: In the examples above, the username `teamsinspace`,
        and/or the repository name `hablanding` can be replaced by UUIDs.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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.
        required: false
      responses:
        200:
          content:
            application/json:
              example:
                has_issues: false
                scm: git
                fork_policy: allow_forks
                name: bits_and_bobs
                description: A repository for my bits and bobs
                has_wiki: false
                is_private: true
                uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                slug: bits_and_bobs
                links:
                  pullrequests:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                  tags:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/tags
                  forks:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/forks
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs
                  downloads:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/downloads
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits
                  branches:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches
                  clone:
                  - name: https
                    href: https://bitbucket.org/example-username/bits_and_bobs.git
                  - href: git@bitbucket.org:example-username/bits_and_bobs.git
                    name: ssh
                  watchers:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/watchers
                  avatar:
                    href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                  source:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/src
                size: 33348
                full_name: example-username/bits_and_bobs
                created_on: 2018-06-20T23:17:33.616037+00:00
                website: www.example.com
                updated_on: 2018-06-20T23:17:33.616037+00:00
                owner:
                  nickname: example-username
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  links:
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    html:
                      href: https://bitbucket.org/example-username/
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  username: example-username
                  type: user
                  display_name: Example Username
                language: python
                mainbranch:
                  type: branch
                  name: master
                type: repository
              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: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
    put:
      description: |-
        Since this endpoint can be used to both update and to create a
        repository, the request body depends on the intent.

        ### Creation

        See the POST documentation for the repository endpoint for an example
        of the request body.

        ### Update

        Note: Changing the `name` of the repository will cause the location to
        be changed. This is because the URL of the repo is derived from the
        name (a process called slugification). In such a scenario, it is
        possible for the request to fail if the newly created slug conflicts
        with an existing repository's slug. But if there is no conflict,
        the new location will be returned in the `Location` header of the
        response.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/repository'
        description: |
          The repository that is to be updated.

          Note that the elements "owner" and "full_name" are ignored since the
          URL implies them.
        required: false
      responses:
        200:
          content:
            application/json:
              example:
                has_issues: false
                scm: git
                fork_policy: allow_forks
                name: bits_and_bobs
                description: A repository for my bits and bobs
                is_private: true
                has_wiki: false
                links:
                  clone:
                  - href: https://bitbucket.org/example-username/bits_and_bobs.git
                    name: https
                  - name: ssh
                    href: git@bitbucket.org:example-username/bits_and_bobs.git
                  watchers:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/watchers
                  downloads:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/downloads
                  branches:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits
                  source:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/src
                  avatar:
                    href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                  pullrequests:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs
                  forks:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/forks
                  tags:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/tags
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                slug: bits_and_bobs
                website: www.example.com
                updated_on: 2018-06-20T23:17:33.616037+00:00
                created_on: 2018-06-20T23:17:33.616037+00:00
                size: 33348
                full_name: example-username/bits_and_bobs
                mainbranch:
                  type: branch
                  name: master
                language: python
                type: repository
                owner:
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  nickname: example-username
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  links:
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    html:
                      href: https://bitbucket.org/example-username/
                  type: user
                  username: example-username
                  display_name: Example Username
              schema:
                $ref: '#/components/schemas/repository'
          description: The existing repository has been updated
          headers:
            Location:
              description: |-
                The location of the repository. This header is only
                provided when the repository's name is changed.
              schema:
                type: string
        201:
          content:
            application/json:
              example:
                is_private: true
                has_wiki: false
                links:
                  downloads:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/downloads
                  branches:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits
                  clone:
                  - name: https
                    href: https://bitbucket.org/example-username/bits_and_bobs.git
                  - href: git@bitbucket.org:example-username/bits_and_bobs.git
                    name: ssh
                  watchers:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/watchers
                  avatar:
                    href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                  source:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/src
                  pullrequests:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests
                  tags:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/tags
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs
                  forks:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/forks
                slug: bits_and_bobs
                uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                website: www.example.com
                updated_on: 2018-06-20T23:17:33.616037+00:00
                created_on: 2018-06-20T23:17:33.616037+00:00
                size: 33348
                full_name: example-username/bits_and_bobs
                language: python
                mainbranch:
                  name: master
                  type: branch
                type: repository
                owner:
                  links:
                    html:
                      href: https://bitbucket.org/example-username/
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  nickname: example-username
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  display_name: Example Username
                  type: user
                  username: example-username
                has_issues: false
                scm: git
                fork_policy: allow_forks
                name: bits_and_bobs
                description: A repository for my bits and bobs
              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: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
  /addon/linkers/{linker_key}/values:
    delete:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
    get:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
    post:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
    put:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
  /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: 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 pipeline.
        in: path
        name: pipeline_uuid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/pullrequests:
    get:
      description: |-
        Returns all pull requests on the specified repository.

        By default only open pull requests are returned. This can be controlled
        using the `state` query parameter. To retrieve pull requests that are
        in one of multiple states, repeat the `state` parameter for each
        individual state.

        This endpoint also supports filtering and sorting of the results. See
        [filtering and sorting](../../../../meta/filtering) for more details.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: Only return pull requests that are in this state. This parameter
          can be repeated.
        in: query
        name: state
        schema:
          enum:
          - MERGED
          - SUPERSEDED
          - OPEN
          - DECLINED
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_pullrequests'
          description: All pull requests on the specified repository.
        401:
          content: {}
          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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    post:
      description: |-
        Creates a new pull request where the destination repository is
        this repository and the author is the authenticated user.

        The minimum required fields to create a pull request are `title` and
        `source`, specified by a branch name.

        ```
        curl https://api.bitbucket.org/2.0/repositories/my-username/my-repository/pullrequests \
            -u my-username:my-password \
            --request POST \
            --header 'Content-Type: application/json' \
            --data '{
                "title": "My Title",
                "source": {
                    "branch": {
                        "name": "staging"
                    }
                }
            }'
        ```

        If the pull request's `destination` is not specified, it will default
        to the `repository.mainbranch`. To open a pull request to a
        different branch, say from a feature branch to a staging branch,
        specify a `destination` (same format as the `source`):

        ```
        {
            "title": "My Title",
            "source": {
                "branch": {
                    "name": "my-feature-branch"
                }
            },
            "destination": {
                "branch": {
                    "name": "staging"
                }
            }
        }
        ```

        Reviewers can be specified by adding an array of user objects as the
        `reviewers` property.

        ```
        {
            "title": "My Title",
            "source": {
                "branch": {
                    "name": "my-feature-branch"
                }
            },
            "reviewers": [
                {
                    "uuid": "{504c3b62-8120-4f0c-a7bc-87800b9d6f70}"
                }
            ]
        }
        ```

        Other fields:

        * `description` - a string
        * `close_source_branch` - boolean that specifies if the source branch should be closed upon merging
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullrequest'
        description: |-
          The new pull request.

          The 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).

          Since 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.
        required: false
      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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /addon:
    delete:
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
    put:
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
  /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair:
    delete:
      description: Delete the repository SSH key pair.
      operationId: deleteRepositoryPipelineKeyPair
      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:
        204:
          content: {}
          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.
      tags:
      - pipelines
      x-tags:
      - tag: 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: 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/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.
      tags:
      - pipelines
      x-tags:
      - tag: 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: The account.
        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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/pipelines_config/variables/:
    get:
      description: Find repository level variables.
      operationId: getRepositoryPipelineVariables
      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_variables'
          description: The retrieved variables.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    post:
      description: Create a repository level variable.
      operationId: createRepositoryPipelineVariable
      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
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /teams/{username}/permissions/repositories/{repo_slug}:
    get:
      description: "Returns an object for each repository permission of a given repository.\n\
        \nIf the username URL parameter refers to a user account instead of\na team\
        \ account, an object containing the repository permissions\nof the username's\
        \ repository will be returned.\n\nPermissions returned are effective permissions\
        \ â\x80\x94 the highest level of\npermission the user has. This does not include\
        \ public repositories that\nusers are not granted any specific permission\
        \ in, and does not\ndistinguish between direct and indirect privileges.\n\n\
        Only 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/teams/atlassian_tutorial/permissions/repositories/geordi\n\
        \n{\n  \"pagelen\": 10,\n  \"values\": [\n    {\n      \"type\": \"repository_permission\"\
        ,\n      \"user\": {\n        \"type\": \"user\",\n        \"username\": \"\
        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      \"type\"\
        : \"repository_permission\",\n      \"user\": {\n        \"type\": \"user\"\
        ,\n        \"username\": \"seanaty\",\n        \"display_name\": \"Sean Conaty\"\
        ,\n        \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n      },\n\
        \      \"repository\": {\n        \"type\": \"repository\",\n        \"name\"\
        : \"geordi\",\n        \"full_name\": \"bitbucket/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](../../../../meta/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: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property sort the result by as per
          [filtering and sorting](../../../../meta/filtering#query-sort).
        in: query
        name: sort
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_repository_permissions'
          description: List of repository's repository permissions.
        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: []
      tags: []
      x-tags: []
  /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}:
    delete:
      description: Deletes an existing branch restriction rule.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The restriction rule's id
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - branchrestrictions
      x-tags:
      - tag: branchrestrictions
    get:
      description: Returns a specific branch restriction rule.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The restriction rule's id
        in: path
        name: id
        required: true
        schema:
          type: string
      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: []
      tags:
      - branchrestrictions
      x-tags:
      - tag: branchrestrictions
    put:
      description: |-
        Updates an existing branch restriction rule.

        Fields not present in the request body are ignored.

        See [`POST`](../branch-restrictions#post) for details.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The restriction rule's id
        in: path
        name: id
        required: true
        schema:
          type: string
      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: []
      tags:
      - branchrestrictions
      x-tags:
      - tag: branchrestrictions
  /teams/{username}/pipelines_config/variables/:
    get:
      description: Find account level variables.
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    post:
      description: Create an account level variable.
      operationId: createPipelineVariableForTeam
      parameters:
      - description: The account.
        in: path
        name: username
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipeline_variable'
        description: The variable to create.
        required: false
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /users/{username}/ssh-keys/:
    delete:
      description: |-
        Deletes a specific SSH public key from a user's account

        Example:
        ```
        $ curl -X DELETE https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}
        ```
      parameters:
      - description: The account's username or UUID.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: The SSH key's UUID value.
        in: path
        name: key_id
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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:
          content: {}
          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: []
      tags:
      - ssh
      x-tags:
      - tag: ssh
    get:
      description: |-
        Returns a specific SSH public key belonging to a user.

        Example:
        ```
        $ curl https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/{fbe4bbab-f6f7-4dde-956b-5c58323c54b3}

        {
            "comment": "user@myhost",
            "created_on": "2018-03-14T13:17:05.196003+00:00",
            "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY",
            "label": "",
            "last_used": "2018-03-20T13:18:05.196003+00:00",
            "links": {
                "self": {
                    "href": "https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a"
                }
            },
            "owner": {
                "display_name": "Mark Adams",
                "links": {
                    "avatar": {
                        "href": "https://bitbucket.org/account/markadams-atl/avatar/32/"
                    },
                    "html": {
                        "href": "https://bitbucket.org/markadams-atl/"
                    },
                    "self": {
                        "href": "https://api.bitbucket.org/2.0/users/markadams-atl"
                    }
                },
                "type": "user",
                "username": "markadams-atl",
                "nickname": "markadams-atl",
                "uuid": "{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}"
            },
            "type": "ssh_key",
            "uuid": "{b15b6026-9c02-4626-b4ad-b905f99f763a}"
        }
        ```
      parameters:
      - description: The account's username or UUID.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: The SSH key's UUID value.
        in: path
        name: key_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssh_account_key'
          description: The specific SSH key matching the user and UUID
        403:
          content: {}
          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: []
      tags:
      - ssh
      x-tags:
      - tag: ssh
    put:
      description: |-
        Updates a specific SSH public key on a user's account

        Note: 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.

        Example:
        ```
        $ curl -X PUT -H "Content-Type: application/json" -d '{"label": "Work key"}' https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}

        {
            "comment": "",
            "created_on": "2018-03-14T13:17:05.196003+00:00",
            "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY",
            "label": "Work key",
            "last_used": "2018-03-20T13:18:05.196003+00:00",
            "links": {
                "self": {
                    "href": "https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a"
                }
            },
            "owner": {
                "display_name": "Mark Adams",
                "links": {
                    "avatar": {
                        "href": "https://bitbucket.org/account/markadams-atl/avatar/32/"
                    },
                    "html": {
                        "href": "https://bitbucket.org/markadams-atl/"
                    },
                    "self": {
                        "href": "https://api.bitbucket.org/2.0/users/markadams-atl"
                    }
                },
                "type": "user",
                "username": "markadams-atl",
                "nickname": "markadams-atl",
                "uuid": "{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}"
            },
            "type": "ssh_key",
            "uuid": "{b15b6026-9c02-4626-b4ad-b905f99f763a}"
        }
        ```
      parameters:
      - description: The account's username or UUID.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: The SSH key's UUID value.
        in: path
        name: key_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ssh_account_key'
        description: The updated SSH key object
        required: false
      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:
          content: {}
          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: []
      tags:
      - ssh
      x-tags:
      - tag: ssh
  /repositories/{workspace}/{repo_slug}/commit/{node}/comments/{comment_id}:
    get:
      description: Returns the specified commit comment.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: The id of the comment.
        in: path
        name: comment_id
        required: true
        schema:
          type: integer
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commit_comment'
          description: The commit comment.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /repositories/{workspace}/{repo_slug}/forks:
    get:
      description: |-
        Returns a paginated list of all the forks of the specified
        repository.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_repositories'
          description: All forks.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
    post:
      description: |-
        Creates a new fork of the specified repository.

        By default, forks are created under the authenticated user's account
        with the same name and slug of the original repository.

        ```
        $ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/forks

        {
          "scm": "git",
          "full_name": "jdoe/dogslow",
          "parent": {
            "full_name": "evzijst/dogslow",
            ...
          },
          ...
        }
        ```

        If you already have a repo with that name, then a 400 is returned and
        you'll need to specify a custom name for the new fork:

        ```
        $ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/forks \
          -H 'Content-Type: application/json' -d '{
            "name": "dogslow_fork"
        }'
        ```

        When you specify a value for `name`, it will also affect the `slug`.
        The `slug` is reflected in the repository URL of the new fork. It is
        derived from `name` by substituting non-ASCII characters, removes
        whitespace, and changes characters to lower case. For example,
        `My repo` would turn into `my_repo`.

        ## Forking a repository into a team account

        To create a fork into a team account, specify the new owner's account
        explicitly as part of the request body. This prevents forked
        repositories from being owned by the authenticated user submitting the
        request:

        ```
        $ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/atlassian/bbql/forks \
          -H 'Content-Type: application/json' -d '{
            "name": "bbql_fork",
            "owner": {
              "username": "atlassian"
            }
        }'
        ```

        To fork a repository into the same team, also specify a new `name`.

        You need contributor access to create new forks within a team account.


        ## Change the properties of a new fork

        By default the fork inherits most of its properties from the parent.
        However, since the optional POST body document follows the normal
        `repository` JSON schema and you can override the new fork's
        properties.

        Properties that can be overridden include:

        * description
        * fork_policy
        * language
        * mainbranch
        * is_private (note that a private repo's fork_policy might prohibit
          the creation of public forks, in which `is_private=False` would fail)
        * has_issues (to initialize or disable the new repo's issue tracker --
          note that the actual contents of the parent repository's issue
          tracker are not copied during forking)
        * has_wiki (to initialize or disable the new repo's wiki --
          note that the actual contents of the parent repository's wiki are not
          copied during forking)
        * project (only teams have projects and when forking into a private
          project, the fork's `is_private` must be `true`)

        Properties that cannot be modified include:

        * scm
        * parent
        * full_name
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/repository'
        description: A repository object. This can be left blank.
        required: false
      responses:
        201:
          content:
            application/json:
              example:
                owner:
                  nickname: example-username
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  links:
                    html:
                      href: https://bitbucket.org/example-username/
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  display_name: Example Username
                  type: user
                  username: example-username
                type: repository
                language: python
                mainbranch:
                  name: master
                  type: branch
                created_on: 2018-06-20T23:17:33.616037+00:00
                size: 33348
                full_name: example-username/bits_and_bobs
                updated_on: 2018-06-20T23:17:33.616037+00:00
                website: www.example.com
                uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                slug: bits_and_bobs
                links:
                  pullrequests:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs
                  forks:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/forks
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                  tags:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/tags
                  clone:
                  - name: https
                    href: https://bitbucket.org/example-username/bits_and_bobs.git
                  - name: ssh
                    href: git@bitbucket.org:example-username/bits_and_bobs.git
                  watchers:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/watchers
                  downloads:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/downloads
                  branches:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits
                  source:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/src
                  avatar:
                    href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                has_wiki: false
                is_private: true
                description: A repository for my bits and bobs
                name: bits_and_bobs
                has_issues: false
                scm: git
                fork_policy: allow_forks
              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: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
  /snippets/{username}/{encoded_id}:
    delete:
      description: Deletes a snippet and returns an empty response.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet's id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    get:
      description: |-
        Retrieves a single snippet.

        Snippets support multiple content types:

        * application/json
        * multipart/related
        * multipart/form-data


        application/json
        ----------------

        The default content type of the response is `application/json`.
        Since JSON is always `utf-8`, it cannot reliably contain file contents
        for files that are not text. Therefore, JSON snippet documents only
        contain the filename and links to the file contents.

        This means that in order to retrieve all parts of a snippet, N+1
        requests need to be made (where N is the number of files in the
        snippet).


        multipart/related
        -----------------

        To retrieve an entire snippet in a single response, use the
        `Accept: multipart/related` HTTP request header.

            $ curl -H "Accept: multipart/related" https://api.bitbucket.org/2.0/snippets/evzijst/1

        Response:

            HTTP/1.1 200 OK
            Content-Length: 2214
            Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
            MIME-Version: 1.0

            --===============1438169132528273974==
            Content-Type: application/json; charset="utf-8"
            MIME-Version: 1.0
            Content-ID: snippet

            {
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj"
                },
                "html": {
                  "href": "https://bitbucket.org/snippets/evzijst/kypj"
                },
                "comments": {
                  "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments"
                },
                "watchers": {
                  "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers"
                },
                "commits": {
                  "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits"
                }
              },
              "id": kypj,
              "title": "My snippet",
              "created_on": "2014-12-29T22:22:04.790331+00:00",
              "updated_on": "2014-12-29T22:22:04.790331+00:00",
              "is_private": false,
              "files": {
                "foo.txt": {
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt"
                    },
                    "html": {
                      "href": "https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt"
                    }
                  }
                },
                "image.png": {
                  "links": {
                    "self": {
                      "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png"
                    },
                    "html": {
                      "href": "https://bitbucket.org/snippets/evzijst/kypj#file-image.png"
                    }
                  }
                }
              ],
              "owner": {
                "username": "evzijst",
                "nickname": "evzijst",
                "display_name": "Erik van Zijst",
                "uuid": "{d301aafa-d676-4ee0-88be-962be7417567}",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/users/evzijst"
                  },
                  "html": {
                    "href": "https://bitbucket.org/evzijst"
                  },
                  "avatar": {
                    "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png"
                  }
                }
              },
              "creator": {
                "username": "evzijst",
                "nickname": "evzijst",
                "display_name": "Erik van Zijst",
                "uuid": "{d301aafa-d676-4ee0-88be-962be7417567}",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/users/evzijst"
                  },
                  "html": {
                    "href": "https://bitbucket.org/evzijst"
                  },
                  "avatar": {
                    "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png"
                  }
                }
              }
            }

            --===============1438169132528273974==
            Content-Type: text/plain; charset="us-ascii"
            MIME-Version: 1.0
            Content-Transfer-Encoding: 7bit
            Content-ID: "foo.txt"
            Content-Disposition: attachment; filename="foo.txt"

            foo

            --===============1438169132528273974==
            Content-Type: image/png
            MIME-Version: 1.0
            Content-Transfer-Encoding: base64
            Content-ID: "image.png"
            Content-Disposition: attachment; filename="image.png"

            iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
            TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
            cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
            EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
            73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
            AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
            --===============1438169132528273974==--

        multipart/form-data
        -------------------

        As with creating new snippets, `multipart/form-data` can be used as an
        alternative to `multipart/related`. However, the inherently flat
        structure of form-data means that only basic, root-level properties
        can be returned, while nested elements like `links` are omitted:

            $ curl -H "Accept: multipart/form-data" https://api.bitbucket.org/2.0/snippets/evzijst/kypj

        Response:

            HTTP/1.1 200 OK
            Content-Length: 951
            Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f

            ------------------------------63a4b224c59f
            Content-Disposition: form-data; name="title"
            Content-Type: text/plain; charset="utf-8"

            My snippet
            ------------------------------63a4b224c59f--
            Content-Disposition: attachment; name="file"; filename="foo.txt"
            Content-Type: text/plain

            foo

            ------------------------------63a4b224c59f
            Content-Disposition: attachment; name="file"; filename="image.png"
            Content-Transfer-Encoding: base64
            Content-Type: application/octet-stream

            iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
            TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
            cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
            EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
            73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
            AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
            ------------------------------5957323a6b76--
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet's id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/related:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/snippet'
          description: The snippet object.
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
            multipart/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/error'
          description: If the snippet does not exist.
      security:
      - oauth2:
        - snippet
      - basic: []
      - api_key: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    put:
      description: |-
        Used to update a snippet. Use this to add and delete files and to
        change a snippet's title.

        To update a snippet, one can either PUT a full snapshot, or only the
        parts that need to be changed.

        The contract for PUT on this API is that properties missing from the
        request remain untouched so that snippets can be efficiently
        manipulated with differential payloads.

        To delete a property (e.g. the title, or a file), include its name in
        the request, but omit its value (use `null`).

        As in Git, explicit renaming of files is not supported. Instead, to
        rename a file, delete it and add it again under another name. This can
        be done atomically in a single request. Rename detection is left to
        the SCM.

        PUT supports three different content types for both request and
        response bodies:

        * `application/json`
        * `multipart/related`
        * `multipart/form-data`

        The content type used for the request body can be different than that
        used for the response. Content types are specified using standard HTTP
        headers.

        Use the `Content-Type` and `Accept` headers to select the desired
        request and response format.


        application/json
        ----------------

        As with creation and retrieval, the content type determines what
        properties can be manipulated. `application/json` does not support
        file contents and is therefore limited to a snippet's meta data.

        To update the title, without changing any of its files:

            $ curl -X POST -H "Content-Type: application/json" https://api.bitbucket.org/2.0/snippets/evzijst/kypj             -d '{"title": "Updated title"}'


        To delete the title:

            $ curl -X POST -H "Content-Type: application/json" https://api.bitbucket.org/2.0/snippets/evzijst/kypj             -d '{"title": null}'

        Not all parts of a snippet can be manipulated. The owner and creator
        for instance are immutable.


        multipart/related
        -----------------

        `multipart/related` can be used to manipulate all of a snippet's
        properties. The body is identical to a POST. properties omitted from
        the request are left unchanged. Since the `start` part contains JSON,
        the mechanism for manipulating the snippet's meta data is identical
        to `application/json` requests.

        To update one of a snippet's file contents, while also changing its
        title:

            PUT /2.0/snippets/evzijst/kypj HTTP/1.1
            Content-Length: 288
            Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
            MIME-Version: 1.0

            --===============1438169132528273974==
            Content-Type: application/json; charset="utf-8"
            MIME-Version: 1.0
            Content-ID: snippet

            {
              "title": "My updated snippet",
              "files": {
                  "foo.txt": {}
                }
            }

            --===============1438169132528273974==
            Content-Type: text/plain; charset="us-ascii"
            MIME-Version: 1.0
            Content-Transfer-Encoding: 7bit
            Content-ID: "foo.txt"
            Content-Disposition: attachment; filename="foo.txt"

            Updated file contents.

            --===============1438169132528273974==--

        Here only the parts that are changed are included in the body. The
        other files remain untouched.

        Note the use of the `files` list in the JSON part. This list contains
        the files that are being manipulated. This list should have
        corresponding multiparts in the request that contain the new contents
        of these files.

        If a filename in the `files` list does not have a corresponding part,
        it will be deleted from the snippet, as shown below:

            PUT /2.0/snippets/evzijst/kypj HTTP/1.1
            Content-Length: 188
            Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
            MIME-Version: 1.0

            --===============1438169132528273974==
            Content-Type: application/json; charset="utf-8"
            MIME-Version: 1.0
            Content-ID: snippet

            {
              "files": {
                "image.png": {}
              }
            }

            --===============1438169132528273974==--

        To simulate a rename, delete a file and add the same file under
        another name:

            PUT /2.0/snippets/evzijst/kypj HTTP/1.1
            Content-Length: 212
            Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
            MIME-Version: 1.0

            --===============1438169132528273974==
            Content-Type: application/json; charset="utf-8"
            MIME-Version: 1.0
            Content-ID: snippet

            {
                "files": {
                  "foo.txt": {},
                  "bar.txt": {}
                }
            }

            --===============1438169132528273974==
            Content-Type: text/plain; charset="us-ascii"
            MIME-Version: 1.0
            Content-Transfer-Encoding: 7bit
            Content-ID: "bar.txt"
            Content-Disposition: attachment; filename="bar.txt"

            foo

            --===============1438169132528273974==--


        multipart/form-data
        -----------------

        Again, one can also use `multipart/form-data` to manipulate file
        contents and meta data atomically.

            $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj             -F title="My updated snippet" -F file=@foo.txt

            PUT /2.0/snippets/evzijst/kypj HTTP/1.1
            Content-Length: 351
            Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f

            ------------------------------63a4b224c59f
            Content-Disposition: form-data; name="file"; filename="foo.txt"
            Content-Type: text/plain

            foo

            ------------------------------63a4b224c59f
            Content-Disposition: form-data; name="title"

            My updated snippet
            ------------------------------63a4b224c59f

        To delete a file, omit its contents while including its name in the
        `files` field:

            $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png

            PUT /2.0/snippets/evzijst/kypj HTTP/1.1
            Content-Length: 149
            Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86

            ------------------------------ef8871065a86
            Content-Disposition: form-data; name="files"

            image.png
            ------------------------------ef8871065a86--

        The explicit use of the `files` element in `multipart/related` and
        `multipart/form-data` is only required when deleting files.
        The default mode of operation is for file parts to be processed,
        regardless of whether or not they are listed in `files`, as a
        convenience to the client.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet's id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/related:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/snippet'
          description: The updated snippet object.
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
            multipart/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/error'
          description: If the snippet does not exist.
      security:
      - oauth2:
        - snippet:write
      - basic: []
      - api_key: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/diff/{spec}:
    get:
      description: |-
        Produces a raw, git-style diff for either a single commit (diffed
        against its first parent), or a revspec of 2 commits (e.g.
        `3a8b42..9ff173` where the first commit represents the source and the
        second commit the destination).

        In case of the latter (diffing a revspec), a 3-way diff, or merge diff,
        is computed. This shows the changes introduced by the left branch
        (`3a8b42` in our example) as compared againt the right branch
        (`9ff173`).

        This is equivalent to merging the left branch into the right branch and
        then computing the diff of the merge commit against its first parent
        (the right branch). This follows the same behavior as pull requests
        that also show this style of 3-way, or merge diff.

        While similar to patches, diffs:

        * Don't have a commit header (username, commit message, etc)
        * Support the optional `path=foo/bar.py` query param to filter
          the diff to just that one file diff

        The raw diff is returned as-is, in whatever encoding the files in the
        repository use. It is not decoded into unicode. As such, the
        content-type is `text/plain`.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: spec
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: Generate diffs with <n> lines of context instead of the usual
          three
        in: query
        name: context
        schema:
          type: integer
      - description: |-
          Limit the diff to a particular file (this parameter
          can be repeated for multiple paths)
        in: query
        name: path
        schema:
          type: string
      - description: Generate diffs that ignore whitespace
        in: query
        name: ignore_whitespace
        schema:
          type: boolean
      - description: Generate diffs that include binary files,true if omitted.
        in: query
        name: binary
        schema:
          type: boolean
      responses:
        200:
          content:
            text/plain:
              schema:
                type: string
          description: The raw diff
        555:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: |-
            If the diff was too large and timed out.

            Since this endpoint does not employ any form of pagination, but
            instead returns the diff as a single document, it can run into
            trouble on very large diffs. If Bitbucket times out in cases
            like these, a 555 status code is returned.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /repositories/{workspace}/{repo_slug}/deployments/:
    get:
      description: Find deployments
      operationId: getDeploymentsForRepository
      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_deployments'
          description: The matching deployments.
      tags:
      - deployments
      x-tags:
      - tag: deployments
  /repositories/{workspace}/{repo_slug}/commit/{node}/statuses/build:
    post:
      description: |-
        Creates a new build status against the specified commit.

        If the specified key already exists, the existing status object will
        be overwritten.

        When creating a new commit status, you can use a URI template for the URL.
        Templates are URLs that contain variable names that Bitbucket will
        evaluate at runtime whenever the URL is displayed anywhere similar to
        parameter substitution in
        [Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).
        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.
        The context variables available are `repository` and `commit`.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commitstatus'
        description: The new commit status object.
        required: false
      responses:
        201:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commitstatus'
          description: The newly created build status object.
        401:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: commitstatuses
  /users/{username}/hooks:
    get:
      description: |-
        Returns a paginated list of webhooks installed on this user account.

        Note that the username path parameter has been deprecated due to
        [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        Use the account's UUID or account_id instead.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      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 accessing an account other than
            their own.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If the specified account does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: webhooks
    post:
      description: |-
        Creates a new webhook on the specified user account.

        Account-level webhooks are fired for events from all repositories
        belonging to that account.

        Note that one can only register webhooks on one's own account, not that
        of others.

        Also, note that the username path parameter has been deprecated due to
        [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        Use the account's UUID or account_id instead.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        201:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_subscription'
          description: The newly installed webhook.
          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 is accessing an account other than
            their own.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If the specified account does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: webhooks
  /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}:
    delete:
      description: Delete an application property value stored against a repository.
      operationId: deleteRepositoryHostedPropertyValue
      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 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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
    get:
      description: Retrieve an application property value stored against a repository.
      operationId: getRepositoryHostedPropertyValue
      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 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: {}
          description: The value of the property.
      tags:
      - properties
      x-tags:
      - tag: properties
    put:
      description: Update an application property value stored against a repository.
      operationId: updateRepositoryHostedPropertyValue
      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 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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
  /users/{username}/ssh-keys:
    get:
      description: |-
        Returns a paginated list of the user's SSH public keys.

        Example:

        ```
        $ curl https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys
        {
            "page": 1,
            "pagelen": 10,
            "size": 1,
            "values": [
                {
                    "comment": "user@myhost",
                    "created_on": "2018-03-14T13:17:05.196003+00:00",
                    "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY",
                    "label": "",
                    "last_used": "2018-03-20T13:18:05.196003+00:00",
                    "links": {
                        "self": {
                            "href": "https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a"
                        }
                    },
                    "owner": {
                        "display_name": "Mark Adams",
                        "links": {
                            "avatar": {
                                "href": "https://bitbucket.org/account/markadams-atl/avatar/32/"
                            },
                            "html": {
                                "href": "https://bitbucket.org/markadams-atl/"
                            },
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/users/markadams-atl"
                            }
                        },
                        "type": "user",
                        "username": "markadams-atl",
                        "nickname": "markadams-atl",
                        "uuid": "{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}"
                    },
                    "type": "ssh_key",
                    "uuid": "{b15b6026-9c02-4626-b4ad-b905f99f763a}"
                }
            ]
        }
        ```
      parameters:
      - description: The account's UUID, account_id, or username. Note that username
          has been deprecated due to [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        in: path
        name: username
        required: true
        schema:
          type: string
      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:
          content: {}
          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: []
      tags:
      - ssh
      x-tags:
      - tag: ssh
    post:
      description: |-
        Adds a new SSH public key to the specified user account and returns the resulting key.

        Example:
        ```
        $ curl -X POST -H "Content-Type: application/json" -d '{"key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY user@myhost"}' https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys

        {
            "comment": "user@myhost",
            "created_on": "2018-03-14T13:17:05.196003+00:00",
            "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY",
            "label": "",
            "last_used": "2018-03-20T13:18:05.196003+00:00",
            "links": {
                "self": {
                    "href": "https://api.bitbucket.org/2.0/users/markadams-atl/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a"
                }
            },
            "owner": {
                "display_name": "Mark Adams",
                "links": {
                    "avatar": {
                        "href": "https://bitbucket.org/account/markadams-atl/avatar/32/"
                    },
                    "html": {
                        "href": "https://bitbucket.org/markadams-atl/"
                    },
                    "self": {
                        "href": "https://api.bitbucket.org/2.0/users/markadams-atl"
                    }
                },
                "type": "user",
                "username": "markadams-atl",
                "nickname": "markadams-atl",
                "uuid": "{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}"
            },
            "type": "ssh_key",
            "uuid": "{b15b6026-9c02-4626-b4ad-b905f99f763a}"
        }
        ```
      parameters:
      - description: The account's UUID, account_id, or username. Note that username
          has been deprecated due to [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        in: path
        name: username
        required: true
        schema:
          type: string
      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).
        required: false
      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:
          content: {}
          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: []
      tags:
      - ssh
      x-tags:
      - tag: ssh
  /snippets/{username}/{encoded_id}/{node_id}:
    delete:
      description: |-
        Deletes the snippet.

        Note that this only works for versioned URLs that point to the latest
        commit of the snippet. Pointing to an older commit results in a 405
        status code.

        To delete a snippet, regardless of whether or not concurrent changes
        are being made to it, use `DELETE /snippets/{encoded_id}` instead.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: node_id
        required: true
        schema:
          type: string
      - description: The snippet's id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    get:
      description: |-
        Identical to `GET /snippets/encoded_id`, except that this endpoint
        can be used to retrieve the contents of the snippet as it was at an
        older revision, while `/snippets/encoded_id` always returns the
        snippet's current revision.

        Note that only the snippet's file contents are versioned, not its
        meta data properties like the title.

        Other than that, the two endpoints are identical in behavior.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet's 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
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/related:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/snippet'
          description: The snippet object.
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
            multipart/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/error'
          description: If the snippet, or the revision does not exist.
      security:
      - oauth2:
        - snippet
      - basic: []
      - api_key: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    put:
      description: |-
        Identical to `UPDATE /snippets/encoded_id`, except that this endpoint
        takes an explicit commit revision. Only the snippet's "HEAD"/"tip"
        (most recent) version can be updated and requests on all other,
        older revisions fail by returning a 405 status.

        Usage of this endpoint over the unrestricted `/snippets/encoded_id`
        could be desired if the caller wants to be sure no concurrent
        modifications have taken place between the moment of the UPDATE
        request and the original GET.

        This can be considered a so-called "Compare And Swap", or CAS
        operation.

        Other than that, the two endpoints are identical in behavior.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet's 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
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/related:
              schema:
                $ref: '#/components/schemas/snippet'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/snippet'
          description: The updated snippet object.
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
            multipart/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              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/related:
              schema:
                $ref: '#/components/schemas/error'
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/error'
          description: If `{node_id}` is not the latest revision.
      security:
      - oauth2:
        - snippet:write
      - basic: []
      - api_key: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat:
    get:
      description: |-
        Redirects to the [repository diffstat](../../diffstat/%7Bspec%7D)
        with the revspec that corresponds to the pull request.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        302:
          content: {}
          description: |
            Redirects to the [repository diffstat](../../diffstat/%7Bspec%7D) with
            the revspec that corresponds to pull request.
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}:
    delete:
      description: Deletes an attachment.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      - in: path
        name: issue_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          description: Indicates that the deletion was successful
        401:
          content: {}
          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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    get:
      description: |-
        Returns the contents of the specified file attachment.

        Note that this endpoint does not return a JSON response, but instead
        returns a redirect pointing to the actual file that in turn will return
        the raw contents.

        The redirect URL contains a one-time token that has a limited lifetime.
        As a result, the link should not be persisted, stored, or shared.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      - in: path
        name: issue_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        302:
          content: {}
          description: A redirect to the file's contents
          headers:
            Location:
              schema:
                type: string
        401:
          content: {}
          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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /users/{username}/pipelines_config/variables/:
    get:
      description: Find user level variables.
      operationId: getPipelineVariablesForUser
      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 user level variables.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    post:
      description: Create a user level variable.
      operationId: createPipelineVariableForUser
      parameters:
      - description: The account.
        in: path
        name: username
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipeline_variable'
        description: The variable to create.
        required: false
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments:
    get:
      description: |-
        Returns a paginated list of the pull request's comments.

        This includes both global, inline comments and replies.

        The default sorting is oldest to newest and can be overridden with
        the `sort` query parameter.

        This endpoint also supports filtering and sorting of the results. See
        [filtering and sorting](../../../../../../meta/filtering) for more
        details.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      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 reverse 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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    post:
      description: |-
        Creates a new pull request comment.

        Returns the newly created pull request comment.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/comment'
        description: The comment object.
        required: true
      responses:
        201:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /snippets/{username}/{encoded_id}/commits:
    get:
      description: Returns the changes (commits) made on this snippet.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}:
    get:
      description: Retrieve an environment
      operationId: getEnvironmentForRepository
      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 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.
      tags:
      - deployments
      x-tags:
      - tag: deployments
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses:
    get:
      description: |-
        Returns all statuses (e.g. build results) for the given pull
        request.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        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:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - hasMore: "true"
        tag: pullrequests
      - tag: commitstatuses
  /repositories/{workspace}/{repo_slug}/refs:
    get:
      description: |-
        Returns the branches and tags in the repository.

        By default, results will be in the order the underlying source control system returns them and identical to
        the ordering one sees when running "$ git show-ref". Note that this follows simple
        lexical ordering of the ref names.

        This can be undesirable as it does apply any natural sorting semantics, meaning for instance that refs are
        sorted ["branch1", "branch10", "branch2", "v10", "v11", "v9"] instead of ["branch1", "branch2",
        "branch10", "v9", "v10", "v11"].

        Sorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,
        Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.
      parameters:
      - description: |2

          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |2

          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2-

          Field by which the results should be sorted as per
          [filtering and sorting](../../../../../../meta/filtering). The `name`
          field is handled specially for refs in that, if specified as the sort field, it
          uses a natural sort order instead of the default lexicographical sort order. For example,
          it 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
            access to it.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The specified repository does not exist.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - refs
      x-tags:
      - tag: refs
  /users/{username}:
    get:
      description: |-
        Gets the public information associated with a user account.

        If the user's profile is private, `location`, `website` and
        `created_on` elements are omitted.

        Note that the user object returned by this operation is changing significantly, due to privacy changes.
        See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-bitbucket-user-objects) for details.
      parameters:
      - description: The account's UUID, account_id, or username. Note that username
          has been deprecated due to [privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                display_name: Example Username
                uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                links:
                  avatar:
                    href: https://bitbucket.org/account/example-username/avatar/
                  self:
                    href: https://api.bitbucket.org/2.0/users/example-username
                  html:
                    href: https://bitbucket.org/example-username/
                type: user
                username: example-username
                account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
              schema:
                $ref: '#/components/schemas/user'
          description: The user object
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If no user exists for the specified name or UUID, or if the
            specified account is a team account, not a personal account.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - tag: users
  /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}:
    get:
      description: Retrieve a specified pipeline
      operationId: getPipelineForRepository
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /teams/{username}/hooks/{uid}:
    delete:
      description: |-
        Deletes the specified webhook subscription from the given team
        account.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The installed webhook's id
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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 team does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - hasMore: "true"
        tag: teams
      - tag: webhooks
    get:
      description: |-
        Returns the webhook with the specified id installed on the given
        team account.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The installed webhook's id.
        in: path
        name: uid
        required: true
        schema:
          type: string
      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 team does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - hasMore: "true"
        tag: teams
      - tag: webhooks
    put:
      description: |-
        Updates the specified webhook subscription.

        The following properties can be mutated:

        * `description`
        * `url`
        * `active`
        * `events`
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The installed webhook's id
        in: path
        name: uid
        required: true
        schema:
          type: string
      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 team does not exist.
      security:
      - oauth2:
        - webhook
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - hasMore: "true"
        tag: teams
      - tag: webhooks
  /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}:
    delete:
      description: Delete a repository level variable.
      operationId: deleteRepositoryPipelineVariable
      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 variable to delete.
        in: path
        name: variable_uuid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    get:
      description: Retrieve a repository level variable.
      operationId: getRepositoryPipelineVariable
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    put:
      description: Update a repository level variable.
      operationId: updateRepositoryPipelineVariable
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/watchers:
    get:
      description: |-
        Returns a paginated list of all the watchers on the specified
        repository.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content: {}
          description: A paginated list of all the watchers on the specified repository.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
  /repositories/{workspace}/{repo_slug}/diffstat/{spec}:
    get:
      description: |-
        Returns the diff stat for the specified commit.

        Diff stat responses contain a record for every path modified by the
        commit and lists the number of lines added and removed for each file.


        Example:
        ```
        curl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diffstat/d222fa2..e174964
        {
            "pagelen": 500,
            "values": [
                {
                    "type": "diffstat",
                    "status": "modified",
                    "lines_removed": 1,
                    "lines_added": 2,
                    "old": {
                        "path": "setup.py",
                        "type": "commit_file",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/e1749643d655d7c7014001a6c0f58abaf42ad850/setup.py"
                            }
                        }
                    },
                    "new": {
                        "path": "setup.py",
                        "type": "commit_file",
                        "links": {
                            "self": {
                                "href": "https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/d222fa235229c55dad20b190b0b571adf737d5a6/setup.py"
                            }
                        }
                    }
                }
            ],
            "page": 1,
            "size": 1
        }
        ```
      parameters:
      - description: Generate diffs that ignore whitespace
        in: query
        name: ignore_whitespace
        schema:
          type: boolean
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          A commit SHA (e.g. `3a8b42`) or a commit range using double dot
          notation (e.g. `3a8b42..9ff173`).
        in: path
        name: spec
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_diffstats'
          description: The diff stats
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /snippets/{username}/{encoded_id}/{revision}/diff:
    get:
      description: |-
        Returns the diff of the specified commit against its first parent.

        Note that this resource is different in functionality from the `patch`
        resource.

        The differences between a diff and a patch are:

        * patches have a commit header with the username, message, etc
        * diffs support the optional `path=foo/bar.py` query param to filter the
          diff to just that one file diff (not supported for patches)
        * for a merge, the diff will show the diff between the merge commit and
          its first parent (identical to how PRs work), while patch returns a
          response containing separate patches for each commit on the second
          parent's ancestry, up to the oldest common ancestor (identical to
          its reachability).

        Note that the character encoding of the contents of the diff is
        unspecified as Git and Mercurial do not track this, making it hard for
        Bitbucket to reliably determine this.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: When used, only one the diff of the specified file will be returned.
        in: query
        name: path
        schema:
          type: string
      - 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
      responses:
        200:
          content: {}
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/commit/{node}/comments:
    get:
      description: |-
        Returns the commit's comments.

        This includes both global and inline comments.

        The default sorting is oldest to newest and can be overridden with
        the `sort` query parameter.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        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: []
      tags:
      - commits
      x-tags:
      - tag: commits
    post:
      description: |-
        Creates new comment on the specified commit.

        To post a reply to an existing comment, include the `parent.id` field:

        ```
        $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/db9ba1e031d07a02603eae0e559a7adc010257fc/comments/ \
          -X POST -u evzijst \
          -H 'Content-Type: application/json' \
          -d '{"content": {"raw": "One more thing!"},
               "parent": {"id": 5728901}}'
        ```
      parameters:
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commit_comment'
        description: The specified comment.
        required: true
      responses:
        201:
          content: {}
          description: The newly created comment.
          headers:
            Location:
              description: The location of the newly created comment.
              schema:
                type: string
        400:
          content: {}
          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:
          content: {}
          description: If a parent ID was passed in that cannot be found
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /users/{username}/properties/{app_key}/{property_name}:
    delete:
      description: Delete an application property value stored against a user.
      operationId: deleteUserHostedPropertyValue
      parameters:
      - description: The user.
        in: path
        name: username
        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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
    get:
      description: Retrieve an application property value stored against a user.
      operationId: retrieveUserHostedPropertyValue
      parameters:
      - description: The user.
        in: path
        name: username
        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: {}
          description: The value of the property.
      tags:
      - properties
      x-tags:
      - tag: properties
    put:
      description: Update an application property value stored against a user.
      operationId: updateUserHostedPropertyValue
      parameters:
      - description: The user.
        in: path
        name: username
        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:
          content: {}
          description: An empty response.
      tags:
      - properties
      x-tags:
      - tag: properties
  /addon/linkers:
    get:
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
  /repositories/{workspace}:
    get:
      description: |-
        Returns a paginated list of all repositories owned by the specified
        account or UUID.

        The result can be narrowed down based on the authenticated user's role.

        E.g. with `?role=contributor`, only those repositories that the
        authenticated user has write access to are returned (this includes any
        repo the user is an admin on, as that implies write access).

        This endpoint also supports filtering and sorting of the results. See
        [filtering and sorting](../../meta/filtering) for more details.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |2

          Filters the result based on the authenticated user's role on each repository.

          * **member**: returns repositories to which the user has explicit read access
          * **contributor**: returns repositories to which the user has explicit write access
          * **admin**: returns repositories to which the user has explicit administrator access
          * **owner**: returns all repositories owned by the current user
        in: query
        name: role
        schema:
          enum:
          - admin
          - contributor
          - member
          - owner
          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.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff:
    get:
      description: |-
        Redirects to the [repository diff](../../diff/%7Bspec%7D)
        with the revspec that corresponds to the pull request.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        302:
          content: {}
          description: |
            Redirects to the [repository diff](../../diff/%7Bspec%7D) with the
            revspec that corresponds to the pull request.
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/components:
    get:
      description: |-
        Returns the components that have been defined in the issue tracker.

        This resource is only available on repositories that have the issue
        tracker enabled.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /snippets:
    get:
      description: |-
        Returns all snippets. Like pull requests, repositories and teams, the
        full set of snippets is defined by what the current user has access to.

        This includes all snippets owned by the current user, but also all snippets
        owned by any of the teams the user is a member of, or snippets by other
        users that the current user is either watching or has collaborated on (for
        instance by commenting on it).

        To limit the set of returned snippets, apply the
        `?role=[owner|contributor|member]` query parameter where the roles are
        defined as follows:

        * `owner`: all snippets owned by the current user
        * `contributor`: all snippets owned by, or watched by the current user
        * `member`: owned by the user, their teams, or watched by the current user

        When no role is specified, all public snippets are returned, as well as all
        privately owned snippets watched or commented on.

        The returned response is a normal paginated JSON list. This endpoint
        only supports `application/json` responses and no
        `multipart/form-data` or `multipart/related`. As a result, it is not
        possible 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
        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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    post:
      description: |-
        Creates a new snippet under the authenticated user's account.

        Snippets can contain multiple files. Both text and binary files are
        supported.

        The simplest way to create a new snippet from a local file:

            $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets               -F file=@image.png

        Creating snippets through curl has a few limitations and so let's look
        at a more complicated scenario.

        Snippets are created with a multipart POST. Both `multipart/form-data`
        and `multipart/related` are supported. Both allow the creation of
        snippets with both meta data (title, etc), as well as multiple text
        and binary files.

        The main difference is that `multipart/related` can use rich encoding
        for the meta data (currently JSON).


        multipart/related (RFC-2387)
        ----------------------------

        This is the most advanced and efficient way to create a paste.

            POST /2.0/snippets/evzijst HTTP/1.1
            Content-Length: 1188
            Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974=="
            MIME-Version: 1.0

            --===============1438169132528273974==
            Content-Type: application/json; charset="utf-8"
            MIME-Version: 1.0
            Content-ID: snippet

            {
              "title": "My snippet",
              "is_private": true,
              "scm": "hg",
              "files": {
                  "foo.txt": {},
                  "image.png": {}
                }
            }

            --===============1438169132528273974==
            Content-Type: text/plain; charset="us-ascii"
            MIME-Version: 1.0
            Content-Transfer-Encoding: 7bit
            Content-ID: "foo.txt"
            Content-Disposition: attachment; filename="foo.txt"

            foo

            --===============1438169132528273974==
            Content-Type: image/png
            MIME-Version: 1.0
            Content-Transfer-Encoding: base64
            Content-ID: "image.png"
            Content-Disposition: attachment; filename="image.png"

            iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m
            TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB
            cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5
            EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ
            73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN
            AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==
            --===============1438169132528273974==--

        The request contains multiple parts and is structured as follows.

        The first part is the JSON document that describes the snippet's
        properties or meta data. It either has to be the first part, or the
        request's `Content-Type` header must contain the `start` parameter to
        point to it.

        The remaining parts are the files of which there can be zero or more.
        Each file part should contain the `Content-ID` MIME header through
        which the JSON meta data's `files` element addresses it. The value
        should be the name of the file.

        `Content-Disposition` is an optional MIME header. The header's
        optional `filename` parameter can be used to specify the file name
        that Bitbucket should use when writing the file to disk. When present,
        `filename` takes precedence over the value of `Content-ID`.

        When the JSON body omits the `files` element, the remaining parts are
        not ignored. Instead, each file is added to the new snippet as if its
        name was explicitly linked (the use of the `files` elements is
        mandatory for some operations like deleting or renaming files).


        multipart/form-data
        -------------------

        The use of JSON for the snippet's meta data is optional. Meta data can
        also be supplied as regular form fields in a more conventional
        `multipart/form-data` request:

            $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets               -F title="My snippet"               -F file=@foo.txt -F file=@image.png

            POST /2.0/snippets HTTP/1.1
            Content-Length: 951
            Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f

            ------------------------------63a4b224c59f
            Content-Disposition: form-data; name="file"; filename="foo.txt"
            Content-Type: text/plain

            foo

            ------------------------------63a4b224c59f
            Content-Disposition: form-data; name="file"; filename="image.png"
            Content-Type: application/octet-stream

            ?PNG

            IHDR?1??I.....
            ------------------------------63a4b224c59f
            Content-Disposition: form-data; name="title"

            My snippet
            ------------------------------63a4b224c59f--

        Here the meta data properties are included as flat, top-level form
        fields. The file attachments use the `file` field name. To attach
        multiple files, simply repeat the field.

        The advantage of `multipart/form-data` over `multipart/related` is
        that it can be easier to build clients.

        Essentially all properties are optional, `title` and `files` included.


        Sharing and Visibility
        ----------------------

        Snippets can be either public (visible to anyone on Bitbucket, as well
        as anonymous users), or private (visible only to the owner, creator
        and members of the team in case the snippet is owned by a team). This
        is controlled through the snippet's `is_private` element:

        * **is_private=false** -- everyone, including anonymous users can view
          the snippet
        * **is_private=true** -- only the owner and team members (for team
          snippets) can view it

        To create the snippet under a team account, just append the team name
        to the URL (see `/2.0/snippets/{username}`).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/snippet'
        description: The new snippet object.
        required: true
      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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge:
    post:
      description: Merges the pull request.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullrequest_merge_parameters'
        required: false
      responses:
        200:
          content:
            application/json:
              example:
                links:
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1
                  merge:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/merge
                  decline:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/decline
                  comments:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/comments
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/commits
                  approve:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/approve
                  activity:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/activity
                  statuses:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/statuses
                  diff:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/diff
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs/pull-requests/1
                participants: []
                close_source_branch: true
                state: OPEN
                task_count: 0
                comment_count: 0
                type: pullrequest
                author:
                  display_name: Example Username
                  type: user
                  username: example-username
                  links:
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    html:
                      href: https://bitbucket.org/example-username/
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  nickname: example-username
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                reason: ""
                updated_on: 2018-06-20T23:17:33.616037+00:00
                created_on: 2018-06-20T23:17:33.616037+00:00
                reviewers: []
                destination:
                  repository:
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                    type: repository
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                  commit:
                    hash: 230269fdfabd
                    type: commit
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/230269fdfabd
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabd
                  branch:
                    name: master
                summary:
                  html: <p>Everything is awesome!</p>
                  type: rendered
                  raw: Everything is awesome!
                  markup: markdown
                source:
                  commit:
                    hash: c184aab5708b
                    type: commit
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/c184aab5708b
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/c184aab5708b
                  branch:
                    name: branch_magnificent_internet
                  repository:
                    type: repository
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                description: Everything is awesome!
                id: 1
                title: Change a cooperative standard to a smiling disease
              schema:
                $ref: '#/components/schemas/pullrequest'
          description: The pull request object.
        555:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: |-
            If the merge took too long and timed out.
            In this case the caller should retry the request later
      security:
      - oauth2:
        - pullrequest:write
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/commit/{node}/statuses:
    get:
      description: Returns all statuses (e.g. build results) for a specific commit.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        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:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: commitstatuses
  /users/{username}/repositories:
    get:
      description: |-
        All repositories owned by a user/team. This includes private
        repositories, but filtered down to the ones that the calling user has
        access to.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - hasMore: "true"
        tag: users
      - tag: teams
  /repositories/{workspace}/{repo_slug}/commit/{node}/statuses/build/{key}:
    get:
      description: Returns the specified build status for a commit.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commitstatus'
          description: The build status object with the specified key.
        401:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: commitstatuses
    put:
      description: |-
        Used to update the current status of a build status object on the
        specific commit.

        This operation can also be used to change other properties of the
        build status:

        * `state`
        * `name`
        * `description`
        * `url`
        * `refname`

        The `key` cannot be changed.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commitstatus'
        description: The updated build status object
        required: false
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commitstatus'
          description: The updated build status object.
        401:
          content: {}
          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: []
      tags:
      - repositories
      x-tags:
      - hasMore: "true"
        tag: repositories
      - tag: commitstatuses
  /hook_events/{subject_type}:
    get:
      description: |-
        Returns a paginated list of all valid webhook events for the
        specified entity.

        This is public data that does not require any scopes or authentication.

        Example:

        NOTE: The following example is a truncated response object for the `team` `subject_type`.
        We return the same structure for the other `subject_type` objects.

        ```
        $ curl https://api.bitbucket.org/2.0/hook_events/team
        {
            "page": 1,
            "pagelen": 30,
            "size": 21,
            "values": [
                {
                    "category": "Repository",
                    "description": "Whenever a repository push occurs",
                    "event": "repo:push",
                    "label": "Push"
                },
                {
                    "category": "Repository",
                    "description": "Whenever a repository fork occurs",
                    "event": "repo:fork",
                    "label": "Fork"
                },
                ...
                {
                    "category": "Repository",
                    "description": "Whenever a repository import occurs",
                    "event": "repo:imported",
                    "label": "Import"
                }
            ]
        }
        ```
      parameters:
      - description: A resource or subject type.
        in: path
        name: subject_type
        required: true
        schema:
          enum:
          - user
          - repository
          - team
          type: string
      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: []
      tags:
      - webhooks
      x-tags:
      - tag: webhooks
  /user/emails/{email}:
    get:
      description: |-
        Returns details about a specific one of the authenticated user's
        email addresses.

        Details describe whether the address has been confirmed by the user and
        whether it is the user's primary address or not.
      parameters:
      - in: path
        name: email
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - email
      - basic: []
      - api_key: []
      tags:
      - users
      x-tags:
      - tag: users
  /teams/{username}/members:
    get:
      description: |-
        Returns all members of the specified team. Any member of any of the
        team's groups is considered a member of the team. This includes users
        in groups that may not actually have access to any of the team's
        repositories.

        This operation has been deprecated due to privacy changes.
        See the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/)
        for details.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                nickname: example-username
                account_status: active
                account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                links:
                  self:
                    href: https://api.bitbucket.org/2.0/users/example-username
                  avatar:
                    href: https://bitbucket.org/account/example-username/avatar/
                  html:
                    href: https://bitbucket.org/example-username/
                uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                username: example-username
                type: user
                display_name: Example Username
              schema:
                $ref: '#/components/schemas/user'
          description: All members
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: When the team does not exist, or multiple teams with the same
            name exist that differ only in casing and the URL did not match the exact
            casing of a particular one.
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - tag: teams
  /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/:
    get:
      description: Retrieve the configured schedules for the given repository.
      operationId: getRepositoryPipelineSchedules
      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_schedules'
          description: The list of schedules.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The account or repository was not found.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    post:
      description: Create a schedule for the given repository.
      operationId: createRepositoryPipelineSchedule
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pipeline_schedule'
        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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /snippets/{username}/{encoded_id}/watch:
    delete:
      description: |-
        Used to stop watching a specific snippet. Returns 204 (No Content)
        to indicate success.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        204:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    get:
      description: |-
        Used to check if the current user is watching a specific snippet.

        Returns 204 (No Content) if the user is watching the snippet and 404 if
        not.

        Hitting this endpoint anonymously always returns a 404.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        204:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    put:
      description: Used to start watching a specific snippet. Returns 204 (No Content).
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - description: The snippet id.
        in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        204:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/:
    get:
      description: Find repository level known hosts.
      operationId: getRepositoryPipelineKnownHosts
      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_known_hosts'
          description: The retrieved known hosts.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    post:
      description: Create a repository level known host.
      operationId: createRepositoryPipelineKnownHost
      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
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/commit/{node}:
    get:
      description: Returns the specified commit.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: The commit's SHA1.
        in: path
        name: node
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /repositories/{workspace}/{repo_slug}/src/{node}/{path}:
    get:
      description: |-
        This endpoints is used to retrieve the contents of a single file,
        or the contents of a directory at a specified revision.

        ## Raw file contents

        When `path` points to a file, this endpoint returns the raw contents.
        The response's Content-Type is derived from the filename
        extension (not from the contents). The file contents are not processed
        and no character encoding/recoding is performed and as a result no
        character encoding is included as part of the Content-Type.

        The `Content-Disposition` header will be "attachment" to prevent
        browsers from running executable files.

        If the file is managed by LFS, then a 301 redirect pointing to
        Atlassian's media services platform is returned.

        The response includes an ETag that is based on the contents of the file
        and its attributes. This means that an empty `__init__.py` always
        returns the same ETag, regardless on the directory it lives in, or the
        commit it is on.

        ## File meta data

        When the request for a file path includes the query parameter
        `?format=meta`, instead of returning the file's raw contents, Bitbucket
        instead returns the JSON object describing the file's properties:

        ```javascript
        $ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests/__init__.py?format=meta
        {
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py"
            },
            "meta": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta"
            }
          },
          "path": "tests/__init__.py",
          "commit": {
            "type": "commit",
            "hash": "eefd5ef5d3df01aed629f650959d6706d54cd335",
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335"
              },
              "html": {
                "href": "https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335"
              }
            }
          },
          "attributes": [],
          "type": "commit_file",
          "size": 0
        }
        ```

        File objects contain an `attributes` element that contains a list of
        possible modifiers. Currently defined values are:

        * `link` -- indicates that the entry is a symbolic link. The contents
            of the file represent the path the link points to.
        * `executable` -- indicates that the file has the executable bit set.
        * `subrepository` -- indicates that the entry points to a submodule or
            subrepo. The contents of the file is the SHA1 of the repository
            pointed to.
        * `binary` -- indicates whether Bitbucket thinks the file is binary.

        This endpoint can provide an alternative to how a HEAD request can be
        used to check for the existence of a file, or a file's size without
        incurring the overhead of receiving its full contents.


        ## Directory listings

        When `path` points to a directory instead of a file, the response is a
        paginated list of directory and file objects in the same order as the
        underlying SCM system would return them.

        For example:

        ```javascript
        $ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests
        {
          "pagelen": 10,
          "values": [
            {
              "path": "tests/test_project",
              "type": "commit_directory",
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/"
                },
                "meta": {
                  "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta"
                }
              },
              "commit": {
                "type": "commit",
                "hash": "eefd5ef5d3df01aed629f650959d6706d54cd335",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335"
                  },
                  "html": {
                    "href": "https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335"
                  }
                }
              }
            },
            {
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py"
                },
                "meta": {
                  "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta"
                }
              },
              "path": "tests/__init__.py",
              "commit": {
                "type": "commit",
                "hash": "eefd5ef5d3df01aed629f650959d6706d54cd335",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335"
                  },
                  "html": {
                    "href": "https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335"
                  }
                }
              },
              "attributes": [],
              "type": "commit_file",
              "size": 0
            }
          ],
          "page": 1,
          "size": 2
        }
        ```

        When listing the contents of the repo's root directory, the use of a
        trailing slash at the end of the URL is required.

        The response by default is not recursive, meaning that only the direct contents of
        a path are returned. The response does not recurse down into
        subdirectories. In order to "walk" the entire directory tree, the
        client can either parse each response and follow the `self` links of each
        `commit_directory` object, or can specify a `max_depth` to recurse to.

        The max_depth parameter will do a breadth-first search to return the contents of the subdirectories
        up to the depth specified. Breadth-first search was chosen as it leads to the least amount of
        file system operations for git. If the `max_depth` parameter is specified to be too
        large, the call will time out and return a 555.

        Each returned object is either a `commit_file`, or a `commit_directory`,
        both of which contain a `path` element. This path is the absolute path
        from the root of the repository. Each object also contains a `commit`
        object which embeds the commit the file is on. Note that this is merely
        the commit that was used in the URL. It is *not* the commit that last
        modified the file.

        Directory objects have 2 representations. Their `self` link returns the
        paginated contents of the directory. The `meta` link on the other hand
        returns the actual `directory` object itself, e.g.:

        ```javascript
        {
          "path": "tests/test_project",
          "type": "commit_directory",
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/"
            },
            "meta": {
              "href": "https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta"
            }
          },
          "commit": { ... }
        }
        ```

        ## Querying, filtering and sorting

        Like most API endpoints, this API supports the Bitbucket
        querying/filtering syntax and so you could filter a directory listing
        to only include entries that match certain criteria. For instance, to
        list all binary files over 1kb use the expression:

        `size > 1024 and attributes = "binary"`

        which after urlencoding yields the query string:

        `?q=size%3E1024+and+attributes%3D%22binary%22`

        To change the ordering of the response, use the `?sort` parameter:

        `.../src/eefd5ef/?sort=-size`

        See [filtering and sorting](../../../../../../meta/filtering) for more
        details.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: node
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - 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 and Mercurial do 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
        schema:
          enum:
          - meta
          - rendered
          type: string
      - description: Optional filter expression as per [filtering and sorting](../../../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: Optional sorting parameter as per [filtering and sorting](../../../../../../meta/filtering#query-sort).
        in: query
        name: sort
        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
        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
            returned.  If the `format=meta` query parameter is provided,
            a json document containing the file's meta data is
            returned.  If the `format=rendered` query parameter is provided,
            the contents of the file in HTML-formated rendered markup is returned.
            If the path matches a directory, then a paginated
            list of file and directory entries is returned (if the
            `format=meta` query parameter was provided, then the json document
            containing the directory's meta data is returned.)
        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 specifiedrecursion
            depth is too large.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - source
      x-tags:
      - hasMore: "true"
        tag: source
      - tag: repositories
  /repositories/{workspace}/{repo_slug}/pullrequests/activity:
    get:
      description: |-
        Returns a paginated list of the pull request's activity log.

        This includes comments that were made by the reviewers, updates and
        approvals.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      responses:
        200:
          content: {}
          description: The pull request activity log
        401:
          content: {}
          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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /addon/linkers/{linker_key}/values/:
    delete:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
    get:
      parameters:
      - in: path
        name: linker_key
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
  /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}:
    delete:
      description: |-
        This deletes a deploy key from a repository.

        Example:
        ```
        $ curl -XDELETE \
        -H "Authorization <auth header>" \
        https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The key ID matching the deploy key.
        in: path
        name: key_id
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          description: The key has been deleted
        403:
          content: {}
          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: []
      tags:
      - deploy
      x-tags:
      - tag: deploy
    get:
      description: |-
        Returns the deploy key belonging to a specific key.

        Example:
        ```
        $ curl -H "Authorization <auth header>" \
        https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234

        Output:
        {
            "comment": "mleu@C02W454JHTD8",
            "last_used": null,
            "links": {
                "self": {
                    "href": https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234"
                }
            },
            "repository": {
                "full_name": "mleu/test",
                "name": "test",
                "type": "repository",
                "uuid": "{85d08b4e-571d-44e9-a507-fa476535aa98}"
            },
            "label": "mykey",
            "created_on": "2018-08-15T23:50:59.993890+00:00",
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5",
            "id": 1234,
            "type": "deploy_key"
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The key ID matching the deploy key.
        in: path
        name: key_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deploy_key'
          description: Deploy key matching the key ID
        403:
          content: {}
          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: []
      tags:
      - deploy
      x-tags:
      - tag: deploy
    put:
      description: |-
        Create a new deploy key in a repository.

        The same key needs to be passed in but the comment and label can change.

        Example:
        ```
        $ curl -XPUT \
        -H "Authorization <auth header>" \
        -H "Content-type: application/json" \
        https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234 -d \
        '{
            "label": "newlabel",
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 newcomment",
        }'

        Output:
        {
            "comment": "newcomment",
            "last_used": null,
            "links": {
                "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234"
                }
            },
            "repository": {
                "full_name": "mleu/test",
                "name": "test",
                "type": "repository",
                "uuid": "{85d08b4e-571d-44e9-a507-fa476535aa98}"
            },
            "label": "newlabel",
            "created_on": "2018-08-15T23:50:59.993890+00:00",
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5",
            "id": 1234,
            "type": "deploy_key"
        }
        ```
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The key ID matching the deploy key.
        in: path
        name: key_id
        required: true
        schema:
          type: string
      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:
          content: {}
          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: []
      tags:
      - deploy
      x-tags:
      - tag: deploy
  /repositories/{workspace}/{repo_slug}/versions:
    get:
      description: |-
        Returns the versions that have been defined in the issue tracker.

        This resource is only available on repositories that have the issue
        tracker enabled.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /hook_events:
    get:
      description: |-
        Returns the webhook resource or subject types on which webhooks can
        be registered.

        Each resource/subject type contains an `events` link that returns the
        paginated list of specific events each individual subject type can
        emit.

        This endpoint is publicly accessible and does not require
        authentication or scopes.

        Example:

        ```
        $ curl https://api.bitbucket.org/2.0/hook_events

        {
            "repository": {
                "links": {
                    "events": {
                        "href": "https://api.bitbucket.org/2.0/hook_events/repository"
                    }
                }
            },
            "team": {
                "links": {
                    "events": {
                        "href": "https://api.bitbucket.org/2.0/hook_events/team"
                    }
                }
            },
            "user": {
                "links": {
                    "events": {
                        "href": "https://api.bitbucket.org/2.0/hook_events/user"
                    }
                }
            }
        }
        ```
      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: []
      tags:
      - webhooks
      x-tags:
      - tag: webhooks
  /repositories/{workspace}/{repo_slug}/components/{component_id}:
    get:
      description: Returns the specified issue tracker component object.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - 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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /snippets/{username}/{encoded_id}/commits/{revision}:
    get:
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      - in: path
        name: revision
        required: true
        schema:
          type: string
      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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity:
    get:
      description: |-
        Returns a paginated list of the pull request's activity log.

        This includes comments that were made by the reviewers, updates and
        approvals.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The id of the pull request.
        in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_activities'
          description: The pull request activity log
        401:
          content: {}
          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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions/:
    get:
      description: Retrieve the executions of a given schedule.
      operationId: getRepositoryPipelineScheduleExecutions
      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_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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch:
    delete:
      description: Stop watching this issue.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - issue:write
        - account:write
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    get:
      description: |-
        Indicated whether or not the authenticated user is watching this
        issue.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - issue
        - account
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    put:
      description: |-
        Start watching this issue.

        To start watching this issue, do an empty PUT. The 204 status code
        indicates that the operation was successful.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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:
        - issue
        - account:write
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/commits/{revision}:
    get:
      description: |-
        These are the repository's commits. They are paginated and returned
        in reverse chronological order, similar to the output of `git log` and
        `hg log`. Like these tools, the DAG can be filtered.

        ## GET /repositories/{workspace}/{repo_slug}/commits/

        Returns all commits in the repo in topological order (newest commit
        first). All branches and tags are included (similar to
        `git log --all` and `hg log`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/master

        Returns all commits on rev `master` (similar to `git log master`,
        `hg log master`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/dev?exclude=master

        Returns all commits on ref `dev`, except those that are reachable on
        `master` (similar to `git log dev ^master`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/?exclude=master

        Returns all commits in the repo that are not on master
        (similar to `git log --all ^master`).

        ## GET /repositories/{workspace}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar

        Returns all commits that are on refs `foo` or `bar`, but not on `fu` or
        `fubar` (similar to `git log foo bar ^fu ^fubar`).

        An optional `path` parameter can be specified that will limit the
        results to commits that affect that path. `path` can either be a file
        or a directory. If a directory is specified, commits are returned that
        have modified any file in the directory tree rooted by `path`. It is
        important to note that if the `path` parameter is specified, the commits
        returned by this endpoint may no longer be a DAG, parent commits that
        do not modify the path will be omitted from the response.

        ## GET /repositories/{workspace}/{repo_slug}/commits/?path=README.md&include=foo&include=bar&exclude=master

        Returns all commits that are on refs `foo` or `bar`, but not on `master`
        that changed the file README.md.

        ## GET /repositories/{workspace}/{repo_slug}/commits/?path=src/&include=foo&include=bar&exclude=master

        Returns all commits that are on refs `foo` or `bar`, but not on `master`
        that changed to a file in any file in the directory src or its children.

        Because the response could include a very large number of commits, it
        is paginated. Follow the 'next' link in the response to navigate to the
        next page of commits. As with other paginated resources, do not
        construct your own links.

        When the include and exclude parameters are more than can fit in a
        query string, clients can use a `x-www-form-urlencoded` POST instead.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: revision
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
    post:
      description: |-
        Identical to `GET /repositories/{workspace}/{repo_slug}/commits`,
        except that POST allows clients to place the include and exclude
        parameters in the request body to avoid URL length issues.

        **Note that this resource does NOT support new commit creation.**
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: revision
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - commits
      x-tags:
      - tag: commits
  /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: The account.
        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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories/{workspace}/{repo_slug}/branch-restrictions:
    get:
      description: |-
        Returns a paginated list of all branch restrictions on the
        repository.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: Branch restrictions of this type
        in: query
        name: kind
        schema:
          type: string
      - description: Branch restrictions applied to branches of this pattern
        in: query
        name: pattern
        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: []
      tags:
      - branchrestrictions
      x-tags:
      - tag: branchrestrictions
    post:
      description: |-
        Creates a new branch restriction rule for a repository.

        `kind` describes what will be restricted. Allowed values include:
        `push`, `force`, `delete` and `restrict_merges`.

        Different kinds of branch restrictions have different requirements:

        * `push` and `restrict_merges` require `users` and `groups` to be
          specified. Empty lists are allowed, in which case permission is
          denied for everybody.
        * `force` can not be specified in a Mercurial repository.

        The restriction applies to all branches that match. There are
        two ways to match a branch. It is configured in `branch_match_kind`:

        1. `glob`: Matches a branch against the `pattern`. A `'*'` in
           `pattern` will expand to match zero or more characters, and every
           other character matches itself. For example, `'foo*'` will match
           `'foo'` and `'foobar'`, but not `'barfoo'`. `'*'` will match all
           branches.
        2. `branching_model`: Matches a branch against the repository's
           branching model. The `branch_type` controls the type of branch
           to match. Allowed values include: `production`, `development`,
           `bugfix`, `release`, `feature` and `hotfix`.

        The combination of `kind` and match must be unique. This means that
        two `glob` restrictions in a repository cannot have the same `kind` and
        `pattern`. Additionally, two `branching_model` restrictions in a
        repository cannot have the same `kind` and `branch_type`.

        `users` and `groups` are lists of users and groups that are except from
        the restriction. They can only be configured in `push` and
        `restrict_merges` restrictions. The `push` restriction stops a user
        pushing to matching branches unless that user is in `users` or is a
        member of a group in `groups`. The `restrict_merges` stops a user
        merging pull requests to matching branches unless that user is in
        `users` or is a member of a group in `groups`. Adding new users or
        groups to an existing restriction should be done via `PUT`.

        Note that branch restrictions with overlapping matchers is allowed,
        but the resulting behavior may be surprising.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - branchrestrictions
      x-tags:
      - tag: branchrestrictions
  /snippets/{username}:
    get:
      description: |-
        Identical to `/snippets`, except that the result is further filtered
        by the snippet owner and only those that are owned by `{username}` are
        returned.
      parameters:
      - description: Filter down the result based on the authenticated user's role
          (`owner`, `contributor`, or `member`).
        in: query
        name: role
        schema:
          enum:
          - owner
          - contributor
          - member
          type: string
      - description: Limits the result to snippets owned by this user.
        in: path
        name: username
        required: true
        schema:
          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: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
    post:
      description: |-
        Identical to `/snippets`, except that the new snippet will be
        created under the account specified in the path parameter `{username}`.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/snippet'
        description: The new snippet object.
        required: true
      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 under the specified account.
      security:
      - oauth2:
        - snippet:write
      - basic: []
      - api_key: []
      tags:
      - snippets
      x-tags:
      - tag: snippets
  /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}:
    get:
      description: Retrieve a deployment
      operationId: getDeploymentForRepository
      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 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.
      tags:
      - deployments
      x-tags:
      - tag: deployments
  /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests:
    get:
      operationId: getPullrequestsForCommit
      parameters:
      - description: The account; either the UUID in curly braces, or the account_id
        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
        schema:
          default: 1
          format: int32
          type: integer
      - description: How many pull requests to retrieve per page
        in: query
        name: pagelen
        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: Returns a paginated list of all pull requests as part of which this
        commit was reviewed.
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /teams:
    get:
      description: |-
        Returns all the teams that the authenticated user is associated
        with.
      parameters:
      - description: |2

          Filters the teams based on the authenticated user's role on each team.

          * **member**: returns a list of all the teams which the caller is a member of
            at least one team group or repository owned by the team
          * **contributor**: returns a list of teams which the caller has write access
            to at least one repository owned by the team
          * **admin**: returns a list teams which the caller has team administrator access
        in: query
        name: role
        schema:
          enum:
          - admin
          - contributor
          - member
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_teams'
          description: A paginated list of teams.
        401:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: When the request wasn't authenticated.
      security:
      - oauth2:
        - team
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - tag: teams
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}:
    delete:
      description: |-
        Deletes the specified issue. This requires write access to the
        repository.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    get:
      description: Returns the specified issue.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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.
      security:
      - oauth2:
        - issue
      - basic: []
      - api_key: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    put:
      description: |-
        Modifies the issue.

        ```
        $ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \
          -u evzijst -s -X PUT -H 'Content-Type: application/json' \
          -d '{
          "title": "Updated title",
          "assignee": {
            "username": "evzijst"
          },
          "priority": "minor",
          "version": {
            "name": "1.0"
          },
          "component": null
        }'
        ```

        This example changes the `title`, `assignee`, `priority` and the
        `version`. It also removes the value of the `component` from the issue
        by setting the field to `null`. Any field not present keeps its existing
        value.

        Each time an issue is edited in the UI or through the API, an immutable
        change record is created under the `/issues/123/changes` endpoint. It
        also has a comment associated with the change.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /teams/{username}:
    get:
      description: |-
        Gets the public information associated with a team.

        If the team's profile is private, `location`, `website` and
        `created_on` elements are omitted.
      parameters:
      - description: The team's username or UUID.
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/team'
          description: The team object
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If no team exists for the specified name or UUID, or if the
            specified account is a personal account, not a team account.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - tag: teams
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch:
    get:
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /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
        job and return the zip file after the job is complete.
        As long as the job is running, this will return a 200 response
        with in the response body a description of the current status.

        After the job has been scheduled, but before it starts executing, this
        endpoint's response is:

        {
         "type": "issue_job_status",
         "status": "ACCEPTED",
         "phase": "Initializing",
         "total": 0,
         "count": 0,
         "pct": 0
        }


        Then once it starts running, it becomes:

        {
         "type": "issue_job_status",
         "status": "STARTED",
         "phase": "Attachments",
         "total": 15,
         "count": 11,
         "pct": 73
        }

        Once the job has successfully completed, it returns a stream of the zip file.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: The name of the repo
        in: path
        name: repo_name
        required: true
        schema:
          type: string
      - description: The ID of the export task
        in: path
        name: task_id
        required: true
        schema:
          type: string
      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:
        - repository:admin
        - issue
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /repositories/{workspace}/{repo_slug}/pipelines/:
    get:
      description: Find pipelines
      operationId: getPipelinesForRepository
      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_pipelines'
          description: The matching pipelines.
      tags:
      - pipelines
      x-tags:
      - tag: 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\n\
        You 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\n\
        In 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"
      operationId: createPipelineForRepository
      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
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /addon/users/{target_user}/events/{event_key}:
    post:
      description: |-
        POST a new custom event.

        The data within the event body will be hydrated by Bitbucket. For example, the following event
        submission would result in subscribers for the event receiving the full repository object
        corresponding to the UUID.

        ```
        $ curl -X POST -H "Content-Type: application/json" -d '{
            "mynumdata": "12345",
            "repository": {
                "type": "repository",
                "uuid": "{be95aa1f-c0b2-47f6-99d1-bf5d3a0f850f}"
        }}' https://api.bitbucket.org/2.0/addon/users/myuser/events/com.example.app%3Amyevent
        ```

        Use the optional `fields` property of the custom event Connect
        module where the event is defined to add additional
        fields to the expanded payload sent to listeners.

        For example, the `customEvents` module in the app descriptor for the previous example would look like this:

        ```
        'modules': {
            'customEvents': {
                'com.example.app:myevent': {
                    'schema': {
                        'properties': {
                            'mynumdata': {'type': 'number'},
                            'repository': {'$ref': '#/definitions/repository'}
                        }
                    },
                    'fields': ['repository.owner']
                }
            }
        }
        ```

        By specifying fields as above, the repository owner
        will also be sent to subscribers of the event.
      parameters:
      - description: |
          The account the app is installed in.

          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: target_user
        required: true
        schema:
          type: string
      - description: |
          The key of the event, which corresponds to an event
          defined in the connect app descriptor.
        in: path
        name: event_key
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          description: Event successfully submitted
        404:
          content: {}
          description: Connect app not installed or event does not exist
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - addon
      x-tags:
      - tag: addon
  /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}:
    delete:
      description: Delete a repository level known host.
      operationId: deleteRepositoryPipelineKnownHost
      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 known host to delete.
        in: path
        name: known_host_uuid
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    get:
      description: Retrieve a repository level known host.
      operationId: getRepositoryPipelineKnownHost
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    put:
      description: Update a repository level known host.
      operationId: updateRepositoryPipelineKnownHost
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /repositories:
    get:
      description: |-
        Returns a paginated list of all public repositories.

        This endpoint also supports filtering and sorting of the results. See
        [filtering and sorting](../meta/filtering) for more details.
      parameters:
      - description: |-
          Filter the results to include only repositories create on or
          after this [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)
           timestamp. Example: `YYYY-MM-DDTHH:mm:ss.sssZ`
        in: query
        name: after
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_repositories'
          description: All public repositories.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - repositories
      x-tags:
      - tag: repositories
  /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}:
    delete:
      description: Removes a default reviewer from the repository.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the default reviewer,
          surrounded by curly-braces, for example: `{account UUID}`.
        in: path
        name: target_username
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository:admin
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    get:
      description: |-
        Returns the specified reviewer.

        This can be used to test whether a user is among the repository's
        default reviewers list. A 404 indicates that that specified user is not
        a default reviewer.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the default reviewer,
          surrounded by curly-braces, for example: `{account UUID}`.
        in: path
        name: target_username
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - pullrequest
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
    put:
      description: |-
        Adds the specified user to the repository's list of default
        reviewers.

        This method is idempotent. Adding a user a second time has no effect.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the default reviewer,
          surrounded by curly-braces, for example: `{account UUID}`.
        in: path
        name: target_username
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unexpected error.
      security:
      - oauth2:
        - repository:admin
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /repositories/{workspace}/{repo_slug}/filehistory/{node}/{path}:
    get:
      description: |-
        Returns a paginated list of commits that modified the specified file.

        Commits are returned in reverse chronological order. This is roughly
        equivalent to the following commands:

            $ git log --follow --date-order <sha> <path>

            $ hg log --follow <path>

        By default, Bitbucket will follow renames and the path name in the
        returned entries reflects that. This can be turned off using the
        `?renames=false` query parameter.

        Results are returned in descending chronological order by default, and
        like most endpoints you can
        [filter and sort](../../../../../../meta/filtering) the response to
        only provide exactly the data you want.

        For example, if you wanted to find commits made before 2011-05-18
        against a file named `README.rst`, but you only wanted the path and
        date, your query would look like this:

        ```
        $ curl 'https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/filehistory/master/README.rst'\
          '?fields=values.next,values.path,values.commit.date&q=commit.date<=2011-05-18'
        {
          "values": [
            {
              "commit": {
                "date": "2011-05-17T07:32:09+00:00"
              },
              "path": "README.rst"
            },
            {
              "commit": {
                "date": "2011-05-16T06:33:28+00:00"
              },
              "path": "README.txt"
            },
            {
              "commit": {
                "date": "2011-05-16T06:15:39+00:00"
              },
              "path": "README.txt"
            }
          ]
        }
        ```

        In the response you can see that the file was renamed to `README.rst`
        by the commit made on 2011-05-16, and was previously named `README.txt`.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: node
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          When `true`, Bitbucket will follow the history of the file across
          renames (this is the default behavior). This can be turned off by
          specifying `false`.
        in: query
        name: renames
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property sort the result by as per
          [filtering and sorting](../../../../../../meta/filtering#query-sort).
        in: query
        name: sort
        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: []
      tags:
      - source
      x-tags:
      - hasMore: "true"
        tag: source
      - tag: repositories
  /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/:
    get:
      description: Find steps for the given pipeline.
      operationId: getPipelineStepsForRepository
      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 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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
  /user/permissions/teams:
    get:
      description: "Returns an object for each team the caller is a member of, and\
        \ their\neffective role â\x80\x94 the highest level of privilege the caller\
        \ has. If a\nuser is a member of multiple groups with distinct roles, only\
        \ the\nhighest level is returned.\n\nPermissions can be:\n\n* `admin`\n* `collaborator`\n\
        \nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/user/permissions/teams\n\
        \n{\n  \"pagelen\": 10,\n  \"values\": [\n    {\n      \"permission\": \"\
        admin\",\n      \"type\": \"team_permission\",\n      \"user\": {\n      \
        \  \"type\": \"user\",\n        \"username\": \"evzijst\",\n        \"nickname\"\
        : \"evzijst\",\n        \"display_name\": \"Erik van Zijst\",\n        \"\
        uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n      },\n      \"team\"\
        : {\n        \"username\": \"bitbucket\",\n        \"display_name\": \"Atlassian\
        \ Bitbucket\",\n        \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"\
        \n      }\n    }\n  ],\n  \"page\": 1,\n  \"size\": 1\n}\n```\n\nResults may\
        \ be further [filtered or sorted](../../../meta/filtering) by\nteam or permission\
        \ by adding the following query string parameters:\n\n* `q=team.username=\"\
        bitbucket\"` or `q=permission=\"admin\"`\n* `sort=team.display_name`\n\nNote\
        \ that the query parameter values need to be URL escaped so that `=`\nwould\
        \ become `%3D`."
      parameters:
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../meta/filtering).
        in: query
        name: q
        schema:
          type: string
      - description: |2

          Name of a response property sort the result by as per
          [filtering and sorting](../../../meta/filtering#query-sort).
        in: query
        name: sort
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_team_permissions'
          description: Team permissions for the teams a caller is a member of.
      security:
      - oauth2:
        - account
      - basic: []
      - api_key: []
      tags: []
      x-tags: []
  /snippets/{username}/{encoded_id}/files/{path}:
    get:
      description: |-
        Convenience resource for getting to a snippet's raw files without the
        need for first having to retrieve the snippet itself and having to pull
        out the versioned file links.
      parameters:
      - in: path
        name: username
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      - in: path
        name: encoded_id
        required: true
        schema:
          type: string
      responses:
        302:
          content: {}
          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: []
      tags:
      - snippet
      x-tags:
      - tag: snippet
  /repositories/{workspace}/{repo_slug}/refs/branches/{name}:
    delete:
      description: |-
        Delete a branch in the specified repository.

        The main branch is not allowed to be deleted and will return a 400
        response.

        For Git, the branch name should not include any prefixes (e.g.
        refs/heads). For Mercurial, this closes all open heads on the branch,
        sets the author of the commit to the authenticated caller, and changes
        the date to the datetime of the call.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - 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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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
            access to it.
        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: []
      tags:
      - refs
      x-tags:
      - tag: refs
    get:
      description: |-
        Returns a branch object within the specified repository.

        ```
        $ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/refs/branches/default | jq .
        {
          "heads": [
            {
              "hash": "f1a0933ce59e809f190602655e22ae6ec107c397",
              "type": "commit",
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397"
                },
                "html": {
                  "href": "https://bitbucket.org/seanfarley/mercurial/commits/f1a0933ce59e809f190602655e22ae6ec107c397"
                }
              }
            }
          ],
          "type": "named_branch",
          "name": "default",
          "links": {
            "commits": {
              "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commits/default"
            },
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/refs/branches/default"
            },
            "html": {
              "href": "https://bitbucket.org/seanfarley/mercurial/branch/default"
            }
          },
          "target": {
            "hash": "f1a0933ce59e809f190602655e22ae6ec107c397",
            "repository": {
              "links": {
                "self": {
                  "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial"
                },
                "html": {
                  "href": "https://bitbucket.org/seanfarley/mercurial"
                },
                "avatar": {
                  "href": "https://bitbucket.org/seanfarley/mercurial/avatar/32/"
                }
              },
              "type": "repository",
              "name": "mercurial",
              "full_name": "seanfarley/mercurial",
              "uuid": "{73dcbd61-e506-4fc1-9ecd-31be2b6d6031}"
            },
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397"
              },
              "comments": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397/comments"
              },
              "patch": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/patch/f1a0933ce59e809f190602655e22ae6ec107c397"
              },
              "html": {
                "href": "https://bitbucket.org/seanfarley/mercurial/commits/f1a0933ce59e809f190602655e22ae6ec107c397"
              },
              "diff": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/diff/f1a0933ce59e809f190602655e22ae6ec107c397"
              },
              "approve": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397/approve"
              },
              "statuses": {
                "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/f1a0933ce59e809f190602655e22ae6ec107c397/statuses"
              }
            },
            "author": {
              "raw": "Martin von Zweigbergk <martinvonz@google.com>",
              "type": "author",
              "user": {
                "username": "martinvonz",
                "nickname": "martinvonz",
                "display_name": "Martin von Zweigbergk",
                "type": "user",
                "uuid": "{fdb0e657-3ade-4fad-a136-95f1ffe4a5ac}",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/users/martinvonz"
                  },
                  "html": {
                    "href": "https://bitbucket.org/martinvonz/"
                  },
                  "avatar": {
                    "href": "https://bitbucket.org/account/martinvonz/avatar/32/"
                  }
                }
              }
            },
            "parents": [
              {
                "hash": "5523aabb85c30ebc2b8e29aadcaf5e13fa92b375",
                "type": "commit",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/seanfarley/mercurial/commit/5523aabb85c30ebc2b8e29aadcaf5e13fa92b375"
                  },
                  "html": {
                    "href": "https://bitbucket.org/seanfarley/mercurial/commits/5523aabb85c30ebc2b8e29aadcaf5e13fa92b375"
                  }
                }
              }
            ],
            "date": "2018-02-01T18:44:49+00:00",
            "message": "config: replace a for-else by any()",
            "type": "commit"
          }
        }
        ```

        This call requires authentication. Private repositories require the
        caller to authenticate with an account that has appropriate
        authorization.

        For Git, the branch name should not include any prefixes (e.g.
        refs/heads).

        For Mercurial, the response will include an additional field that lists
        the open heads.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - 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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                type: branch
                links:
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs/branch/master
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/refs/branches/master
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commits/master
                target:
                  parents: []
                  links:
                    comments:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2/comments
                    self:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2
                    approve:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2/approve
                    statuses:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabdb5562a991f351b5dd6425de232d2/statuses
                    patch:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/patch/230269fdfabdb5562a991f351b5dd6425de232d2
                    html:
                      href: https://bitbucket.org/example-username/bits_and_bobs/commits/230269fdfabdb5562a991f351b5dd6425de232d2
                    diff:
                      href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/diff/230269fdfabdb5562a991f351b5dd6425de232d2
                  repository:
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                    type: repository
                  message: Kickass commit message!
                  date: 2018-06-20T23:17:33+00:00
                  hash: 230269fdfabdb5562a991f351b5dd6425de232d2
                  author:
                    user:
                      type: user
                      username: example-username
                      display_name: Example Username
                      nickname: example-username
                      account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                      links:
                        html:
                          href: https://bitbucket.org/example-username/
                        self:
                          href: https://api.bitbucket.org/2.0/users/example-username
                        avatar:
                          href: https://bitbucket.org/account/example-username/avatar/
                      uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                    raw: Example Username <brian_stamm@gmail.com>
                    type: author
                  type: commit
                name: master
              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
            access to it.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: The specified repository or branch does not exist.
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
      tags:
      - refs
      x-tags:
      - tag: refs
  /teams/{username}/projects/{project_key}:
    delete:
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: |
          The project in question. This can either be the actual `key` assigned
          to the project or the `UUID` (surrounded by curly-braces (`{}`)).
        in: path
        name: project_key
        required: true
        schema:
          type: string
      responses:
        204:
          content: {}
          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:write
      - basic: []
      - api_key: []
      tags:
      - projects
      x-tags:
      - tag: projects
    get:
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: |
          The project in question. This can either be the actual `key` assigned
          to the project or the `UUID` (surrounded by curly-braces (`{}`)).
        in: path
        name: project_key
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/project'
          description: The project object.
        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: []
      tags:
      - projects
      x-tags:
      - tag: projects
    put:
      description: |-
        Since this endpoint can be used to both update and to create a
        project, the request body depends on the intent.

        ### Creation

        See the POST documentation for the project collection for an
        example of the request body.

        Note: The `key` should not be specified in the body of request
        (since it is already present in the URL). The `name` is required,
        everything else is optional.

        ### Update

        See the POST documentation for the project collection for an
        example of the request body.

        Note: The key is not required in the body (since it is already in
        the URL). The key may be specified in the body, if the intent is
        to change the key itself. In such a scenario, the location of the
        project is changed and is returned in the `Location` header of the
        response.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: |
          The project in question. This can either be the actual `key` assigned
          to the project or the `UUID` (surrounded by curly-braces (`{}`)).
        in: path
        name: project_key
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/project'
        required: true
      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
                when 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 team 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:write
      - basic: []
      - api_key: []
      tags:
      - projects
      x-tags:
      - tag: projects
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments:
    get:
      description: |-
        Returns a paginated list of all comments that were made on the
        specified issue.

        The default sorting is oldest to newest and can be overridden with
        the `sort` query parameter.

        This endpoint also supports filtering and sorting of the results. See
        [filtering and sorting](../../../../../../meta/filtering) for more details.
      parameters:
      - in: path
        name: issue_id
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      - description: |2-

          Query string to narrow down the response as per
          [filtering and sorting](../../../../../../meta/filtering).
        in: query
        name: q
        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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
    post:
      description: |-
        Creates a new issue comment.

        ```
        $ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \
          -X POST -u evzijst \
          -H 'Content-Type: application/json' \
          -d '{"content": {"raw": "Lorem ipsum."}}'
        ```
      parameters:
      - in: path
        name: issue_id
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the user,
          surrounded by curly-braces, for example: `{user UUID}`.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - description: |
          This can either be the repository slug or the UUID of the repository,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/issue_comment'
        description: The new issue comment object.
        required: true
      responses:
        201:
          content: {}
          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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}:
    get:
      description: |-
        Returns the specified issue change object.

        This resource is only available on repositories that have the issue
        tracker enabled.
      parameters:
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: workspace
        required: true
        schema:
          type: string
      - 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,
          surrounded by curly-braces, for example: `{repository UUID}`.
        in: path
        name: repo_slug
        required: true
        schema:
          type: string
      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: []
      tags:
      - issue_tracker
      x-tags:
      - tag: issue_tracker
  /pullrequests/{target_user}:
    get:
      description: |-
        Returns all pull requests authored by the specified user.

        By default only open pull requests are returned. This can be controlled
        using the `state` query parameter. To retrieve pull requests that are
        in one of multiple states, repeat the `state` parameter for each
        individual state.

        This endpoint also supports filtering and sorting of the results. See
        [filtering and sorting](../../../../meta/filtering) for more details.
      parameters:
      - in: path
        name: target_user
        required: true
        schema:
          type: string
      - description: |
          This can either be the username or the UUID of the account,
          surrounded by curly-braces, for example: `{account UUID}`. An account
          is either a team or user.
        in: path
        name: username
        required: true
        schema:
          type: string
      - description: Only return pull requests that are in this state. This parameter
          can be repeated.
        in: query
        name: state
        schema:
          enum:
          - MERGED
          - SUPERSEDED
          - OPEN
          - DECLINED
          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: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /teams/{username}/followers:
    get:
      description: Returns the list of accounts that are following this team.
      parameters:
      - description: The team's username
        in: path
        name: username
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginated_users'
          description: A paginated list of user objects.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: If no team exists for the specified name, or if the specified
            account is a personal account, not a team account.
      security:
      - oauth2: []
      - basic: []
      - api_key: []
      tags:
      - teams
      x-tags:
      - tag: teams
  /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline:
    post:
      description: Declines the pull request.
      parameters:
      - in: path
        name: workspace
        required: true
        schema:
          type: string
      - in: path
        name: pull_request_id
        required: true
        schema:
          type: string
      - in: path
        name: repo_slug
        required: true
        schema:
          type: string
      responses:
        200:
          content:
            application/json:
              example:
                summary:
                  markup: markdown
                  raw: Everything is awesome!
                  type: rendered
                  html: <p>Everything is awesome!</p>
                description: Everything is awesome!
                source:
                  branch:
                    name: branch_magnificent_internet
                  commit:
                    hash: c184aab5708b
                    type: commit
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/c184aab5708b
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/c184aab5708b
                  repository:
                    full_name: example-username/bits_and_bobs
                    name: bits_and_bobs
                    type: repository
                    links:
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                title: Change a cooperative standard to a smiling disease
                id: 1
                close_source_branch: true
                participants: []
                links:
                  decline:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/decline
                  merge:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/merge
                  comments:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/comments
                  self:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1
                  approve:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/approve
                  commits:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/commits
                  statuses:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/statuses
                  activity:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/activity
                  html:
                    href: https://bitbucket.org/example-username/bits_and_bobs/pull-requests/1
                  diff:
                    href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/pullrequests/1/diff
                state: OPEN
                author:
                  uuid: '{58021780-82b6-4517-b153-0ae73ce3e4b4}'
                  nickname: example-username
                  account_id: 123456:daffbc08-1a80-4bd0-98bf-7997de0a3d10
                  links:
                    html:
                      href: https://bitbucket.org/example-username/
                    avatar:
                      href: https://bitbucket.org/account/example-username/avatar/
                    self:
                      href: https://api.bitbucket.org/2.0/users/example-username
                  display_name: Example Username
                  type: user
                  username: example-username
                task_count: 0
                type: pullrequest
                comment_count: 0
                created_on: 2018-06-20T23:17:33.616037+00:00
                reviewers: []
                destination:
                  repository:
                    name: bits_and_bobs
                    full_name: example-username/bits_and_bobs
                    type: repository
                    links:
                      avatar:
                        href: https://bytebucket.org/ravatar/%7B7708d810-964c-403f-aa6d-4e949280d614%7D?ts=python
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs
                    uuid: '{7708d810-964c-403f-aa6d-4e949280d614}'
                  commit:
                    hash: 230269fdfabd
                    links:
                      self:
                        href: https://api.bitbucket.org/2.0/repositories/example-username/bits_and_bobs/commit/230269fdfabd
                      html:
                        href: https://bitbucket.org/example-username/bits_and_bobs/commits/230269fdfabd
                    type: commit
                  branch:
                    name: master
                reason: ""
                updated_on: 2018-06-20T23:17:33.616037+00:00
              schema:
                $ref: '#/components/schemas/pullrequest'
          description: The pull request object.
        555:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: |-
            If the decline took too long and timed out.
            In this case the caller should retry the request later.
      security:
      - oauth2:
        - pullrequest:write
      - basic: []
      - api_key: []
      tags:
      - pullrequests
      x-tags:
      - tag: pullrequests
  /users/{username}/pipelines_config/variables/{variable_uuid}:
    delete:
      description: Delete an account level variable.
      operationId: deletePipelineVariableForUser
      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:
          content: {}
          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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    get:
      description: Retrieve a user level variable.
      operationId: getPipelineVariableForUser
      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.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
    put:
      description: Update a user level variable.
      operationId: updatePipelineVariableForUser
      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:
        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 or the variable was not found.
      tags:
      - pipelines
      x-tags:
      - tag: pipelines
components:
  schemas:
    snippet:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A snippet object.
        properties:
          is_private:
            type: boolean
          creator:
            $ref: '#/components/schemas/account'
          scm:
            description: The DVCS used to store the snippet.
            enum:
            - hg
            - git
            type: string
          updated_on:
            format: date-time
            type: string
          id:
            minimum: 0
            type: integer
          created_on:
            format: date-time
            type: string
          title:
            type: string
          owner:
            $ref: '#/components/schemas/account'
        type: object
    pipeline_step_state_pending:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state'
      - description: A Bitbucket Pipelines PENDING pipeline step state.
        properties:
          name:
            description: The name of pipeline step state (PENDING).
            enum:
            - PENDING
            type: string
        type: object
    commit:
      allOf:
      - $ref: '#/components/schemas/base_commit'
      - description: A repository commit object.
        properties:
          participants:
            items:
              $ref: '#/components/schemas/participant'
            minItems: 0
            type: array
          repository:
            $ref: '#/components/schemas/repository'
        type: object
    search_code_search_result:
      example:
        file:
          path: path
          attributes: link
          type: type
        content_matches:
        - lines:
          - line: 1
            segments:
            - match: true
              text: text
            - match: true
              text: text
          - line: 1
            segments:
            - match: true
              text: text
            - match: true
              text: text
        - lines:
          - line: 1
            segments:
            - match: true
              text: text
            - match: true
              text: text
          - line: 1
            segments:
            - match: true
              text: text
            - match: true
              text: text
        content_match_count: 5
        path_matches:
        - match: true
          text: text
        - match: true
          text: text
        type: type
      properties:
        file:
          $ref: '#/components/schemas/commit_file'
        path_matches:
          items:
            $ref: '#/components/schemas/search_segment'
          readOnly: true
          type: array
        type:
          readOnly: true
          type: string
        content_matches:
          items:
            $ref: '#/components/schemas/search_content_match'
          readOnly: true
          type: array
        content_match_count:
          format: int64
          readOnly: true
          type: integer
      type: object
    pipeline_known_host:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Pipelines known host.
        properties:
          public_key:
            $ref: '#/components/schemas/pipeline_ssh_public_key'
          uuid:
            description: The UUID identifying the known host.
            type: string
          hostname:
            description: The hostname of the known host.
            type: string
        type: object
    branching_model_settings:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A repository's branching model settings
        properties:
          development:
            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:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          production:
            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
              enabled:
                description: Indicates if branch is enabled or not.
                type: boolean
            type: object
          branch_types:
            items:
              properties:
                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
                enabled:
                  description: Whether the branch type is enabled or not. A disabled
                    branch type may contain an invalid `prefix`.
                  type: boolean
              required:
              - kind
              type: object
            maxItems: 4
            minItems: 0
            type: array
            uniqueItems: true
        type: object
    paginated_issue_comments:
      description: A paginated list of issue comments.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    repository:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Bitbucket repository.
        properties:
          name:
            type: string
          description:
            type: string
          parent:
            $ref: '#/components/schemas/repository'
          scm:
            enum:
            - hg
            - git
            type: string
          project:
            $ref: '#/components/schemas/project'
          fork_policy:
            description: |2

              Controls the rules for forking this repository.

              * **allow_forks**: unrestricted forking
              * **no_public_forks**: restrict forking to private forks (forks cannot
                be made public later)
              * **no_forks**: deny all forking
            enum:
            - allow_forks
            - no_public_forks
            - no_forks
            type: string
          has_issues:
            type: boolean
          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
          size:
            type: integer
          created_on:
            format: date-time
            type: string
          updated_on:
            format: date-time
            type: string
          owner:
            $ref: '#/components/schemas/account'
          mainbranch:
            $ref: '#/components/schemas/branch'
          language:
            type: string
          has_wiki:
            type: boolean
          is_private:
            type: boolean
          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
          links:
            properties:
              forks:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              downloads:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              clone:
                items:
                  properties:
                    name:
                      type: string
                    href:
                      format: uri
                      type: string
                  type: object
                type: array
              watchers:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              commits:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              avatar:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              hooks:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              pullrequests:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
        type: object
    branch:
      allOf:
      - $ref: '#/components/schemas/ref'
      - description: A branch object, representing a branch in a repository.
        type: object
    deployment_state_completed_status:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: The status of a completed deployment.
        type: object
    pipeline_image:
      description: The definition of a Docker image that can be used for a Bitbucket
        Pipelines step execution context.
      properties:
        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
        email:
          description: The email 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
      type: object
    paginated_diffstats:
      description: A paginated list of diffstats.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - new:
            path: path
            attributes: link
            type: type
          lines_removed: 5
          old:
            path: path
            attributes: link
            type: type
          lines_added: 1
          type: type
          status: added
        - new:
            path: path
            attributes: link
            type: type
          lines_removed: 5
          old:
            path: path
            attributes: link
            type: type
          lines_added: 1
          type: type
          status: added
        page: 1
        pagelen: 1
      properties:
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
        values:
          items:
            $ref: '#/components/schemas/diffstat'
          minItems: 0
          type: array
          uniqueItems: true
        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
      type: object
    pipeline_trigger_push:
      allOf:
      - $ref: '#/components/schemas/pipeline_trigger'
      - description: A Bitbucket Pipelines PUSH trigger.
        type: object
    paginated_refs:
      description: A paginated list of refs.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - name: name
          links:
            commits:
              name: name
              href: http://example.com/aeiou
            self:
              name: name
              href: http://example.com/aeiou
            html:
              name: name
              href: http://example.com/aeiou
          type: type
        - name: name
          links:
            commits:
              name: name
              href: http://example.com/aeiou
            self:
              name: name
              href: http://example.com/aeiou
            html:
              name: name
              href: http://example.com/aeiou
          type: type
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
        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
      type: object
    pipeline_state_in_progress:
      allOf:
      - $ref: '#/components/schemas/pipeline_state'
      - 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'
        type: object
    pipeline_state_completed_error:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_completed_result'
      - description: A Bitbucket Pipelines ERROR pipeline result.
        properties:
          name:
            description: The name of the result (ERROR)
            enum:
            - ERROR
            type: string
          error:
            $ref: '#/components/schemas/pipeline_error'
        type: object
    pipeline_error:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: An error causing a pipeline failure.
        properties:
          message:
            description: The error message.
            type: string
          key:
            description: The error key.
            type: string
        type: object
    paginated_repository_permissions:
      description: A paginated list of repository permissions.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - permission: admin
          type: type
        - permission: admin
          type: type
        page: 1
        pagelen: 1
      properties:
        values:
          items:
            $ref: '#/components/schemas/repository_permission'
          minItems: 0
          type: array
          uniqueItems: true
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    pipeline_ref_target:
      allOf:
      - $ref: '#/components/schemas/pipeline_target'
      - description: A Bitbucket Pipelines reference target.
        properties:
          ref_type:
            description: The type of reference (branch/tag).
            enum:
            - branch
            - tag
            - named_branch
            - bookmark
            type: string
          commit:
            $ref: '#/components/schemas/commit'
          ref_name:
            description: The name of the reference.
            type: string
          selector:
            $ref: '#/components/schemas/pipeline_selector'
        type: object
    paginated_snippet_commit:
      description: A paginated list of snippet commits.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    paginated_branches:
      description: A paginated list of branches.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        values:
          items:
            $ref: '#/components/schemas/branch'
          minItems: 0
          type: array
          uniqueItems: true
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    paginated_snippet_comments:
      description: A paginated list of snippet comments.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    pipeline_trigger:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A representation of the trigger used for a pipeline.
        type: object
    paginated_issues:
      description: A paginated list of issues.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        values:
          items:
            $ref: '#/components/schemas/issue'
          minItems: 0
          type: array
          uniqueItems: true
        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
      type: object
    pipeline_step_state:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: The representation of the progress state of a pipeline step.
        type: object
    issue:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: An issue.
        properties:
          title:
            type: string
          id:
            type: integer
          assignee:
            $ref: '#/components/schemas/user'
          component:
            $ref: '#/components/schemas/component'
          votes:
            type: integer
          repository:
            $ref: '#/components/schemas/repository'
          milestone:
            $ref: '#/components/schemas/milestone'
          reporter:
            $ref: '#/components/schemas/user'
          updated_on:
            format: date-time
            type: string
          created_on:
            format: date-time
            type: string
          priority:
            enum:
            - trivial
            - minor
            - major
            - critical
            - blocker
            type: string
          version:
            $ref: '#/components/schemas/version'
          content:
            properties:
              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
              html:
                description: The user's content rendered as HTML.
                type: string
            type: object
          state:
            enum:
            - new
            - open
            - resolved
            - on hold
            - invalid
            - duplicate
            - wontfix
            - closed
            type: string
          links:
            properties:
              attachments:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              comments:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              watch:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              vote:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          kind:
            enum:
            - bug
            - enhancement
            - proposal
            - task
            type: string
          edited_on:
            format: date-time
            type: string
        type: object
    paginated_ssh_user_keys:
      description: A paginated list of SSH keys.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
        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
      type: object
    commitstatus:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A commit status object.
        properties:
          description:
            description: A description of the build (e.g. "Unit tests in Bamboo")
            type: string
          updated_on:
            format: date-time
            type: string
          refname:
            description: |2-

              The name of the ref that pointed to this commit at the time the status
              object was created. Note that this the ref may since have moved off of
              the commit. This optional field can be useful for build systems whose
              build triggers and configuration are branch-dependent (e.g. a Pipeline
              build).
              It is legitimate for this field to not be set, or even apply (e.g. a
              static linting job).
            type: string
          key:
            description: |-
              An identifier for the status that's unique to
                      its type (current "build" is the only supported type) and the vendor,
                      e.g. BB-DEPLOY
            type: string
          created_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
          name:
            description: An identifier for the build itself, e.g. BB-DEPLOY-1
            type: string
          links:
            properties:
              commit:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          uuid:
            description: The commit status' id.
            type: string
          state:
            description: Provides some indication of the status of this commit
            enum:
            - SUCCESSFUL
            - FAILED
            - INPROGRESS
            - STOPPED
            type: string
        type: object
    snippet_commit:
      allOf:
      - $ref: '#/components/schemas/base_commit'
      - description: ""
        properties:
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              diff:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          snippet:
            $ref: '#/components/schemas/snippet'
        type: object
    version:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A version as defined in a repository's issue tracker.
        properties:
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          id:
            type: integer
          name:
            type: string
        type: object
    issue_change:
      description: An issue change.
      example:
        created_on: 2000-01-23T04:56:07.000+00:00
        changes:
          component:
            new: new
            old: old
          milestone:
            new: new
            old: old
          kind:
            new: new
            old: old
          assignee:
            new: new
            old: old
          state:
            new: new
            old: old
          title:
            new: new
            old: old
          priority:
            new: new
            old: old
          version:
            new: new
            old: old
          content:
            new: new
            old: old
        name: name
        links:
          issue:
            name: name
            href: http://example.com/aeiou
          self:
            name: name
            href: http://example.com/aeiou
        type: type
        message:
          markup: markdown
          raw: raw
          html: html
      properties:
        changes:
          $ref: '#/components/schemas/issue_change_changes'
        type:
          type: string
        name:
          type: string
        created_on:
          format: date-time
          type: string
        issue:
          $ref: '#/components/schemas/issue'
        links:
          $ref: '#/components/schemas/issue_change_links'
        user:
          $ref: '#/components/schemas/user'
        message:
          $ref: '#/components/schemas/issue_change_message'
      required:
      - type
      type: object
    paginated_pullrequests:
      description: A paginated list of pullrequests.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        values:
          items:
            $ref: '#/components/schemas/pullrequest'
          minItems: 0
          type: array
          uniqueItems: true
        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
      type: object
    paginated_pullrequests_commits:
      properties:
        next:
          format: uri
          type: string
        pagelen:
          minimum: 1
          type: integer
        page:
          minimum: 1
          type: integer
        previous:
          format: uri
          type: string
        values:
          items:
            $ref: '#/components/schemas/commit'
          minItems: 0
          type: array
          uniqueItems: true
        size:
          minimum: 0
          type: integer
      type: object
    paginated_tags:
      description: A paginated list of tags.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
        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
      type: object
    paginated_issue_attachments:
      description: A paginated list of issue attachments.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    repository_permission:
      description: A user's permission for a given repository.
      example:
        permission: admin
        type: type
      properties:
        type:
          type: string
        permission:
          enum:
          - admin
          - write
          - read
          type: string
        repository:
          $ref: '#/components/schemas/repository'
        user:
          $ref: '#/components/schemas/user'
      required:
      - type
      type: object
    search_result_page:
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 5
        values:
        - file:
            path: path
            attributes: link
            type: type
          content_matches:
          - lines:
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
          - lines:
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
          content_match_count: 5
          path_matches:
          - match: true
            text: text
          - match: true
            text: text
          type: type
        - file:
            path: path
            attributes: link
            type: type
          content_matches:
          - lines:
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
          - lines:
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
            - line: 1
              segments:
              - match: true
                text: text
              - match: true
                text: text
          content_match_count: 5
          path_matches:
          - match: true
            text: text
          - match: true
            text: text
          type: type
        query_substituted: true
        page: 6
        pagelen: 0
      properties:
        next:
          format: uri
          readOnly: true
          type: string
        pagelen:
          format: int32
          readOnly: true
          type: integer
        previous:
          format: uri
          readOnly: true
          type: string
        page:
          format: int32
          readOnly: true
          type: integer
        values:
          items:
            $ref: '#/components/schemas/search_code_search_result'
          readOnly: true
          type: array
        size:
          format: int64
          readOnly: true
          type: integer
        query_substituted:
          readOnly: true
          type: boolean
      type: object
    issue_change_message:
      example:
        markup: markdown
        raw: raw
        html: html
      properties:
        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
        html:
          description: The user's content rendered as HTML.
          type: string
    ssh_key:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: Base type for representing SSH public keys.
        properties:
          last_used:
            format: date-time
            type: string
          key:
            description: The SSH public key value in OpenSSH format.
            type: string
          comment:
            description: The comment parsed from the SSH key (if present)
            type: string
          created_on:
            format: date-time
            type: string
          uuid:
            description: The SSH key's immutable ID.
            type: string
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          label:
            description: The user-defined label for the SSH key
            type: string
        type: object
    pipeline_build_number:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Pipelines build number.
        properties:
          next:
            description: The next number that will be used as build number.
            type: integer
        type: object
    pipeline_step_state_in_progress:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state'
      - 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_state_in_progress_stage:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A result of an in progress pipeline state.
        type: object
    hook_event:
      description: An event, associated with a resource or subject type.
      example:
        description: description
        label: label
        event: pullrequest:unapproved
        category: category
      properties:
        event:
          description: The event identifier.
          enum:
          - pullrequest:unapproved
          - issue:comment_created
          - pullrequest:approved
          - repo:created
          - repo:deleted
          - repo:imported
          - pullrequest:comment_updated
          - issue:updated
          - project:updated
          - pullrequest:comment_created
          - repo:commit_status_updated
          - pullrequest:updated
          - issue:created
          - repo:fork
          - pullrequest:comment_deleted
          - repo:commit_status_created
          - repo:updated
          - pullrequest:rejected
          - pullrequest:fulfilled
          - repo:push
          - pullrequest:created
          - repo:transfer
          - repo:commit_comment_created
          type: string
        description:
          description: More detailed description of the webhook event type.
          type: string
        category:
          description: The category this event belongs to.
          type: string
        label:
          description: Summary of the webhook event type.
          type: string
      type: object
    paginated_deploy_keys:
      description: A paginated list of deploy keys.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    pipeline_state_pending:
      allOf:
      - $ref: '#/components/schemas/pipeline_state'
      - description: A Bitbucket Pipelines PENDING pipeline state.
        properties:
          name:
            description: The name of pipeline state (PENDING).
            enum:
            - PENDING
            type: string
        type: object
    object:
      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
    paginated_environments:
      description: A paged list of environments
      example:
        next: http://example.com/aeiou
        size: 6
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 0
      properties:
        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
        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
        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
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/deployment_environment'
          minItems: 0
          type: array
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          type: integer
      type: object
    deployment_state_in_progress:
      allOf:
      - $ref: '#/components/schemas/deployment_state'
      - description: A Bitbucket Deployment IN_PROGRESS deployment state.
        properties:
          name:
            description: The name of deployment state (IN_PROGRESS).
            enum:
            - IN_PROGRESS
            type: string
          url:
            description: Link to the deployment result.
            format: uri
            type: string
          start_date:
            description: The timestamp when the deployment was started.
            format: date-time
            type: string
          deployer:
            $ref: '#/components/schemas/account'
        type: object
    pipeline_schedule:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Pipelines schedule.
        properties:
          created_on:
            description: The timestamp when the schedule was created.
            format: date-time
            type: string
          target:
            $ref: '#/components/schemas/pipeline_target'
          updated_on:
            description: The timestamp when the schedule was updated.
            format: date-time
            type: string
          enabled:
            description: Whether the schedule is enabled.
            type: boolean
          selector:
            $ref: '#/components/schemas/pipeline_selector'
          cron_pattern:
            description: The cron expression that the schedule applies.
            type: string
          uuid:
            description: The UUID identifying the schedule.
            type: string
        type: object
    ref_links:
      example:
        commits:
          name: name
          href: http://example.com/aeiou
        self:
          name: name
          href: http://example.com/aeiou
        html:
          name: name
          href: http://example.com/aeiou
      properties:
        commits:
          $ref: '#/components/schemas/issue_change_links_issue'
        self:
          $ref: '#/components/schemas/issue_change_links_issue'
        html:
          $ref: '#/components/schemas/issue_change_links_issue'
    paginated_milestones:
      description: A paginated list of issue tracker milestones.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        values:
          items:
            $ref: '#/components/schemas/milestone'
          minItems: 0
          type: array
          uniqueItems: true
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
      type: object
    pipeline_ssh_public_key:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Pipelines known host public key.
        properties:
          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
          key:
            description: The base64 encoded public key.
            type: string
          key_type:
            description: The type of the public key.
            type: string
        type: object
    paginated_users:
      description: A paginated list of users.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
        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/user'
          minItems: 0
          type: array
          uniqueItems: true
      type: object
    paginated_log_entries:
      description: A paginated list of issue changes.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - created_on: 2000-01-23T04:56:07.000+00:00
          changes:
            component:
              new: new
              old: old
            milestone:
              new: new
              old: old
            kind:
              new: new
              old: old
            assignee:
              new: new
              old: old
            state:
              new: new
              old: old
            title:
              new: new
              old: old
            priority:
              new: new
              old: old
            version:
              new: new
              old: old
            content:
              new: new
              old: old
          name: name
          links:
            issue:
              name: name
              href: http://example.com/aeiou
            self:
              name: name
              href: http://example.com/aeiou
          type: type
          message:
            markup: markdown
            raw: raw
            html: html
        - created_on: 2000-01-23T04:56:07.000+00:00
          changes:
            component:
              new: new
              old: old
            milestone:
              new: new
              old: old
            kind:
              new: new
              old: old
            assignee:
              new: new
              old: old
            state:
              new: new
              old: old
            title:
              new: new
              old: old
            priority:
              new: new
              old: old
            version:
              new: new
              old: old
            content:
              new: new
              old: old
          name: name
          links:
            issue:
              name: name
              href: http://example.com/aeiou
            self:
              name: name
              href: http://example.com/aeiou
          type: type
          message:
            markup: markdown
            raw: raw
            html: html
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    paginated_pipeline_steps:
      description: A paged list of pipeline steps.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 6
        values:
        - null
        - null
        page: 0
        pagelen: 1
      properties:
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          type: integer
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/pipeline_step'
          minItems: 0
          type: array
        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
        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
        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
      type: object
    pipeline_state_completed_expired:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_completed_result'
      - description: A Bitbucket Pipelines EXPIRED pipeline result.
        properties:
          name:
            description: The name of the stopped result (EXPIRED).
            enum:
            - EXPIRED
            type: string
        type: object
    paginated_commit_comments:
      description: A paginated list of commit comments.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
      type: object
    deployment:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Bitbucket Deployment.
        properties:
          environment:
            $ref: '#/components/schemas/deployment_environment'
          state:
            $ref: '#/components/schemas/deployment_state'
          release:
            $ref: '#/components/schemas/deployment_release'
          uuid:
            description: The UUID identifying the deployment.
            type: string
        type: object
    pipeline_step:
      allOf:
      - $ref: '#/components/schemas/object'
      - 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'
          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'
          script_commands:
            description: The list of build commands. These commands are executed in
              the build container.
            items:
              $ref: '#/components/schemas/pipeline_command'
            type: array
          uuid:
            description: The UUID identifying the step.
            type: string
        type: object
      x-bb-default-fields:
      - uuid
      x-bb-url: /rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}
    pullrequest:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A pull request object.
        properties:
          state:
            description: The pull request's current status.
            enum:
            - MERGED
            - SUPERSEDED
            - OPEN
            - DECLINED
            type: string
          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
          close_source_branch:
            description: A boolean flag indicating if merging the pull request closes
              the source branch.
            type: boolean
          links:
            properties:
              comments:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              activity:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              approve:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              merge:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              decline:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              commits:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              diff:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          destination:
            $ref: '#/components/schemas/pullrequest_endpoint'
          created_on:
            description: The ISO8601 timestamp the request was created.
            format: date-time
            type: string
          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
          updated_on:
            description: The ISO8601 timestamp the request was last updated.
            format: date-time
            type: string
          reason:
            description: Explains why a pull request was declined. This field is only
              applicable to pull requests in rejected state.
            type: string
          author:
            $ref: '#/components/schemas/account'
          comment_count:
            description: The number of comments for a specific pull request.
            minimum: 0
            type: integer
          task_count:
            description: The number of open tasks for a specific pull request.
            minimum: 0
            type: integer
          closed_by:
            $ref: '#/components/schemas/account'
          rendered:
            properties:
              reason:
                properties:
                  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
                  html:
                    description: The user's content rendered as HTML.
                    type: string
                type: object
              description:
                properties:
                  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
                  html:
                    description: The user's content rendered as HTML.
                    type: string
                type: object
              title:
                properties:
                  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
                  html:
                    description: The user's content rendered as HTML.
                    type: string
                type: object
            type: object
          summary:
            properties:
              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
              html:
                description: The user's content rendered as HTML.
                type: string
            type: object
          id:
            description: The pull request's unique ID. Note that pull request IDs
              are only unique within their associated repository.
            type: integer
          title:
            description: Title of the pull request.
            type: string
          merge_commit:
            properties:
              hash:
                pattern: '[0-9a-f]{7,}?'
                type: string
            type: object
          source:
            $ref: '#/components/schemas/pullrequest_endpoint'
        type: object
    error_error:
      example:
        data: '{}'
        detail: detail
        message: message
      properties:
        data:
          description: Optional structured data that is endpoint-specific.
          properties: {}
          type: object
        detail:
          type: string
        message:
          type: string
      required:
      - message
    search_content_match:
      example:
        lines:
        - line: 1
          segments:
          - match: true
            text: text
          - match: true
            text: text
        - line: 1
          segments:
          - match: true
            text: text
          - match: true
            text: text
      properties:
        lines:
          items:
            $ref: '#/components/schemas/search_line'
          readOnly: true
          type: array
      type: object
    pipeline_ssh_key_pair:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Pipelines SSH key pair.
        properties:
          public_key:
            description: The SSH public key.
            type: string
          private_key:
            description: The SSH private key. This value will be empty when retrieving
              the SSH key pair.
            type: string
        type: object
    paginated_snippets:
      description: A paginated list of snippets.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    ssh_account_key:
      allOf:
      - $ref: '#/components/schemas/ssh_key'
      - description: Represents an SSH public key for a user.
        properties:
          owner:
            $ref: '#/components/schemas/account'
        type: object
    pullrequest_endpoint_branch:
      properties:
        default_merge_strategy:
          description: The default merge strategy, when this endpoint is the destination
            of the pull request.
          type: string
        name:
          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
    paginated_pipeline_known_hosts:
      description: A paged list of known hosts.
      example:
        next: http://example.com/aeiou
        size: 6
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 0
      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
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/pipeline_known_host'
          minItems: 0
          type: array
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
      type: object
    team:
      allOf:
      - $ref: '#/components/schemas/account'
      - description: A team object.
        type: object
    deployment_environment:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Bitbucket Deployment Environment.
        properties:
          name:
            description: The name of the environment.
            type: string
          uuid:
            description: The UUID identifying the environment.
            type: string
        type: object
    deployment_state:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: The representation of the progress state of a deployment.
        type: object
    pipeline_state_completed:
      allOf:
      - $ref: '#/components/schemas/pipeline_state'
      - description: A Bitbucket Pipelines COMPLETED pipeline state.
        properties:
          result:
            $ref: '#/components/schemas/pipeline_state_completed_result'
          name:
            description: The name of pipeline state (COMPLETED).
            enum:
            - COMPLETED
            type: string
        type: object
    pipeline:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Bitbucket Pipeline. This represents an actual pipeline result.
        properties:
          created_on:
            description: The timestamp when the pipeline was created.
            format: date-time
            type: string
          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
          target:
            $ref: '#/components/schemas/pipeline_target'
          build_number:
            description: The build number of the pipeline.
            type: integer
          state:
            $ref: '#/components/schemas/pipeline_state'
          build_seconds_used:
            description: The number of build seconds used by this pipeline.
            type: integer
          repository:
            $ref: '#/components/schemas/repository'
          creator:
            $ref: '#/components/schemas/account'
          uuid:
            description: The UUID identifying the pipeline.
            type: string
          trigger:
            $ref: '#/components/schemas/pipeline_trigger'
        type: object
    component:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A component as defined in a repository's issue tracker.
        properties:
          name:
            type: string
          id:
            type: integer
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
        type: object
    deployment_state_completed:
      allOf:
      - $ref: '#/components/schemas/deployment_state'
      - description: A Bitbucket Deployment COMPLETED deployment state.
        properties:
          deployer:
            $ref: '#/components/schemas/account'
          url:
            description: Link to the deployment result.
            format: uri
            type: string
          name:
            description: The name of deployment state (COMPLETED).
            enum:
            - COMPLETED
            type: string
          completion_date:
            description: The timestamp when the deployment completed.
            format: date-time
            type: string
          status:
            $ref: '#/components/schemas/deployment_state_completed_status'
          start_date:
            description: The timestamp when the deployment was started.
            format: date-time
            type: string
        type: object
    pipeline_step_state_completed_successful:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state_completed_result'
      - description: A Bitbucket Pipelines SUCCESSFUL pipeline step result.
        properties:
          name:
            description: The name of the result (SUCCESSFUL)
            enum:
            - SUCCESSFUL
            type: string
        type: object
    deployment_state_completed_status_stopped:
      allOf:
      - $ref: '#/components/schemas/deployment_state_completed_status'
      - description: A STOPPED completed deployment status.
        properties:
          name:
            description: The name of the completed deployment status (STOPPED).
            enum:
            - STOPPED
            type: string
        type: object
    pipeline_step_state_ready:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state'
      - description: A Bitbucket Pipelines READY pipeline step state.
        properties:
          name:
            description: The name of pipeline step state (READY).
            enum:
            - READY
            type: string
        type: object
    paginated_deployments:
      description: A paged list of deployments
      example:
        next: http://example.com/aeiou
        size: 6
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 0
      properties:
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/deployment'
          minItems: 0
          type: array
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          type: integer
      type: object
    pipeline_step_state_completed_not_run:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state_completed_result'
      - 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
    search_segment:
      example:
        match: true
        text: text
      properties:
        text:
          readOnly: true
          type: string
        match:
          readOnly: true
          type: boolean
      type: object
    paginated_team_permissions:
      description: A paginated list of team permissions.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - permission: admin
          type: type
        - permission: admin
          type: type
        page: 1
        pagelen: 1
      properties:
        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/team_permission'
          minItems: 0
          type: array
          uniqueItems: true
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
      type: object
    deployment_state_completed_status_failed:
      allOf:
      - $ref: '#/components/schemas/deployment_state_completed_status'
      - description: A FAILED completed deployment status.
        properties:
          name:
            description: The name of the completed deployment status (FAILED).
            enum:
            - FAILED
            type: string
        type: object
    paginated_versions:
      description: A paginated list of issue tracker versions.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
        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
        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
        values:
          items:
            $ref: '#/components/schemas/version'
          minItems: 0
          type: array
          uniqueItems: true
        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
      type: object
    pipeline_step_state_completed_expired:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state_completed_result'
      - description: A Bitbucket Pipelines EXPIRED pipeline step result.
        properties:
          name:
            description: The name of the result (EXPIRED)
            enum:
            - EXPIRED
            type: string
        type: object
    subject_types:
      description: The mapping of resource/subject types pointing to their individual
        event types.
      example:
        team:
          events:
            name: name
            href: http://example.com/aeiou
        repository:
          events:
            name: name
            href: http://example.com/aeiou
        user:
          events:
            name: name
            href: http://example.com/aeiou
      properties:
        repository:
          $ref: '#/components/schemas/subject_types_repository'
        user:
          $ref: '#/components/schemas/subject_types_repository'
        team:
          $ref: '#/components/schemas/subject_types_repository'
      type: object
    issue_change_links:
      example:
        issue:
          name: name
          href: http://example.com/aeiou
        self:
          name: name
          href: http://example.com/aeiou
      properties:
        issue:
          $ref: '#/components/schemas/issue_change_links_issue'
        self:
          $ref: '#/components/schemas/issue_change_links_issue'
    pipeline_variable:
      allOf:
      - $ref: '#/components/schemas/object'
      - 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
          value:
            description: The value of the variable. If the variable is secured, this
              will be empty.
            type: string
          uuid:
            description: The UUID identifying the variable.
            type: string
        type: object
    project:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: |-
          A Bitbucket project.
                      Projects are used by teams to organize repositories.
        properties:
          updated_on:
            format: date-time
            type: string
          created_on:
            format: date-time
            type: string
          name:
            description: The name of the project.
            type: string
          key:
            description: The project's key.
            type: string
          description:
            type: string
          owner:
            $ref: '#/components/schemas/team'
          is_private:
            description: |2-

              Indicates whether the project is publicly accessible, or whether it is
              private to the team and consequently only visible to team members.
              Note that private projects cannot contain public repositories.
            type: boolean
          links:
            properties:
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              avatar:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          uuid:
            description: The project's immutable id.
            type: string
        type: object
    participant:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: Object describing a user's role on resources like commits or
          pull requests.
        properties:
          user:
            $ref: '#/components/schemas/user'
          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
          approved:
            type: boolean
          role:
            enum:
            - PARTICIPANT
            - REVIEWER
            type: string
        type: object
    issue_change_changes:
      example:
        component:
          new: new
          old: old
        milestone:
          new: new
          old: old
        kind:
          new: new
          old: old
        assignee:
          new: new
          old: old
        state:
          new: new
          old: old
        title:
          new: new
          old: old
        priority:
          new: new
          old: old
        version:
          new: new
          old: old
        content:
          new: new
          old: old
      properties:
        component:
          $ref: '#/components/schemas/issue_change_changes_component'
        milestone:
          $ref: '#/components/schemas/issue_change_changes_component'
        kind:
          $ref: '#/components/schemas/issue_change_changes_component'
        assignee:
          $ref: '#/components/schemas/issue_change_changes_component'
        state:
          $ref: '#/components/schemas/issue_change_changes_component'
        title:
          $ref: '#/components/schemas/issue_change_changes_component'
        priority:
          $ref: '#/components/schemas/issue_change_changes_component'
        version:
          $ref: '#/components/schemas/issue_change_changes_component'
        content:
          $ref: '#/components/schemas/issue_change_changes_component'
    ref:
      description: A ref object, representing a branch or tag in a repository.
      example:
        name: name
        links:
          commits:
            name: name
            href: http://example.com/aeiou
          self:
            name: name
            href: http://example.com/aeiou
          html:
            name: name
            href: http://example.com/aeiou
        type: type
      properties:
        name:
          description: The name of the ref.
          type: string
        target:
          $ref: '#/components/schemas/commit'
        type:
          type: string
        links:
          $ref: '#/components/schemas/ref_links'
      required:
      - type
      type: object
    deploy_key:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: Represents deploy key for a repository.
        properties:
          added_on:
            format: date-time
            type: string
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          label:
            description: The user-defined label for the deploy key
            type: string
          repository:
            $ref: '#/components/schemas/repository'
          last_used:
            format: date-time
            type: string
          owner:
            $ref: '#/components/schemas/account'
          key:
            description: The deploy key value.
            type: string
          comment:
            description: The comment parsed from the deploy key (if present)
            type: string
        type: object
    deployment_state_undeployed:
      allOf:
      - $ref: '#/components/schemas/deployment_state'
      - 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
    commit_file:
      description: A file object, representing a file at a commit in a repository
      example:
        path: path
        attributes: link
        type: type
      properties:
        attributes:
          enum:
          - link
          - executable
          - subrepository
          - binary
          - lfs
          type: string
        type:
          type: string
        commit:
          $ref: '#/components/schemas/commit'
        path:
          description: The path in the repository
          type: string
      required:
      - type
      type: object
    paginated_pipeline_variables:
      description: A paged list of variables.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 6
      properties:
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/pipeline_variable'
          minItems: 0
          type: array
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
      type: object
    pipeline_step_state_completed_result:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A result of a completed pipeline step state.
        type: object
    pipeline_state_completed_result:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A result of a completed pipeline state.
        type: object
    tag:
      allOf:
      - $ref: '#/components/schemas/ref'
      - description: A tag object, representing a tag in a repository.
        properties:
          tagger:
            $ref: '#/components/schemas/author'
          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
        type: object
    paginated_components:
      description: A paginated list of issue tracker components.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    diffstat:
      description: A diffstat object that includes a summary of changes made to a
        file between two commits.
      example:
        new:
          path: path
          attributes: link
          type: type
        lines_removed: 5
        old:
          path: path
          attributes: link
          type: type
        lines_added: 1
        type: type
        status: added
      properties:
        lines_added:
          type: integer
        old:
          $ref: '#/components/schemas/commit_file'
        type:
          type: string
        status:
          enum:
          - added
          - removed
          - modified
          - renamed
          type: string
        lines_removed:
          type: integer
        new:
          $ref: '#/components/schemas/commit_file'
      required:
      - type
      type: object
    issue_attachment:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: An issue file attachment's meta data. Note this does not contain
          the file's actual contents.
        properties:
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          name:
            type: string
        type: object
    pipelines_config:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: The Pipelines configuration for a repository.
        properties:
          enabled:
            description: Whether Pipelines is enabled for the repository.
            type: boolean
          repository:
            $ref: '#/components/schemas/repository'
        type: object
    pipeline_schedule_execution_errored:
      allOf:
      - $ref: '#/components/schemas/pipeline_schedule_execution'
      - description: A Pipelines schedule execution that failed to be executed.
        properties:
          error:
            $ref: '#/components/schemas/pipeline_error'
        type: object
    issue_change_links_issue:
      example:
        name: name
        href: http://example.com/aeiou
      properties:
        name:
          type: string
        href:
          format: uri
          type: string
    group:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A group object
        properties:
          members:
            description: The number of members in this group
            type: integer
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          slug:
            description: |-
              The "sluggified" version of the group's name. This contains only ASCII
              characters and can therefore be slightly different than the name
            type: string
          full_slug:
            description: |
              The concatenation of the owner's username and the group's slug,
              separated with a colon (e.g. `acme:developers`)
            type: string
          name:
            type: string
          owner:
            $ref: '#/components/schemas/account'
        type: object
    pipeline_step_state_completed:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state'
      - description: A Bitbucket Pipelines COMPLETED pipeline step state.
        properties:
          result:
            $ref: '#/components/schemas/pipeline_step_state_completed_result'
          name:
            description: The name of pipeline step state (COMPLETED).
            enum:
            - COMPLETED
            type: string
        type: object
    paginated_webhook_subscriptions:
      description: A paginated list of webhook subscriptions
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        values:
          items:
            $ref: '#/components/schemas/webhook_subscription'
          minItems: 0
          type: array
          uniqueItems: true
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
      type: object
    paginated_pipeline_schedules:
      description: A paged list of schedules
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 6
      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
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/pipeline_schedule'
          minItems: 0
          type: array
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          type: integer
      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
      type: object
    pullrequest_endpoint_commit:
      properties:
        hash:
          pattern: '[0-9a-f]{7,}?'
          type: string
    pipeline_step_state_completed_failed:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state_completed_result'
      - description: A Bitbucket Pipelines FAILED pipeline step result.
        properties:
          name:
            description: The name of the result (FAILED)
            enum:
            - FAILED
            type: string
        type: object
    author:
      allOf:
      - $ref: '#/components/schemas/object'
      - 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'
        type: object
    paginated_branchrestrictions:
      description: A paginated list of branch restriction rules.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    pipeline_selector:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A representation of the selector that was used to identify the
          pipeline in the YML file. branches, tags, bookmarks, default, custom
        type: string
    treeentry:
      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`.
      example:
        path: path
        type: type
      properties:
        path:
          description: The path in the repository
          type: string
        commit:
          $ref: '#/components/schemas/commit'
        type:
          type: string
      required:
      - type
      type: object
    snippet_comment:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A comment on a snippet.
        properties:
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          snippet:
            $ref: '#/components/schemas/snippet'
        type: object
    paginated_hook_events:
      description: A paginated list of webhook types available to subscribe on.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - description: description
          label: label
          event: pullrequest:unapproved
          category: category
        - description: description
          label: label
          event: pullrequest:unapproved
          category: category
        page: 1
        pagelen: 1
      properties:
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
        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
      type: object
    pipeline_state_completed_failed:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_completed_result'
      - description: A Bitbucket Pipelines FAILED pipeline result.
        properties:
          name:
            description: The name of the failed result (FAILED).
            enum:
            - FAILED
            type: string
        type: object
    paginated_projects:
      description: A paginated list of projects
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    pipeline_state:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: The representation of the progress state of a pipeline.
        type: object
    pipeline_state_completed_successful:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_completed_result'
      - description: A Bitbucket Pipelines SUCCESSFUL pipeline result.
        properties:
          name:
            description: The name of the successful result (SUCCESSFUL).
            enum:
            - SUCCESSFUL
            type: string
        type: object
    issue_job_status:
      description: The status of an import or export job
      example:
        phase: phase
        pct: 14.6581298050294517310021547018550336360931396484375
        total: 6
        count: 0
        type: type
        status: ACCEPTED
      properties:
        count:
          description: The total number of issues already imported/exported
          type: integer
        type:
          type: string
        total:
          description: The total number of issues being imported/exported
          type: integer
        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
        pct:
          description: The percentage of issues already imported/exported
          maximum: 1E+2
          minimum: 0
          type: number
      type: object
    commit_comment:
      allOf:
      - $ref: '#/components/schemas/comment'
      - description: A commit comment.
        properties:
          commit:
            $ref: '#/components/schemas/commit'
        type: object
    pipelines_ddev_pipeline_step:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A step of a Bitbucket pipeline. This represents the actual result
          of the step execution.
        type: object
      x-bb-url: /rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}
      x-bb-default-fields:
      - uuid
    page:
      properties:
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
        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
      type: object
    webhook_subscription:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Webhook subscription.
        properties:
          subject_type:
            description: The type of entity, which is `repository` in the case of
              webhook subscriptions on repositories.
            enum:
            - user
            - repository
            - team
            type: string
          active:
            type: boolean
          uuid:
            description: The webhook's id
            type: string
          created_at:
            format: date-time
            type: string
          url:
            description: The URL events get delivered to.
            format: uri
            type: string
          events:
            description: The events this webhook is subscribed to.
            items:
              enum:
              - pullrequest:unapproved
              - issue:comment_created
              - pullrequest:approved
              - repo:created
              - repo:deleted
              - repo:imported
              - pullrequest:comment_updated
              - issue:updated
              - project:updated
              - pullrequest:comment_created
              - repo:commit_status_updated
              - pullrequest:updated
              - issue:created
              - repo:fork
              - pullrequest:comment_deleted
              - repo:commit_status_created
              - repo:updated
              - pullrequest:rejected
              - pullrequest:fulfilled
              - repo:push
              - pullrequest:created
              - repo:transfer
              - repo:commit_comment_created
              type: string
            minItems: 1
            type: array
            uniqueItems: true
          subject:
            $ref: '#/components/schemas/object'
          description:
            description: A user-defined description of the webhook.
            type: string
        type: object
    base_commit:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: The common base type for both repository and snippet commits.
        properties:
          parents:
            items:
              $ref: '#/components/schemas/base_commit'
            minItems: 0
            type: array
          date:
            format: date-time
            type: string
          message:
            type: string
          summary:
            properties:
              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
              html:
                description: The user's content rendered as HTML.
                type: string
            type: object
          author:
            $ref: '#/components/schemas/author'
          hash:
            pattern: '[0-9a-f]{7,}?'
            type: string
        type: object
    activity:
      properties:
        comment:
          $ref: '#/components/schemas/comment'
    paginated_activities:
      description: A paged list of activities
      properties:
        page:
          type: integer
        previous:
          format: uri
          type: string
        pagelen:
          type: integer
        size:
          type: integer
        next:
          format: uri
          type: string
        values:
          items:
            $ref: '#/components/schemas/activity'
          minItems: 0
          type: array
      type: object
    paginated_pipelines:
      description: A paged list of pipelines
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 1
        values:
        - null
        - null
        page: 0
        pagelen: 6
      properties:
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
        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
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/pipeline'
          minItems: 0
          type: array
      type: object
    subject_types_repository:
      example:
        events:
          name: name
          href: http://example.com/aeiou
      properties:
        events:
          $ref: '#/components/schemas/issue_change_links_issue'
    team_permission:
      description: A user's permission for a given team.
      example:
        permission: admin
        type: type
      properties:
        team:
          $ref: '#/components/schemas/team'
        type:
          type: string
        permission:
          enum:
          - admin
          - collaborator
          type: string
        user:
          $ref: '#/components/schemas/user'
      required:
      - type
      type: object
    pipeline_schedule_execution:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Pipelines schedule execution.
        type: object
    error:
      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`.
      example:
        error:
          data: '{}'
          detail: detail
          message: message
        type: type
      properties:
        error:
          $ref: '#/components/schemas/error_error'
        type:
          type: string
      required:
      - type
      type: object
    pipeline_step_state_completed_error:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state_completed_result'
      - description: A Bitbucket Pipelines ERROR pipeline step result.
        properties:
          name:
            description: The name of the result (ERROR)
            enum:
            - ERROR
            type: string
          error:
            $ref: '#/components/schemas/pipeline_step_error'
        type: object
    pipeline_commit_target:
      allOf:
      - $ref: '#/components/schemas/pipeline_target'
      - description: A Bitbucket Pipelines commit target.
        properties:
          selector:
            $ref: '#/components/schemas/pipeline_selector'
          commit:
            $ref: '#/components/schemas/commit'
        type: object
    pipeline_state_in_progress_running:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_in_progress_stage'
      - 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
    branchrestriction:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A branch restriction rule.
        properties:
          pattern:
            description: Apply the restriction to branches that match this pattern.
              Active when `branch_match_kind` is `glob`. Will be empty when `branch_match_kind`
              is `branching_model`.
            type: string
          kind:
            description: The type of restriction that is being applied.
            enum:
            - require_tasks_to_be_completed
            - require_passing_builds_to_merge
            - force
            - require_all_dependencies_merged
            - push
            - require_approvals_to_merge
            - enforce_merge_checks
            - restrict_merges
            - reset_pullrequest_approvals_on_change
            - delete
            type: string
          branch_match_kind:
            description: Indicates how the restriction is matched against a branch.
              The default is `glob`.
            enum:
            - branching_model
            - glob
            type: string
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          branch_type:
            description: Apply the restriction to branches of this type. Active when
              `branch_match_kind` is `branching_model`. The branch type will be calculated
              using the branching model configured for the repository.
            enum:
            - feature
            - bugfix
            - release
            - hotfix
            - development
            - production
            type: string
          users:
            items:
              $ref: '#/components/schemas/account'
            minItems: 0
            type: array
          id:
            description: The branch restriction status' id.
            type: integer
          groups:
            items:
              $ref: '#/components/schemas/group'
            minItems: 0
            type: array
          value:
            description: 'Value with kind-specific semantics: "require_approvals_to_merge"
              uses it to require a minimum number of approvals on a PR; "require_passing_builds_to_merge"
              uses it to require a minimum number of passing builds.'
            type: integer
        required:
        - branch_match_kind
        - kind
        - pattern
        type: object
    deployment_state_completed_status_successful:
      allOf:
      - $ref: '#/components/schemas/deployment_state_completed_status'
      - description: A SUCCESSFUL completed deployment status.
        properties:
          name:
            description: The name of the completed deployment status (SUCCESSFUL).
            enum:
            - SUCCESSFUL
            type: string
        type: object
    branching_model:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A repository's branching model
        properties:
          branch_types:
            description: The active branch types.
            items:
              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
          production:
            properties:
              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
              branch:
                $ref: '#/components/schemas/branch'
            required:
            - name
            - use_mainbranch
            type: object
          development:
            properties:
              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
              branch:
                $ref: '#/components/schemas/branch'
            required:
            - name
            - use_mainbranch
            type: object
        type: object
    paginated_pipeline_schedule_executions:
      description: A paged list of the executions of a schedule.
      example:
        next: http://example.com/aeiou
        size: 6
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 0
      properties:
        values:
          description: The values of the current page.
          items:
            $ref: '#/components/schemas/pipeline_schedule_execution'
          minItems: 0
          type: array
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
      type: object
    pipeline_step_error:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: An error causing a step failure.
        properties:
          message:
            description: The error message.
            type: string
          key:
            description: The error key.
            type: string
        type: object
    pipeline_target:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A representation of the target that a pipeline executes on.
        type: object
    pipeline_schedule_execution_executed:
      allOf:
      - $ref: '#/components/schemas/pipeline_schedule_execution'
      - description: A Pipelines executed schedule execution.
        properties:
          pipeline:
            $ref: '#/components/schemas/pipeline'
        type: object
    paginated_files:
      description: A paginated list of commit_file objects.
      example:
        next: http://example.com/aeiou
        previous: http://example.com/aeiou
        size: 0
        values:
        - path: path
          attributes: link
          type: type
        - path: path
          attributes: link
          type: type
        page: 1
        pagelen: 1
      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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        values:
          items:
            $ref: '#/components/schemas/commit_file'
          minItems: 0
          type: array
          uniqueItems: true
        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
      type: object
    pipeline_trigger_manual:
      allOf:
      - $ref: '#/components/schemas/pipeline_trigger'
      - description: A Bitbucket Pipelines MANUAL trigger.
        type: object
    paginated_teams:
      description: A paginated list of teams.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        values:
          items:
            $ref: '#/components/schemas/team'
          minItems: 0
          type: array
          uniqueItems: true
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    paginated_repositories:
      description: A paginated list of repositories.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          minimum: 1
          type: integer
      type: object
    pipeline_state_in_progress_paused:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_in_progress_stage'
      - 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
    search_line:
      example:
        line: 1
        segments:
        - match: true
          text: text
        - match: true
          text: text
      properties:
        segments:
          items:
            $ref: '#/components/schemas/search_segment'
          readOnly: true
          type: array
        line:
          format: int32
          readOnly: true
          type: integer
      type: object
    milestone:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A milestone as defined in a repository's issue tracker.
        properties:
          links:
            properties:
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          name:
            type: string
          id:
            type: integer
        type: object
    issue_comment:
      allOf:
      - $ref: '#/components/schemas/comment'
      - description: A issue comment.
        properties:
          issue:
            $ref: '#/components/schemas/issue'
        type: object
    issue_change_changes_component:
      example:
        new: new
        old: old
      properties:
        new:
          type: string
        old:
          type: string
    deployment_release:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A Bitbucket Deployment Release.
        properties:
          uuid:
            description: The UUID identifying the release.
            type: string
          commit:
            $ref: '#/components/schemas/commit'
          created_on:
            description: The timestamp when the release was created.
            format: date-time
            type: string
          url:
            description: Link to the pipeline that produced the release.
            format: uri
            type: string
          name:
            description: The name of the release.
            type: string
        type: object
    pipeline_step_state_completed_stopped:
      allOf:
      - $ref: '#/components/schemas/pipeline_step_state_completed_result'
      - description: A Bitbucket Pipelines STOPPED pipeline step result.
        properties:
          name:
            description: The name of the result (STOPPED)
            enum:
            - STOPPED
            type: string
        type: object
    pipelines_stg_west_pipeline_step:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: A step of a Bitbucket pipeline. This represents the actual result
          of the step execution.
        type: object
      x-bb-default-fields:
      - uuid
      x-bb-url: /rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}
    pipeline_state_completed_stopped:
      allOf:
      - $ref: '#/components/schemas/pipeline_state_completed_result'
      - description: A Bitbucket Pipelines STOPPED pipeline result.
        properties:
          name:
            description: The name of the stopped result (STOPPED).
            enum:
            - STOPPED
            type: string
        type: object
    paginated_treeentries:
      description: A paginated list of commit_file and/or commit_directory objects.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - path: path
          type: type
        - path: path
          type: type
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    comment_content:
      properties:
        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
        html:
          description: The user's content rendered as HTML.
          type: string
        type: object
    comment_inline:
      properties:
        path:
          description: The path of the file this comment is anchored to.
          type: string
        from:
          description: The comment's anchor line in the old version of the file.
          minimum: 1
          type: integer
        to:
          description: The comment's anchor line in the new version of the file.
          minimum: 1
          type: integer
        required:
          - path
        type: object
    comment:
      allOf:
      - $ref: '#/components/schemas/object'
      - 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:
          links:
            properties:
              code:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          inline:
            $ref: '#/components/schemas/comment_inline'
          parent:
            $ref: '#/components/schemas/comment'
          user:
            $ref: '#/components/schemas/user'
          content:
            $ref: '#/components/schemas/comment_content'
          deleted:
            type: boolean
          id:
            type: integer
          created_on:
            format: date-time
            type: string
          updated_on:
            format: date-time
            type: string
        type: object
    pullrequest_merge_parameters:
      description: The metadata that describes a pull request merge.
      properties:
        message:
          description: The commit message that will be used on the resulting commit.
          type: string
        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
        type:
          type: string
        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
      required:
      - type
      type: object
    user:
      allOf:
      - $ref: '#/components/schemas/account'
      - description: A user object.
        properties:
          account_id:
            description: The user's Atlassian account ID.
            type: string
          is_staff:
            type: boolean
        type: object
    paginated_pullrequest_comments:
      description: A paginated list of pullrequest comments.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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/comment'
          minItems: 0
          type: array
          uniqueItems: true
        page:
          description: Page number of the current results. This is an optional element
            that is not provided in all responses.
          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
        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
        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
      type: object
    account:
      allOf:
      - $ref: '#/components/schemas/object'
      - description: An account object.
        properties:
          display_name:
            type: string
          created_on:
            format: date-time
            type: string
          website:
            type: string
          has_2fa_enabled:
            type: boolean
          username:
            pattern: ^[a-zA-Z0-9_\-]+$
            type: string
          uuid:
            type: string
          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
          links:
            properties:
              followers:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              repositories:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              following:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              self:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              html:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
              avatar:
                properties:
                  name:
                    type: string
                  href:
                    format: uri
                    type: string
                type: object
            type: object
          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
        type: object
    paginated_commitstatuses:
      description: A paginated list of commit status objects.
      example:
        next: http://example.com/aeiou
        size: 0
        previous: http://example.com/aeiou
        values:
        - null
        - null
        page: 1
        pagelen: 1
      properties:
        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
        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
        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
        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
      type: object
    pullrequest_endpoint:
      properties:
        repository:
          $ref: '#/components/schemas/repository'
        commit:
          $ref: '#/components/schemas/pullrequest_endpoint_commit'
        branch:
          $ref: '#/components/schemas/pullrequest_endpoint_branch'
      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 with username and password as
        credentials is only available on accounts that have 2-factor-auth / 2-step-verification
        disabled. If you use 2fa, you should authenticate using OAuth2 instead.
      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:
            email: Read your account's primary email address
            project:write: Read and modify your team's project settings, and read
              and transfer repositories within your team's projects
            account:write: Read and modify your account information
            snippet:write: Read and modify your snippets
            team:write: Read and modify your team membership information
            issue:write: Read and modify your repositories' issues
            issue: Read your repositories' issues
            wiki: Read and modify your repositories' wikis
            pipeline:variable: Access your repositories' build pipelines and configure
              their variables
            pullrequest:write: Read and modify your repositories and their pull requests
            pipeline:write: Access and rerun your repositories' build pipelines
            webhook: Read and modify your repositories' webhooks
            team: Read your team membership information
            pipeline: Access your repositories' build pipelines
            repository:admin: Administer your repositories
            repository:write: Read and modify your repositories
            project: Read your team's project settings and read repositories contained
              within your team's projects
            pullrequest: Read your repositories and their pull requests
            repository:delete: Delete your repositories
            repository: Read your repositories
            account: Read your account information
            snippet: Read your snippets
          tokenUrl: https://bitbucket.org/site/oauth2/access_token
      type: oauth2