openapi: 3.1.0 info: title: Atlassian Admin Account Create API description: The Atlassian Admin API provides programmatic access to manage Atlassian organizations, users, domains, policies, and events. It enables administrators to automate organization management tasks, integrate with identity providers, and ensure appropriate access to Atlassian products. version: 1.0.0 contact: name: Atlassian Developer url: https://developer.atlassian.com/cloud/admin/ license: name: Atlassian Developer Terms url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ x-logo: url: https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/favicon.png servers: - url: https://api.atlassian.com description: Atlassian Cloud API security: - bearerAuth: [] - oauth2: [] tags: - name: Create paths: /repositories/{workspace}/{repo_slug}/pullrequests: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new pull request in a specified Bitbucket repository within a given workspace. By sending a POST request to the endpoint with the workspace identifier and repository slug as path parameters, users can programmatically initiate a pull request that proposes merging changes from a source branch into a destination branch. The request typically requires a JSON payload containing essential details such as the title, description, source branch, destination branch, and optionally reviewers or other metadata. Upon successful creation, the API returns the newly created pull request object with its unique identifier and associated properties, enabling automated workflows for code review processes and integration with CI/CD pipelines or project management tools. summary: Atlassian Create Pull Request responses: '201': description: The newly created pull request. headers: Location: description: The URL of new newly created pull request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/pullrequest' '400': description: If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: If the request was not authenticated. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/pullrequest' examples: create-pull-request: $ref: '#/components/examples/create-pull-request' 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.' security: - oauth2: - pullrequest:write - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket - write:pullrequest:bitbucket operationId: createPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: 'The Create Comment On Pull Request operation allows developers to add new comments to a specific pull request in a Bitbucket repository by sending a POST request to the endpoint /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments. This API call requires authentication and takes three path parameters: the workspace identifier, the repository slug, and the pull request ID. The request body must include the comment content, and optionally can specify properties like inline comment positioning (file path, line numbers) for code-specific feedback, parent comment ID for threaded replies, and anchor information. Upon successful execution, the API returns the newly created comment object with details including the comment ID, author information, creation timestamp, and the comment content. This operation is commonly used in code review workflows to facilitate collaboration and discussion among team members regarding code changes proposed in pull requests.' summary: Atlassian Create Comment on Pull Request responses: '201': description: The newly created comment. headers: Location: description: The URL of the new comment schema: type: string content: application/json: schema: $ref: '#/components/schemas/pullrequest_comment' '403': description: If the authenticated user does not have access to the pull request. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the pull request does not exist. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/pullrequest_comment' examples: create-comment-on-pull-request: $ref: '#/components/examples/create-comment-on-pull-request' description: The comment object. required: true security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: createCommentOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API endpoint allows you to create a new task on a specific pull request within a Bitbucket repository. By sending a POST request to /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks, you can add actionable items or to-do items that need to be completed as part of the pull request review process. You must specify the workspace (team or user account), repository slug, and pull request ID in the URL path, along with task details in the request body such as the task description and its associated content. This is useful for tracking specific review requirements, requested changes, or action items that reviewers or contributors need to address before the pull request can be merged. summary: Atlassian Create Task on Pull Request responses: '201': description: The newly created task. headers: Location: description: The URL of the new task schema: type: string content: application/json: schema: $ref: '#/components/schemas/A_pullrequest_comment_task' '400': description: There is a missing required field in the request or the task content is blank. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: If the authenticated user does not have access to the pull request. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the pull request does not exist. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/A_pullrequest_task_create' examples: pull-request-task-create: $ref: '#/components/examples/pull-request-task-create' description: The contents of the task required: true security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: createTaskOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new repository within a specified workspace in Atlassian Bitbucket. By sending a POST request to the endpoint with the workspace identifier and desired repository slug as path parameters, users can programmatically initialize a new repository with configurable settings such as project assignment, description, privacy settings (public or private), and other repository-specific properties passed in the request body. The operation returns the newly created repository object including its UUID, full name, creation timestamp, and links to related resources, making it essential for automated repository provisioning and DevOps workflows that need to dynamically set up version control repositories without manual intervention through the Bitbucket web interface. summary: Atlassian Create Repository responses: '200': description: The newly created repository. content: application/json: schema: $ref: '#/components/schemas/repository' examples: undefined: $ref: '#/components/examples/undefined' '400': description: If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: If the request was not authenticated. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/repository' examples: repository: $ref: '#/components/examples/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. security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:repository:bitbucket operationId: createRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true GenerateExampleFromOperationRequestSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/branch-restrictions: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new branch restriction rule for a specific repository in Bitbucket Cloud, allowing workspace administrators to enforce policies on branches within a given repository. By sending a POST request to the endpoint with the workspace ID and repository slug as path parameters, users can define restrictions such as preventing force pushes, requiring pull request approvals, limiting who can merge or push to specific branches, or enforcing other branch protection policies. The request body typically includes details like the restriction type, the branch pattern to which the rule applies (using glob patterns or specific branch names), and the users or groups affected by the restriction. This functionality is essential for maintaining code quality and implementing workflow controls in collaborative development environments, ensuring that critical branches like main or production are protected from unauthorized or potentially harmful changes. summary: Atlassian Create Branch Restriction Rule responses: '201': description: A paginated list of branch restrictions content: application/json: schema: $ref: '#/components/schemas/branchrestriction' examples: branch-restriction_2: $ref: '#/components/examples/branch-restriction_2' '401': description: If the request was not authenticated content: application/json: schema: $ref: '#/components/schemas/error' '403': description: If the authenticated user does not have admin access to the repository content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the repository does not exist content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/branchrestriction' examples: branch-restriction: $ref: '#/components/examples/branch-restriction' description: The new rule required: true security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:repository:bitbucket operationId: createBranchRestrictionRule x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/comments: parameters: - name: commit in: path description: The Commits SHA1. required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation allows you to create a new comment on a specific commit within a Bitbucket repository. By sending a POST request to the endpoint with the workspace ID, repository slug, and commit hash, along with the comment content in the request body, you can add feedback, notes, or discussion points directly associated with that particular commit. This is useful for code review processes, documenting changes, or collaborating with team members on specific code modifications. The operation requires appropriate authentication and permissions to comment on commits within the specified repository. summary: Atlassian Create Comment for Commit responses: '201': description: The newly created comment. headers: Location: description: The location of the newly created comment. schema: type: string '400': description: If the comment was detected as spam, or if the parent comment is not attached to the same node as the new comment '404': description: If a parent ID was passed in that cannot be found requestBody: content: application/json: schema: $ref: '#/components/schemas/commit_comment' examples: commit-comment: $ref: '#/components/examples/commit-comment' description: The specified comment. required: true security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: createCommentForCommit x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}: put: tags: - Create description: This PUT operation creates or updates a report for a specific commit in a Bitbucket repository, identified by the workspace, repository slug, commit SHA, and report ID. Reports are typically used to provide additional build, test, or code quality information about a commit, such as code coverage, security scans, or custom analysis results. The operation requires authentication and appropriate permissions to the repository, and accepts a JSON payload containing the report details including its title, reporter, result status (PASSED, FAILED, or PENDING), and optional metadata like links and data fields. If a report with the specified ID already exists for the commit, it will be updated; otherwise, a new report will be created. This endpoint is commonly used by CI/CD tools and third-party integrations to display supplementary commit status information directly within the Bitbucket interface, allowing teams to view comprehensive build and quality metrics alongside their code changes. operationId: createOrUpdateReport summary: Atlassian Create or Update Report parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: commit description: The commit the report belongs to. required: true in: path schema: type: string - name: reportId description: Either the uuid or external-id of the report. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/report' examples: commit-report: $ref: '#/components/examples/commit-report' description: The report to create or update required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/report' examples: commit-report_2: $ref: '#/components/examples/commit-report_2' '400': description: The provided Report object is malformed or incomplete. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations: post: tags: - Create description: Creates or updates individual annotation objects within a specified commit report in a Bitbucket repository, allowing developers to programmatically add code analysis findings, linting errors, test results, or other automated feedback directly to a specific commit. The operation requires the workspace ID, repository slug, commit hash, and report ID as path parameters, and accepts an array of annotation objects in the request body, each containing details such as line number, severity, annotation type, summary, and optional description. This bulk operation enables CI/CD pipelines and development tools to efficiently attach multiple code quality insights to a single commit, making review feedback immediately visible within the Bitbucket interface and helping teams maintain code standards through automated checks. operationId: bulkCreateOrUpdateAnnotations summary: Atlassian Bulk Create or Update Annotations parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: commit description: The commit for which to retrieve reports. required: true in: path schema: type: string - name: reportId description: Uuid or external-if of the report for which to get annotations for. required: true in: path schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/report_annotation' minItems: 1 maxItems: 100 examples: bulk-create-or-update-annotations_2: $ref: '#/components/examples/bulk-create-or-update-annotations_2' description: The annotations to create or update required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/report_annotation' examples: undefined_2: $ref: '#/components/examples/undefined_2' security: - oauth2: - repository - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}: put: tags: - Create description: This PUT operation allows users to create or update a specific annotation for a code report associated with a particular commit in a Bitbucket repository. By providing the workspace identifier, repository slug, commit hash, report ID, and annotation ID in the URL path, developers can add detailed feedback or metadata about specific lines or sections of code within that commit's report. Annotations are typically used in CI/CD pipelines or code analysis tools to highlight issues, warnings, or suggestions directly within the Bitbucket interface, enabling better code review workflows and automated quality checks. If an annotation with the specified ID already exists, this operation updates it with the new information provided in the request body; otherwise, it creates a new annotation with that ID. operationId: createOrUpdateAnAnnotation summary: Atlassian Create or Update an Annotation parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: commit description: The commit the report belongs to. required: true in: path schema: type: string - name: reportId description: Either the uuid or external-id of the report. required: true in: path schema: type: string - name: annotationId description: Either the uuid or external-id of the annotation. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/report_annotation' examples: report-annotation_2: $ref: '#/components/examples/report-annotation_2' description: The annotation to create or update required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/report_annotation' examples: report-annotation_2: $ref: '#/components/examples/report-annotation_2' '400': description: The provided Annotation object is malformed or incomplete. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build: parameters: - name: commit in: path description: The Commits SHA1. required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This POST endpoint creates a build status for a specific commit in a Bitbucket repository, allowing external CI/CD systems and build tools to report the status of automated builds back to Bitbucket. The endpoint requires the workspace ID, repository slug, and commit hash as path parameters, and accepts a JSON payload containing build status information such as state (successful, failed, in progress), key, name, URL, and description. When invoked, it associates the provided build status with the specified commit, which then becomes visible in the Bitbucket UI on pull requests and commit pages, enabling teams to track build results and prevent merging of code that fails automated checks. This integration is essential for maintaining CI/CD pipelines and ensuring code quality by providing real-time feedback on build outcomes directly within the version control interface. summary: Atlassian Create Build Status for Commit responses: '201': description: The newly created build status object. content: application/json: schema: $ref: '#/components/schemas/commitstatus' examples: commit-status_2: $ref: '#/components/examples/commit-status_2' '401': description: If the repository is private and the request was not authenticated. '404': description: If the repository, commit, or build status key does not exist content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/commitstatus' examples: commit-status: $ref: '#/components/examples/commit-status' description: The new commit status object. security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: createBuildStatusForCommit x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables: post: tags: - Create description: Creates a new deployment variable for a specific environment within a Bitbucket repository's deployment configuration. This operation requires specifying the workspace, repository slug, and environment UUID in the path, allowing teams to define environment-specific variables such as API keys, connection strings, or configuration values that will be available during the deployment process. The variable details including the key name, value, and optionally whether it should be secured or hidden are provided in the request body. This enables teams to manage configuration across different deployment environments like development, staging, and production while maintaining security and flexibility in their CI/CD pipelines. summary: Atlassian Create Variable for an Environment operationId: createVariableForAnEnvironment parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: environment_uuid description: The environment. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/deployment_variable' examples: deployment-variable: $ref: '#/components/examples/deployment-variable' description: The variable to create required: true responses: '201': description: The variable was created. headers: Location: description: The URL of the newly created variable. schema: type: string content: application/json: schema: $ref: '#/components/schemas/deployment_variable' examples: deployment-variable_2: $ref: '#/components/examples/deployment-variable_2' '404': description: The account, repository, environment or variable with the given UUID was not found. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: A variable with the provided key already exists. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pipeline:variable - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/environments: post: tags: - Create description: The Create an Environment operation in the Atlassian Bitbucket Repositories API allows users to create a new deployment environment within a specific repository by sending a POST request to the /repositories/{workspace}/{repo_slug}/environments endpoint. This operation requires specifying both the workspace identifier and repository slug in the URL path, and enables teams to define distinct deployment targets such as development, staging, or production environments for their code. The created environment can then be referenced in deployment pipelines and used to manage environment-specific variables, restrictions, and deployment history, providing better control over the software delivery process within Bitbucket's CI/CD workflow. summary: Atlassian Create an Environment operationId: createAnEnvironment parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/deployment_environment' examples: deployment-environment: $ref: '#/components/examples/deployment-environment' description: The environment to create. required: true responses: '201': description: The environment was created. headers: Location: description: The URL of the newly created environment. schema: type: string content: application/json: schema: $ref: '#/components/schemas/deployment_environment' examples: deployment-environment_2: $ref: '#/components/examples/deployment-environment_2' '404': description: The account or repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: An environment host with the provided name already exists. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/hooks: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new webhook for a specific Bitbucket repository within a workspace. When invoked via POST request to the endpoint /repositories/{workspace}/{repo_slug}/hooks, it allows you to configure automated notifications that trigger HTTP callbacks to a specified URL whenever certain events occur in the repository, such as push events, pull request updates, or issue changes. The workspace parameter identifies the Bitbucket workspace (formerly team), while repo_slug specifies the repository identifier. The request typically requires authentication and a JSON payload defining the webhook configuration, including the target URL, events to monitor, and optional settings like active status and description. Upon successful creation, the API returns the webhook details including a unique identifier that can be used for subsequent management operations like updates or deletion. summary: Atlassian Create Webhook for Repository responses: '201': description: If the webhook was registered successfully. headers: Location: description: The URL of new newly created webhook. schema: type: string content: application/json: schema: $ref: '#/components/schemas/webhook_subscription' examples: webhook-subscription: $ref: '#/components/examples/webhook-subscription' '403': description: If the authenticated user does not have permission to install webhooks on the specified repository. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - webhook - basic: [] - api_key: [] operationId: createWebhookForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: Creates a new issue in the specified Bitbucket repository within a workspace. This POST endpoint allows users to submit issue details such as title, description, priority, and other metadata to track bugs, tasks, or feature requests. The operation requires authentication and appropriate repository permissions, with the workspace and repository slug specified in the URL path to identify the target repository where the issue will be created. summary: Atlassian Create an Issue responses: '201': description: The newly created issue. headers: Location: description: The (absolute) URL of the newly created issue. schema: type: string content: application/json: schema: $ref: '#/components/schemas/issue' examples: issue_2: $ref: '#/components/examples/issue_2' '401': description: When the request wasn't authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: When the authenticated user isn't authorized to create the issue. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The specified repository does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/issue' examples: issue: $ref: '#/components/examples/issue' description: The new issue. The only required element is `title`. All other elements can be omitted from the body. required: true security: - oauth2: - issue:write - basic: [] - api_key: [] operationId: createAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments: parameters: - name: issue_id in: path description: The issue id required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: Creates a new comment on the specified issue in a Bitbucket repository. This POST endpoint requires authentication and targets a specific issue within a repository by providing the workspace identifier, repository slug, and issue ID in the URL path. The request body should contain the comment content and any additional metadata according to Bitbucket's comment schema. Upon successful execution, the API returns the newly created comment object including its unique identifier, author information, timestamp, and content. This operation is commonly used for adding feedback, updates, or discussions to existing issues in a repository's issue tracker, enabling team collaboration and communication around specific problems or feature requests. summary: Atlassian Create Comment on an Issue responses: '201': description: The newly created comment. headers: Location: description: The location of the newly issue comment. schema: type: string '400': description: 'If the input was invalid, or if the comment being created is detected as spam ' content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/issue_comment' examples: issue-comment: $ref: '#/components/examples/issue-comment' description: The new issue comment object. required: true security: - oauth2: - issue:write - basic: [] - api_key: [] operationId: createCommentOnAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/schedules: post: tags: - Create summary: Atlassian Create Schedule description: Creates a new pipeline schedule for the specified repository in Bitbucket, allowing you to automate pipeline executions at defined intervals or specific times. This endpoint requires you to provide the workspace identifier and repository slug in the path, along with schedule configuration details in the request body such as the cron expression, target branch or tag, and whether the schedule is enabled. The schedule determines when pipelines will automatically trigger without manual intervention, useful for recurring tasks like nightly builds, periodic tests, or scheduled deployments. Upon successful creation, the API returns the newly created schedule object containing its unique identifier and configuration details. operationId: createSchedule parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pipeline_schedule_post_request_body' examples: request-body-for-pipeline-schedule-post-request: $ref: '#/components/examples/request-body-for-pipeline-schedule-post-request' description: The schedule to create. required: true responses: '201': description: The created schedule. content: application/json: schema: $ref: '#/components/schemas/pipeline_schedule' examples: pipeline-schedule: $ref: '#/components/examples/pipeline-schedule' '400': description: There were errors validating the request. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: The maximum limit of schedules for this repository was reached. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The account or repository was not found. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket - write:pipeline:bitbucket security: - oauth2: - pipeline:write - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts: post: tags: - Create summary: Atlassian Create Known Host description: Creates a new known host entry in the Bitbucket Pipelines SSH configuration for a specified repository, allowing the pipeline to establish secure SSH connections to external servers by adding their public key fingerprints to the trusted known hosts list. This endpoint requires authentication and accepts the workspace identifier and repository slug as path parameters, along with the host details in the request body, which typically includes the hostname and its corresponding SSH public key. Once configured, Bitbucket Pipelines can securely connect to the specified host during build and deployment processes without manual verification prompts. operationId: createKnownHost parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pipeline_known_host' examples: pipeline-known-host: $ref: '#/components/examples/pipeline-known-host' description: The known host to create. required: true responses: '201': description: The known host was created. headers: Location: description: The URL of the newly created pipeline known host. schema: type: string content: application/json: schema: $ref: '#/components/schemas/pipeline_known_host' examples: pipeline-known-host_2: $ref: '#/components/examples/pipeline-known-host_2' '404': description: The account or repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: A known host with the provided hostname already exists. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:pipeline:bitbucket security: - oauth2: - pipeline:variable - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/variables: post: tags: - Create summary: Atlassian Create Variable for Repository description: This API operation creates a new pipeline variable for a specific Bitbucket repository within a workspace. By sending a POST request to the endpoint with the workspace ID and repository slug, users can define custom variables that will be available during pipeline executions. These variables are commonly used to store configuration values, credentials, or environment-specific settings that pipelines need to access during build, test, or deployment processes. The operation requires appropriate authentication and permissions to modify pipeline configurations for the specified repository, and the variable data is typically provided in the request body with properties such as the variable name, value, and whether it should be secured or masked in pipeline logs. operationId: createVariableForRepository parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable: $ref: '#/components/examples/pipeline-variable' description: The variable to create. required: true responses: '201': description: The variable was created. headers: Location: description: The URL of the newly created pipeline variable. schema: type: string content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable_2: $ref: '#/components/examples/pipeline-variable_2' '404': description: The account or repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: A variable with the provided key already exists. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:pipeline:bitbucket security: - oauth2: - pipeline:variable - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/refs/branches: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: The Create Branch operation in the Atlassian Bitbucket Repositories API allows developers to programmatically create a new branch within a specified repository by sending a POST request to the /repositories/{workspace}/{repo_slug}/refs/branches endpoint. This operation requires authentication and takes the workspace identifier and repository slug as path parameters, along with a request body that typically includes the new branch name and the source commit or existing branch from which to create it. Upon successful execution, the API returns details about the newly created branch including its name, target commit hash, and associated metadata, enabling automated branch management workflows for version control and continuous integration processes. summary: Atlassian Create Branch responses: '201': description: The newly created branch object. content: application/json: schema: $ref: '#/components/schemas/branch' '403': description: 'If the repository is private and the authenticated user does not have access to it. ' content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The specified repository or branch does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository:write - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - write:repository:bitbucket - read:repository:bitbucket operationId: createBranch x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/refs/tags: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: The Create Tag operation in the Atlassian Bitbucket Repositories API allows users to create a new tag in a specified repository by sending a POST request to the /repositories/{workspace}/{repo_slug}/refs/tags endpoint. This operation requires the workspace identifier and repository slug as path parameters to target the specific repository where the tag should be created. The request typically includes details such as the tag name, the target commit hash or reference to which the tag should point, and optional metadata like a message or tagger information. This endpoint is commonly used in version control workflows to mark specific points in a repository's history, such as releases or important milestones, making it easier to reference and retrieve specific versions of the codebase. Successful execution returns the newly created tag object with its properties, while authentication and appropriate repository permissions are required to perform this operation. summary: Atlassian Create Tag responses: '201': description: The newly created tag. content: application/json: schema: $ref: '#/components/schemas/tag' examples: tag_2: $ref: '#/components/examples/tag_2' '400': description: If the target hash is missing, ambiguous, or invalid, or if the name is not provided. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/tag' examples: tag: $ref: '#/components/examples/tag' required: true security: - oauth2: - repository:write - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - write:repository:bitbucket - read:repository:bitbucket operationId: createTag x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/src: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This operation allows you to create a new commit in a Bitbucket repository by uploading one or more files directly through the API. You specify the target workspace and repository via the path parameters, then provide the file content along with commit metadata such as the commit message, branch name, author information, and optional parent commit references in the request body. The files are uploaded as multipart form data, where each file can be specified with its path in the repository and its content. Upon successful execution, the API creates a new commit containing the uploaded files and returns details about the newly created commit including its hash, timestamp, and author information. This is particularly useful for automating file updates, CI/CD pipelines, or any workflow that needs to programmatically modify repository contents without requiring a local git clone or manual file operations. summary: Atlassian Create Commit by Uploading File responses: '201': description: ' ' '403': description: If the authenticated user does not have write or admin access content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: message in: query description: The commit message. When omitted, Bitbucket uses a canned string. required: false schema: type: string - name: author in: query description: ' The raw string to be used as the new Commits author. This string follows the format `Erik van Zijst `. When omitted, Bitbucket uses the authenticated user''s full/display name and primary email address. Commits cannot be created anonymously.' required: false schema: type: string - name: parents in: query description: ' 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.".' required: false schema: type: string - name: files in: query description: ' 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. ' required: false schema: type: string - name: branch in: query description: ' 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. 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. ' required: false schema: type: string security: - oauth2: - repository:write - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - write:repository:bitbucket operationId: createCommitByUploadingFile x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new code snippet within a specified Atlassian Bitbucket workspace by sending a POST request to the /snippets/{workspace} endpoint, where {workspace} is replaced with the unique identifier or name of the target workspace. The operation allows authenticated users to programmatically submit code snippets, which can include multiple files, descriptions, and metadata, to be stored and shared within the designated workspace, making it useful for developers who want to save and organize reusable code fragments, documentation, or configuration examples that can be accessed by team members with appropriate permissions. summary: Atlassian Create Snippet for Workspace responses: '201': description: The newly created snippet object. headers: Location: description: The URL of the newly created snippet. schema: type: string content: application/json: schema: $ref: '#/components/schemas/snippet' examples: snippet: $ref: '#/components/examples/snippet' '401': description: If the request was not authenticated content: application/json: schema: $ref: '#/components/schemas/error' '403': description: If the authenticated user does not have permission to create snippets in the specified workspace. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: $ref: '#/components/requestBodies/snippet' security: - oauth2: - snippet:write - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true WriteDescription: true GenerateExampleFromOperationResponseSchema: true operationId: createSnippetForWorkspace x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/comments: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: 'The Atlassian Bitbucket Snippets API POST operation to /snippets/{workspace}/{encoded_id}/comments allows authenticated users to create a new comment on a specific code snippet within a designated workspace. This endpoint requires two path parameters: the workspace identifier and the encoded snippet ID, enabling precise targeting of the snippet to be commented on. When invoked, it accepts comment content in the request body and creates a new comment thread or adds to an existing discussion on the specified snippet. This functionality facilitates code review, collaboration, and feedback mechanisms within Bitbucket''s snippet sharing feature, allowing team members to provide inline commentary, suggestions, or questions about shared code fragments. The operation returns the newly created comment object upon successful execution, including metadata such as comment ID, author information, timestamp, and the comment content itself.' summary: Atlassian Create Comment on Snippet responses: '201': description: The newly created comment. headers: Location: description: The URL of the new comment schema: type: string content: application/json: schema: $ref: '#/components/schemas/snippet_comment' examples: snippet-comment_2: $ref: '#/components/examples/snippet-comment_2' '403': description: If the authenticated user does not have access to the snippet. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the snippet does not exist. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: content: application/json: schema: $ref: '#/components/schemas/snippet_comment' examples: snippet-comment: $ref: '#/components/examples/snippet-comment' description: The contents of the new comment. required: true security: - oauth2: - snippet - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationRequestSchema: true GenerateExampleFromOperationResponseSchema: true operationId: createCommentOnSnippet x-microcks-operation: delay: 0 dispatcher: FALLBACK /teams/{username}/pipelines_config/variables: post: tags: - Create deprecated: true summary: Atlassian Create Variable for User description: This API operation creates a new pipeline configuration variable for a specific Bitbucket team identified by the username parameter in the path. It allows administrators to define custom variables that can be used across pipeline configurations for the team, enabling centralized management of configuration values such as credentials, API keys, or environment-specific settings. The operation requires a POST request to the endpoint with the Teams username and the variable details in the request body, which typically includes the variable name, value, and whether it should be secured or masked in pipeline logs. Upon successful creation, the API returns the newly created variable object with its configuration details, making it available for use in any pipeline within that Teams repositories. operationId: createVariableForUser parameters: - name: username description: The account. required: true in: path schema: type: string requestBody: $ref: '#/components/requestBodies/pipeline_variable2' responses: '201': description: The created variable. headers: Location: description: The URL of the newly created pipeline variable. schema: type: string content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable: $ref: '#/components/examples/pipeline-variable_3' '404': description: The account does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: A variable with the provided key already exists. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pipeline:variable - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{selected_user}/pipelines_config/variables: post: tags: - Create deprecated: true summary: Atlassian Create Variable for User description: This API operation creates a new pipeline configuration variable for a specified Bitbucket user account. By sending a POST request to the endpoint with the target Users identifier, administrators can define custom variables that will be available across all pipelines associated with that Users repositories. The variables typically include key-value pairs used for storing configuration settings, credentials, or other data needed during pipeline execution, and can be marked as secured to protect sensitive information. This allows for centralized management of user-level pipeline configurations without having to define the same variables repeatedly across multiple repositories owned by the user. operationId: createVariableForUser parameters: - name: selected_user description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. required: true in: path schema: type: string requestBody: $ref: '#/components/requestBodies/pipeline_variable2' responses: '201': description: The created variable. headers: Location: description: The URL of the newly created pipeline variable. schema: type: string content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable: $ref: '#/components/examples/pipeline-variable_4' '404': description: The account does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: A variable with the provided key already exists. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pipeline:variable - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/hooks: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new webhook for a specified Bitbucket workspace by sending a POST request to the /workspaces/{workspace}/hooks endpoint. Webhooks allow workspaces to receive real-time HTTP callbacks when specific events occur within the workspace, such as repository pushes, pull requests, or issue updates. The workspace is identified by the {workspace} path parameter, which represents the workspace ID or slug. The request typically requires authentication and a JSON payload containing webhook configuration details including the target URL where events should be sent, a description, and the specific events to subscribe to. Upon successful creation, the API returns the newly created webhook object with its unique identifier and configuration details, enabling automated integrations and event-driven workflows between Bitbucket and external systems or services. summary: Atlassian Create a Webhook for a Workspace responses: '201': description: If the webhook was registered successfully. headers: Location: description: The URL of new newly created webhook. schema: type: string content: application/json: schema: $ref: '#/components/schemas/webhook_subscription' examples: webhook-subscription: $ref: '#/components/examples/webhook-subscription_2' '403': description: If the authenticated user does not have permission to install webhooks on the specified workspace. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the specified workspace does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - webhook - basic: [] - api_key: [] operationId: atlassianCreateAWebhookForAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/pipelines-config/variables: post: tags: - Create summary: Atlassian Create a Variable for a Workspace description: The POST operation on the /workspaces/{workspace}/pipelines-config/variables endpoint allows you to create a new pipeline variable within a specific Bitbucket workspace, enabling you to define configuration values that can be used across multiple pipelines in that workspace. This endpoint requires you to specify the workspace slug in the path parameter and provide the variable details in the request body, typically including the variable's key (name), value, and whether it should be secured/encrypted. Workspace-level pipeline variables are useful for storing shared configuration data, credentials, or environment-specific values that need to be accessible to all repositories within the workspace without having to duplicate the variable definitions in each individual repository. The API returns the created variable object upon successful execution, and requires appropriate authentication and workspace admin permissions to perform this operation. operationId: atlassianCreatepipelinevariableforworkspace parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string requestBody: $ref: '#/components/requestBodies/pipeline_variable2' responses: '201': description: The created variable. headers: Location: description: The URL of the newly created pipeline variable. schema: type: string content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable: $ref: '#/components/examples/pipeline-variable_5' '404': description: The workspace does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '409': description: A variable with the provided key already exists. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:pipeline:bitbucket security: - oauth2: - pipeline:variable - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new project within a specified Bitbucket workspace by sending a POST request to the /workspaces/{workspace}/projects endpoint, where {workspace} is replaced with the unique identifier or slug of the target workspace. The operation allows workspace administrators to programmatically establish new projects that serve as containers for organizing related repositories, enabling better code management and team collaboration. When invoked, the endpoint accepts project details in the request body such as project name, key, description, and access permissions, then returns the newly created project object with its assigned metadata including a unique project identifier, timestamps, and configuration settings. This operation requires appropriate authentication credentials and workspace-level permissions, typically administrator or write access, to successfully create projects within the organizational structure of the Bitbucket workspace. summary: Atlassian Create a Project in a Workspace responses: '201': description: A new project has been created. headers: Location: description: The location of the newly created project schema: type: string content: application/json: schema: $ref: '#/components/schemas/project' examples: project: $ref: '#/components/examples/project' '403': description: The requesting user isn't authorized to create the project. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: A workspace doesn't exist at this location. content: application/json: schema: $ref: '#/components/schemas/error' requestBody: $ref: '#/components/requestBodies/project' security: - oauth2: - project:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:project:bitbucket operationId: atlassianCreateAProjectInAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/deploy-keys: parameters: - name: project_key in: path description: 'The project in question. This is the actual `key` assigned to the project. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string post: tags: - Create description: This API operation creates a new deploy key for a specific project within a Bitbucket workspace, allowing secure, read-only SSH access to repositories within that project. By making a POST request to the endpoint with the workspace slug and project key as path parameters, users can generate an SSH key that can be used for automated deployments or CI/CD pipelines without requiring personal credentials. The deploy key is scoped to the project level, meaning it can access all repositories within the specified project, and the request body typically includes the SSH public key content and an optional label for identification purposes. This is particularly useful for granting automated systems or external services controlled access to project repositories for deployment purposes while maintaining security best practices by avoiding the use of user account credentials. summary: Atlassian Create a Project Deploy Key responses: '200': description: The project deploy key that was created content: application/json: schema: $ref: '#/components/schemas/project_deploy_key' examples: project-deploy-key: $ref: '#/components/examples/project-deploy-key' '400': description: Invalid deploy key inputs content: application/json: schema: $ref: '#/components/schemas/error' '403': description: If the specified workspace or project is not accessible to the current user content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the specified workspace or project does not exist content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project - project:admin - basic: [] - api_key: [] operationId: atlassianCreateAProjectDeployKey x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/child/attachment: put: tags: - Create summary: Atlassian Create or Update Attachment description: This API operation allows you to create a new attachment or update an existing attachment for a specific Confluence page or blog post identified by its content ID. When uploading a file, you must use multipart/form-data encoding and include the file in the request body along with optional metadata such as comments or minor edit flags. If an attachment with the same filename already exists, this operation will create a new version of that attachment rather than replacing it entirely, maintaining the version history. The operation requires appropriate permissions on the parent content and returns detailed information about the created or updated attachment, including its download URL, file size, media type, and version number. This is particularly useful for programmatically managing documentation assets, images, or any supplementary files associated with Confluence content. operationId: createOrUpdateAttachment parameters: - name: id in: path description: The ID of the content to add the attachment to. required: true schema: type: string - name: status in: query description: 'The status of the content that the attachment is being added to. This should always be set to ''current''.' schema: type: string default: current enum: - current - draft requestBody: content: multipart/form-data: schema: required: - file - minorEdit properties: file: type: string description: 'The relative location and name of the attachment to be added to the content.' format: binary comment: type: string description: 'The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don''t specify any comments.' format: binary minorEdit: type: string description: 'If `minorEdits` is set to ''true'', no notification email or activity stream will be generated when the attachment is added to the content.' format: binary required: true responses: '200': description: Returned if the attachments were added to the content. content: application/json: schema: $ref: '#/components/schemas/ContentArray' '403': description: 'Returned if; - Attachments are disabled. - The calling user does not have permission to add attachments to the content.' content: {} '404': description: 'Returned if; - The requested content is not found. - The user does not have permission to view it. - The attachment exceeds the maximum configured attachment size.' content: {} security: - basicAuth: [] - oAuthDefinitions: - write:confluence-file x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - write:confluence-file - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence - write:attachment:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: WRITE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Create summary: Atlassian Create Attachment description: This POST operation allows you to create and upload new attachments to a specific Confluence page or blog post by providing the content ID in the URL path. The endpoint accepts multipart/form-data requests containing the file to be uploaded along with optional metadata such as comments or attachment properties. Upon successful execution, it returns details about the newly created attachment including its ID, title, download URL, media type, file size, and version information. The authenticated user must have permission to edit the specified content in order to add attachments to it. This operation is commonly used for programmatically adding files, images, documents, or other resources to Confluence pages as part of automated workflows or integrations. operationId: createAttachment parameters: - name: id in: path description: The ID of the content to add the attachment to. required: true schema: type: string - name: status in: query description: The status of the content that the attachment is being added to. schema: type: string default: current enum: - current - draft requestBody: content: multipart/form-data: schema: required: - file - minorEdit properties: file: type: string description: 'The relative location and name of the attachment to be added to the content.' format: binary comment: type: string description: 'The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don''t specify any comments.' format: binary minorEdit: type: string description: 'If `minorEdits` is set to ''true'', no notification email or activity stream will be generated when the attachment is added to the content.' format: binary required: true responses: '200': description: Returned if the attachments were added to the content. content: application/json: schema: $ref: '#/components/schemas/ContentArray' '400': description: Returned if the content already has an attachment with the same filename. content: {} '403': description: 'Returned if; - Attachments are disabled in Confluence. - The calling user does not have permission to add attachments to the content.' content: {} '404': description: 'Returned if; - The requested content is not found. - The user does not have permission to view it - The attachment exceeds the maximum configured attachment size.' content: {} security: - basicAuth: [] - oAuthDefinitions: - write:confluence-file x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - write:confluence-file - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence - write:attachment:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: WRITE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/property: post: tags: - Create summary: Atlassian Create Content Property deprecated: true description: Creates a new content property for an existing Confluence content item identified by its ID. Content properties are custom key-value pairs that allow you to store additional metadata or configuration data associated with a specific piece of content such as a page, blog post, or attachment. The property must include a unique key within the scope of that content item and a value, which can be a simple string or a complex JSON object. This operation requires appropriate permissions to modify the specified content, and the property key must not already exist on that content item, otherwise the request will fail with a conflict error. operationId: createContentProperty parameters: - name: id in: path description: The ID of the content to add the property to. required: true schema: type: string requestBody: description: The content property to be created. content: application/json: schema: $ref: '#/components/schemas/ContentPropertyCreate' required: true responses: '200': description: Returned if the content property is created. content: application/json: schema: $ref: '#/components/schemas/ContentProperty' '400': description: 'Returned if; - The content already has a property with the given key. - The key is too long. - The key is empty.' content: {} '403': description: 'Returned if the user does not have permission to edit the content with the given ID.' content: {} '413': description: Returned if the value is too long. content: {} security: - basicAuth: [] - oAuthDefinitions: - write:confluence-props x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - write:confluence-props - scheme: oAuthDefinitions state: Beta scopes: - read:content.property:confluence - write:content.property:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-codegen-request-body-name: body x-atlassian-connect-scope: WRITE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/property/{key}: post: tags: - Create summary: Atlassian Create Content Property for Key deprecated: true description: Creates a new content property for the specified content ID and property key in Confluence. This endpoint allows you to store custom metadata or additional information associated with a specific piece of content by posting a JSON payload containing the property value. The property is identified by a unique key and is scoped to the individual content item, making it useful for storing application-specific data, custom attributes, or extended metadata that needs to be associated with pages, blog posts, or other Confluence content types. If a property with the specified key already exists for that content, the operation will fail, requiring you to use an update operation instead. operationId: createContentPropertyForKey parameters: - name: id in: path description: The ID of the content to add the property to. required: true schema: type: string - name: key in: path description: The key of the content property. Required. required: true schema: type: string requestBody: description: The content property to be created. content: application/json: schema: $ref: '#/components/schemas/ContentPropertyCreateNoKey' required: true responses: '200': description: Returned if the content property is created. content: application/json: schema: $ref: '#/components/schemas/ContentProperty' '400': description: 'Returned if; - The content already has a property with the given key. - The key is too long. - The key is empty.' content: {} '403': description: 'Returned if the user does not have permission to edit the content with the given ID.' content: {} '413': description: Returned if the value is too long. content: {} security: - basicAuth: [] - oAuthDefinitions: - write:confluence-props x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - write:confluence-props - scheme: oAuthDefinitions state: Beta scopes: - read:content.property:confluence - write:content.property:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-codegen-request-body-name: body x-atlassian-connect-scope: WRITE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: examples: repository: links: self: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo name: self html: href: https://bitbucket.org/example-user/example-repo name: html avatar: href: https://bitbucket.org/example-user/example-repo/avatar/32/ name: avatar pullrequests: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/pullrequests name: pullrequests commits: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/commits name: commits forks: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/forks name: forks watchers: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/watchers name: watchers downloads: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/downloads name: downloads clone: - href: https://bitbucket.org/example-user/example-repo.git name: https - href: git@bitbucket.org:example-user/example-repo.git name: ssh hooks: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/hooks name: hooks uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' full_name: example-user/example-repo is_private: false scm: git name: example-repo description: This is an example Bitbucket repository created_on: '2023-01-15T10:30:00.000Z' updated_on: '2024-01-15T14:45:30.000Z' size: 1048576 language: javascript has_issues: true has_wiki: true fork_policy: allow_forks undefined: type: repository links: self: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo name: self html: href: https://bitbucket.org/example-user/example-repo name: html avatar: href: https://bitbucket.org/example-user/example-repo/avatar/32/ name: avatar pullrequests: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/pullrequests name: pullrequests commits: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/commits name: commits forks: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/forks name: forks watchers: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/watchers name: watchers downloads: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/downloads name: downloads clone: - href: https://bitbucket.org/example-user/example-repo.git name: https - href: git@bitbucket.org:example-user/example-repo.git name: ssh hooks: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/hooks name: hooks uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' full_name: example-user/example-repo is_private: false scm: git name: example-repo description: This is an example repository for demonstration purposes created_on: '2023-01-15T10:30:00.000Z' updated_on: '2024-01-10T14:22:00.000Z' size: 1048576 language: python has_issues: true has_wiki: true fork_policy: allow_forks pipeline-variable_2: uuid: 3c7b8a9e-1234-5678-90ab-cdef12345678 key: API_TOKEN value: my-secret-value secured: true commit-status: links: self: href: https://api.bitbucket.org/2.0/repositories/example/repo/commit/abc123/statuses/build/1 name: self commit: href: https://api.bitbucket.org/2.0/repositories/example/repo/commit/abc123 name: commit uuid: '{12345678-1234-1234-1234-123456789abc}' key: BB-DEPLOY refname: main url: https://foo.com/builds/{repository.full_name} state: SUCCESSFUL name: BB-DEPLOY-1 description: Unit tests in Bamboo created_on: '2023-11-15T10:30:00Z' updated_on: '2023-11-15T10:45:00Z' webhook-subscription: uuid: '{d7a4e3b2-5c1f-4a8b-9e2d-3f6c8a1b4e9d}' url: https://example.com/webhooks/bitbucket description: Webhook for monitoring pull request and repository events subject_type: repository subject: {} active: true created_at: '2024-01-15T10:30:00Z' events: - repo:push - pullrequest:created - pullrequest:approved - pullrequest:fulfilled - issue:created secret_set: true secret: my-secure-webhook-secret-123 tag_2: message: Release version 1.0.0 date: '2024-01-15T14:30:00Z' tagger: name: John Doe email: john.doe@example.com issue-comment: issue: id: 1 title: Example issue status: open comment: This is an example comment on the issue author: user123 timestamp: '2024-01-15T10:30:00Z' request-body-for-pipeline-schedule-post-request: target: selector: type: pipeline_uuid pipeline_uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 ref_name: main ref_type: branch enabled: true cron_pattern: 0 0 12 * * ? * pipeline-variable_4: uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false pipeline-known-host: uuid: 123e4567-e89b-12d3-a456-426614174000 hostname: github.com public_key: type: ssh-rsa key: AAAAB3NzaC1yc2EAAAADAQABAAABAQC7... commit-report: uuid: 3c1f4b7e-9a2d-4f6c-8b5e-1a2b3c4d5e6f title: Security Scan Report details: Automated security vulnerability scan for commit dependencies and code patterns external_id: security-scan-12345 reporter: SecureCode Scanner v2.1 link: https://example.com/reports/security-scan-12345 remote_link_enabled: true logo_url: https://example.com/logos/securecode.png report_type: SECURITY result: PASSED data: vulnerabilities_found: 0 scanned_files: 142 scan_duration: 45s created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T10:30:45Z' pipeline-schedule: uuid: 123e4567-e89b-12d3-a456-426614174000 enabled: true target: ref_type: branch ref_name: main cron_pattern: 0 0 12 * * ? * created_on: '2023-11-15T10:30:00Z' updated_on: '2023-11-20T14:45:30Z' deployment-environment: uuid: 123e4567-e89b-12d3-a456-426614174000 name: production pipeline-variable_3: uuid: 3c7c1a4e-8f2d-4b9a-a1c5-6d8e9f0a1b2c key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false deployment-variable_2: uuid: 123e4567-e89b-12d3-a456-426614174000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false branch-restriction: users: links: self: href: https://api.bitbucket.org/2.0/users/johndoe created_on: '2023-01-15T10:30:00Z' display_name: John Doe username: johndoe uuid: '{12345678-1234-1234-1234-123456789abc}' groups: links: self: href: https://api.bitbucket.org/2.0/workspaces/acme/groups/developers name: developers html: href: https://bitbucket.org/acme/workspace/settings/groups/developers name: developers owner: created_on: '2022-05-10T08:00:00Z' display_name: Acme Corp username: acme uuid: '{87654321-4321-4321-4321-cba987654321}' workspace: slug: acme name: Acme Corporation name: Developers slug: developers full_slug: acme:developers pipeline-variable: uuid: 3c7e6a1b-4f2d-4e8a-9c5b-1a2b3c4d5e6f key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false project-deploy-key: key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC... project: key: PROJ name: My Project comment: deploy@server label: Production Server Deploy Key added_on: '2024-01-15T10:30:00Z' last_used: '2024-01-20T14:45:30Z' links: self: href: https://api.bitbucket.org/2.0/projects/PROJ/deploy-keys/123 name: Production Deploy Key created_by: uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' username: john_doe display_name: John Doe deployment-environment_2: uuid: 123e4567-e89b-12d3-a456-426614174000 name: production undefined_2: - id: annotation_123 report_id: report_456 user_id: user_789 text: This section needs clarification start_position: 150 end_position: 200 created_at: '2024-01-15T10:30:00Z' updated_at: '2024-01-15T10:30:00Z' - id: annotation_124 report_id: report_456 user_id: user_790 text: Data looks accurate start_position: 350 end_position: 400 created_at: '2024-01-15T11:45:00Z' updated_at: '2024-01-15T11:45:00Z' create-comment-on-pull-request: id: 12345 created_on: '2023-10-15T14:30:00.000Z' updated_on: '2023-10-15T15:45:00.000Z' content: raw: This looks good, but could you add some tests? markup: markdown html:

This looks good, but could you add some tests?

user: display_name: John Doe uuid: '{user-uuid}' username: johndoe deleted: false inline: to: 42 from: 38 path: src/main.js pullrequest: id: 789 title: Add new feature type: pullrequest links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/789 resolution: type: resolved created_on: '2023-10-15T16:00:00.000Z' user: display_name: Jane Smith uuid: '{user-uuid-2}' username: janesmith pending: false report-annotation_2: external_id: VULN-12345 uuid: 123e4567-e89b-12d3-a456-426614174000 annotation_type: VULNERABILITY path: src/main/java/com/example/Application.java line: 42 summary: SQL Injection vulnerability detected details: User input is directly concatenated into SQL query without proper sanitization. This could allow an attacker to execute arbitrary SQL commands. result: FAILED severity: HIGH link: https://security-tool.example.com/reports/VULN-12345 created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T14:45:30Z' snippet-comment: links: self: href: https://api.example.com/snippets/123/comments/456 name: self html: href: https://example.com/snippets/123/comments/456 name: html snippet: {} issue: links: self: href: https://api.example.com/repositories/myrepo/issues/123 name: 'Issue #123' html: href: https://example.com/myrepo/issues/123 name: View Issue comments: href: https://api.example.com/repositories/myrepo/issues/123/comments name: Comments attachments: href: https://api.example.com/repositories/myrepo/issues/123/attachments name: Attachments watch: href: https://api.example.com/repositories/myrepo/issues/123/watch name: Watch vote: href: https://api.example.com/repositories/myrepo/issues/123/vote name: Vote id: 123 repository: {} title: Fix login bug on mobile devices reporter: {} assignee: {} created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-16T14:22:00Z' edited_on: '2024-01-16T14:22:00Z' state: open kind: bug priority: major milestone: {} version: {} component: {} votes: 5 content: raw: Users are unable to log in when using mobile browsers. markup: markdown html:

Users are unable to log in when using mobile browsers.

tag: message: Release version 1.0.0 date: '2024-01-15T14:30:00Z' tagger: name: John Doe email: john.doe@example.com snippet: id: 12345 title: Example Code Snippet scm: git created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-20T14:45:00Z' owner: username: johndoe display_name: John Doe creator: username: johndoe display_name: John Doe is_private: true snippet-comment_2: links: self: href: https://api.bitbucket.org/2.0/snippets/example/comments/1 name: Self Link html: href: https://bitbucket.org/snippets/example/comments/1 name: HTML Link snippet: {} project: links: html: href: https://bitbucket.org/projects/example-project name: Example Project avatar: href: https://bitbucket.org/account/example-project/avatar/32 name: Avatar uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' key: PROJ owner: type: team uuid: '{12345678-90ab-cdef-1234-567890abcdef}' username: example-team display_name: Example Team name: Example Project description: This is an example project for organizing repositories is_private: true created_on: '2023-01-15T10:30:00Z' updated_on: '2024-01-20T14:45:00Z' has_publicly_visible_repos: false branch-restriction_2: users: links: self: href: https://api.bitbucket.org/2.0/users/example_user created_on: '2023-01-15T10:30:00Z' display_name: John Doe username: john_doe uuid: '{12345678-1234-1234-1234-123456789abc}' groups: links: self: href: https://api.bitbucket.org/2.0/groups/example_workspace/developers name: developers html: href: https://bitbucket.org/example_workspace/developers name: developers owner: created_on: '2022-05-20T08:15:00Z' display_name: Jane Smith username: jane_smith uuid: '{87654321-4321-4321-4321-cba987654321}' workspace: slug: example_workspace name: Example Workspace uuid: '{abcdef12-abcd-abcd-abcd-abcdef123456}' name: Developers slug: developers full_slug: example_workspace:developers pipeline-variable_5: uuid: 123e4567-e89b-12d3-a456-426614174000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false commit-comment: commit: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e author: name: Monalisa Octocat email: octocat@github.com date: '2011-04-14T16:00:49Z' committer: name: Monalisa Octocat email: octocat@github.com date: '2011-04-14T16:00:49Z' message: Fix all the bugs bulk-create-or-update-annotations_2: - report_annotation: Example annotation text pull-request-task-create: content: raw: Please review the authentication logic in the login handler comment: id: 12345 pending: false issue_2: links: self: href: https://api.example.com/repositories/myrepo/issues/123 name: 'Issue #123' html: href: https://example.com/myrepo/issues/123 name: View Issue comments: href: https://api.example.com/repositories/myrepo/issues/123/comments name: Comments attachments: href: https://api.example.com/repositories/myrepo/issues/123/attachments name: Attachments watch: href: https://api.example.com/repositories/myrepo/issues/123/watch name: Watch vote: href: https://api.example.com/repositories/myrepo/issues/123/vote name: Vote id: 123 repository: {} title: Fix login bug on mobile devices reporter: {} assignee: {} created_on: '2023-10-15T14:30:00Z' updated_on: '2023-10-16T09:15:00Z' edited_on: '2023-10-16T09:15:00Z' state: open kind: bug priority: major milestone: {} version: {} component: {} votes: 5 content: raw: 'Users are unable to login on mobile devices. Steps to reproduce: 1. Open app on mobile 2. Enter credentials 3. Click login' markup: markdown html: '

Users are unable to login on mobile devices. Steps to reproduce:

  1. Open app on mobile
  2. Enter credentials
  3. Click login
' commit-status_2: links: self: href: https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/a1b2c3d4/statuses/build/bb-deploy-123 name: Self Link commit: href: https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/a1b2c3d4 name: Commit Link uuid: '{12345678-1234-5678-1234-567812345678}' key: BB-DEPLOY refname: main url: https://builds.example.com/repositories/{repository.full_name}/commits/{commit} state: SUCCESSFUL name: BB-DEPLOY-1 description: Unit tests in Bamboo created_on: '2023-11-15T10:30:00Z' updated_on: '2023-11-15T10:45:00Z' commit-report_2: uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 title: Security Scan Report details: Automated security vulnerability scan for commit external_id: security-scan-12345 reporter: SecureCode Scanner v2.1 link: https://example.com/reports/security-scan-12345 remote_link_enabled: true logo_url: https://example.com/logos/securecode.png report_type: SECURITY result: PASSED data: vulnerabilities_found: 0 scanned_files: 42 created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T10:35:00Z' webhook-subscription_2: uuid: '{d7bb1ebe-7e0c-4a2f-9b4a-1c8e9f0a2b3c}' url: https://example.com/webhooks/bitbucket description: Webhook for monitoring pull request activities subject_type: repository subject: type: repository name: my-repo active: true created_at: '2024-01-15T10:30:00Z' events: - pullrequest:created - pullrequest:updated - pullrequest:approved - pullrequest:fulfilled - repo:push secret_set: true secret: my-webhook-secret-key-123 pipeline-known-host_2: uuid: 123e4567-e89b-12d3-a456-426614174000 hostname: github.com public_key: type: ssh-rsa key: AAAAB3NzaC1yc2EAAAADAQABAAABAQC7... md5_fingerprint: 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48 sha256_fingerprint: SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8 create-pull-request: type: pullrequest links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1 name: 'Pull Request #1' html: href: https://bitbucket.org/myworkspace/myrepo/pull-requests/1 name: 'Pull Request #1' commits: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/commits approve: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/approve diff: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/diff diffstat: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/diffstat comments: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/comments activity: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/activity merge: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/merge decline: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/decline id: 1 title: Add new feature rendered: title: raw: Add new feature markup: markdown html:

Add new feature

description: raw: This PR adds a new feature to improve functionality. markup: markdown html:

This PR adds a new feature to improve functionality.

reason: raw: '' markup: markdown html: '' summary: raw: This PR adds a new feature to improve functionality. markup: markdown html:

This PR adds a new feature to improve functionality.

state: OPEN author: type: account username: john_doe display_name: John Doe source: branch: name: feature/new-feature commit: hash: a1b2c3d4e5f repository: type: repository name: myrepo full_name: myworkspace/myrepo destination: branch: name: main commit: hash: f5e4d3c2b1a repository: type: repository name: myrepo full_name: myworkspace/myrepo merge_commit: hash: abc123def45 comment_count: 3 task_count: 1 close_source_branch: true closed_by: null reason: '' created_on: '2023-10-15T14:30:00.000Z' updated_on: '2023-10-16T09:15:00.000Z' reviewers: - type: account username: jane_smith display_name: Jane Smith participants: - type: participant user: type: account username: jane_smith display_name: Jane Smith role: REVIEWER approved: true participated_on: '2023-10-15T15:00:00.000Z' deployment-variable: uuid: 123e4567-e89b-12d3-a456-426614174000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false schemas: A_pullrequest_task_create: type: object title: Pull Request Task Create description: A pullrequest task create properties: content: type: object title: Task Raw Content description: task raw content properties: raw: type: string description: The task contents required: - raw additionalProperties: false example: example_value comment: $ref: '#/components/schemas/comment' pending: type: boolean example: true required: - content additionalProperties: false UsersUserKeys: required: - userAccountIds nullable: true type: object additionalProperties: true properties: users: type: array items: $ref: '#/components/schemas/User' example: [] userKeys: type: array items: type: string example: [] _links: $ref: '#/components/schemas/GenericLinks' pipeline_target: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Target description: A representation of the target that a pipeline executes on. properties: {} TopNavigationLookAndFeel: required: - highlightColor type: object properties: color: type: string nullable: true example: example_value highlightColor: type: string example: example_value hoverOrFocus: type: object properties: backgroundColor: type: string color: type: string example: example_value workspace: allOf: - $ref: '#/components/schemas/object' - type: object title: Workspace description: "A Bitbucket workspace.\n Workspaces are used to organize repositories." properties: links: type: object properties: avatar: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false members: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false owners: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false projects: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false repositories: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false snippets: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The workspace's immutable id. name: type: string description: The name of the workspace. slug: type: string description: The short label that identifies this workspace. is_private: type: boolean description: 'Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.' created_on: type: string format: date-time updated_on: type: string format: date-time additionalProperties: true HeaderLookAndFeel: required: - backgroundColor - button - primaryNavigation - search - secondaryNavigation type: object properties: backgroundColor: type: string example: example_value button: $ref: '#/components/schemas/ButtonLookAndFeel' primaryNavigation: $ref: '#/components/schemas/NavigationLookAndFeel' secondaryNavigation: $ref: '#/components/schemas/NavigationLookAndFeel' search: $ref: '#/components/schemas/SearchFieldLookAndFeel' deployment_environment: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment Environment description: A Bitbucket Deployment Environment. properties: uuid: type: string description: The UUID identifying the environment. name: type: string description: The name of the environment. x-bb-default-fields: - uuid x-bb-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/{uuid} x-bb-batch-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments_batch x-bb-batch-max-size: 100 SuperBatchWebResources: type: object properties: uris: type: object properties: all: oneOf: - type: array items: type: string - type: string css: oneOf: - type: array items: type: string - type: string js: oneOf: - type: array items: type: string - type: string example: example_value tags: type: object properties: all: type: string css: type: string data: type: string js: type: string example: example_value metatags: type: string example: example_value _expandable: type: object additionalProperties: true example: example_value comment_resolution: type: object title: Comment Resolution description: The resolution object for a Comment. properties: type: type: string example: example_value user: $ref: '#/components/schemas/account' created_on: type: string description: The ISO8601 timestamp the resolution was created. format: date-time example: '2026-01-15T10:30:00Z' required: - type additionalProperties: true object: type: 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`. properties: type: type: string example: example_value required: - type additionalProperties: true discriminator: propertyName: type ContentPropertyCreateNoKey: required: - value type: object additionalProperties: true properties: value: oneOf: - type: array items: type: string - type: boolean - type: object additionalProperties: true properties: {} - type: string description: The value of the content property. This can be empty or a complex object. example: example_value SpaceDescription: required: - embeddedContent - representation - value type: object additionalProperties: true properties: value: type: string example: example_value representation: type: string enum: - plain - view example: plain embeddedContent: type: array items: type: object properties: {} example: [] GenericUserKey: type: string nullable: true description: 'This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' ContentMetadata: type: object additionalProperties: true properties: currentuser: type: object properties: favourited: type: object properties: isFavourite: type: boolean favouritedDate: type: string format: date-time lastmodified: type: object properties: version: $ref: '#/components/schemas/Version' friendlyLastModified: type: string lastcontributed: type: object properties: status: type: string when: type: string format: date-time viewed: type: object properties: lastSeen: type: string format: date-time friendlyLastSeen: type: string scheduled: type: object _expandable: type: object properties: favourited: type: string lastmodified: type: string lastcontributed: type: string viewed: type: string scheduled: type: string example: example_value properties: $ref: '#/components/schemas/GenericLinks' frontend: type: object additionalProperties: true example: example_value labels: oneOf: - $ref: '#/components/schemas/LabelArray' - type: array items: $ref: '#/components/schemas/Label' example: example_value description: Metadata object for page, blogpost, comment content link: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri example: https://www.example.com name: type: string example: Example Title additionalProperties: false SpacePermission: required: - anonymousAccess - operation - unlicensedAccess type: object properties: id: type: integer format: int64 example: abc123 subjects: type: object properties: user: required: - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/User' size: type: integer format: int32 start: type: integer format: int32 limit: type: integer format: int32 group: required: - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/Group' size: type: integer format: int32 start: type: integer format: int32 limit: type: integer format: int32 _expandable: type: object properties: user: type: string group: type: string description: The users and/or groups that the permission applies to. example: example_value operation: $ref: '#/components/schemas/OperationCheckResult' anonymousAccess: type: boolean description: Grant anonymous users permission to use the operation. default: false example: true unlicensedAccess: type: boolean description: 'Grants access to unlicensed users from JIRA Service Desk when used with the ''read space'' operation.' default: false example: true description: "This object represents a permission for given space. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation` and `targetType` values are\nvalid for the `operation` object:\n\n - 'create': 'page', 'blogpost', 'comment', 'attachment'\n - 'read': 'space'\n - 'delete': 'page', 'blogpost', 'comment', 'attachment'\n - 'export': 'space'\n - 'administer': 'space'" ContentArray: required: - _links - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/Content' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' branchrestriction: allOf: - $ref: '#/components/schemas/object' - type: object title: Branch Restriction description: A branch restriction rule. properties: users: type: array items: $ref: '#/components/schemas/account' minItems: 0 groups: type: array items: $ref: '#/components/schemas/group' minItems: 0 additionalProperties: true ContentRestriction: required: - _expandable - _links - operation type: object properties: operation: type: string enum: - administer - copy - create - delete - export - move - purge - purge_version - read - restore - update - use example: administer restrictions: type: object properties: user: $ref: '#/components/schemas/UserArray' group: $ref: '#/components/schemas/GroupArray' _expandable: type: object properties: user: type: string group: type: string example: example_value content: $ref: '#/components/schemas/Content' _expandable: type: object properties: restrictions: type: string content: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' commit: allOf: - $ref: '#/components/schemas/base_commit' - type: object title: Commit description: A repository commit object. properties: repository: $ref: '#/components/schemas/repository' participants: type: array items: $ref: '#/components/schemas/participant' minItems: 0 additionalProperties: true pipeline_schedule: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Schedule description: A Pipelines schedule. properties: uuid: type: string description: The UUID identifying the schedule. enabled: type: boolean description: Whether the schedule is enabled. target: $ref: '#/components/schemas/pipeline_ref_target' cron_pattern: type: string description: 'The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day.' created_on: type: string format: date-time description: The timestamp when the schedule was created. updated_on: type: string format: date-time description: The timestamp when the schedule was updated. issue_comment: allOf: - $ref: '#/components/schemas/comment' - type: object title: Issue Comment description: A issue comment. properties: issue: $ref: '#/components/schemas/issue' additionalProperties: true snippet_comment: allOf: - $ref: '#/components/schemas/object' - type: object title: Snippet Comment description: A comment on a snippet. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false snippet: $ref: '#/components/schemas/snippet' additionalProperties: true Embeddable: type: object additionalProperties: true account: allOf: - $ref: '#/components/schemas/object' - type: object title: Account description: An account object. properties: links: $ref: '#/components/schemas/account_links' created_on: type: string format: date-time display_name: type: string username: type: string pattern: ^[a-zA-Z0-9_\-]+$ uuid: type: string additionalProperties: true participant: allOf: - $ref: '#/components/schemas/object' - type: object title: Participant description: Object describing a user's role on resources like commits or pull requests. properties: user: $ref: '#/components/schemas/account' role: type: string enum: - PARTICIPANT - REVIEWER approved: type: boolean state: type: string enum: - approved - changes_requested - null participated_on: type: string 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 additionalProperties: true A_pull_request_task: allOf: - $ref: '#/components/schemas/task' - type: object title: Pull Request Task description: A pull request task. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false additionalProperties: false ContainerLookAndFeel: required: - background - backgroundColor - backgroundImage - backgroundSize - borderRadius - padding type: object nullable: true properties: background: type: string example: example_value backgroundAttachment: type: string nullable: true example: example_value backgroundBlendMode: type: string nullable: true example: example_value backgroundClip: type: string nullable: true example: example_value backgroundColor: type: string nullable: true example: example_value backgroundImage: type: string nullable: true example: example_value backgroundOrigin: type: string nullable: true example: example_value backgroundPosition: type: string nullable: true example: example_value backgroundRepeat: type: string nullable: true example: example_value backgroundSize: type: string nullable: true example: example_value padding: type: string example: example_value borderRadius: type: string example: example_value MenusLookAndFeel: required: - color - hoverOrFocus type: object properties: hoverOrFocus: required: - backgroundColor type: object properties: backgroundColor: type: string example: example_value color: type: string example: example_value pullrequest_endpoint: type: object title: Pull Request Endpoint properties: repository: $ref: '#/components/schemas/repository' branch: type: object title: Pull Request Branch properties: name: type: string merge_strategies: type: array description: Available merge strategies, when this endpoint is the destination of the pull request. items: type: string enum: - merge_commit - squash - fast_forward default_merge_strategy: type: string description: The default merge strategy, when this endpoint is the destination of the pull request. additionalProperties: false example: example_value commit: type: object title: Pull Request Commit properties: hash: type: string pattern: '[0-9a-f]{7,}?' additionalProperties: false example: example_value additionalProperties: false tag: allOf: - $ref: '#/components/schemas/ref' - type: object title: Tag description: A tag object, representing a tag in a repository. properties: message: type: string description: The message associated with the tag, if available. date: type: string description: The date that the tag was created, if available format: date-time tagger: $ref: '#/components/schemas/author' additionalProperties: true pipeline_schedule_post_request_body: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Request body for Pipeline Schedule POST request properties: target: type: object description: The target on which the schedule will be executed. properties: selector: $ref: '#/components/schemas/pipeline_selector' ref_name: type: string description: The name of the reference. ref_type: type: string description: The type of reference (branch only). enum: - branch required: - selector - ref_name - ref_type enabled: type: boolean description: Whether the schedule is enabled. cron_pattern: type: string description: 'The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day.' required: - target - cron_pattern Icon: required: - height - isDefault - path - width type: object nullable: true properties: path: type: string example: example_value width: type: integer format: int32 example: 10 height: type: integer format: int32 example: 10 isDefault: type: boolean example: true description: This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. GenericAccountId: type: string nullable: true description: 'The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.' comment: allOf: - $ref: '#/components/schemas/object' - type: object title: Comment 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: id: type: integer created_on: type: string format: date-time updated_on: type: string format: date-time content: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false user: $ref: '#/components/schemas/account' deleted: type: boolean parent: $ref: '#/components/schemas/comment' inline: type: object properties: from: type: integer description: The comment's anchor line in the old version of the file. minimum: 1 to: type: integer description: The comment's anchor line in the new version of the file. If the 'from' line is also provided, this value will be removed. minimum: 1 path: type: string description: The path of the file this comment is anchored to. required: - path additionalProperties: false links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false code: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false additionalProperties: true repository: allOf: - $ref: '#/components/schemas/object' - type: object title: Repository description: A Bitbucket repository. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false avatar: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false pullrequests: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commits: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false forks: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false watchers: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false downloads: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false clone: type: array items: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false hooks: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string 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. full_name: type: string 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. is_private: type: boolean parent: $ref: '#/components/schemas/repository' scm: type: string enum: - git owner: $ref: '#/components/schemas/account' name: type: string description: type: string created_on: type: string format: date-time updated_on: type: string format: date-time size: type: integer language: type: string has_issues: type: boolean description: ' The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com. ' has_wiki: type: boolean description: ' The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. ' fork_policy: type: string description: "\nControls the rules for forking this repository.\n\n* **allow_forks**: unrestricted forking\n* **no_public_forks**: restrict forking to private forks (forks cannot\n be made public later)\n* **no_forks**: deny all forking\n" enum: - allow_forks - no_public_forks - no_forks project: $ref: '#/components/schemas/project' mainbranch: $ref: '#/components/schemas/branch' additionalProperties: true commit_comment: allOf: - $ref: '#/components/schemas/comment' - type: object title: Commit Comment description: A commit comment. properties: commit: $ref: '#/components/schemas/commit' additionalProperties: true ContentBody: required: - representation - value type: object properties: value: type: string example: example_value representation: type: string enum: - view - export_view - styled_view - storage - editor - editor2 - anonymous_export_view - wiki - atlas_doc_format - raw example: view embeddedContent: type: array items: $ref: '#/components/schemas/EmbeddedContent' example: [] webresource: $ref: '#/components/schemas/WebResourceDependencies' mediaToken: type: object properties: collectionIds: type: array items: type: string contentId: type: string expiryDateTime: type: string fileIds: type: array items: type: string token: type: string example: example_value _expandable: type: object properties: content: type: string embeddedContent: type: string webresource: type: string mediaToken: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' pipeline_selector: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Selector description: A representation of the selector that was used to identify the pipeline in the YML file. properties: type: enum: - branches - tags - bookmarks - default - custom type: string description: The type of selector. pattern: type: string description: The name of the matching pipeline definition. task: type: object title: Task description: A task object. properties: id: type: integer example: abc123 created_on: type: string format: date-time example: '2026-01-15T10:30:00Z' updated_on: type: string format: date-time example: '2026-01-15T10:30:00Z' state: type: string enum: - RESOLVED - UNRESOLVED example: RESOLVED content: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false example: example_value creator: $ref: '#/components/schemas/account' pending: type: boolean example: true resolved_on: type: string description: The ISO8601 timestamp for when the task was resolved. format: date-time example: '2026-01-15T10:30:00Z' resolved_by: $ref: '#/components/schemas/account' required: - created_on - updated_on - state - content - creator additionalProperties: false Version: required: - minorEdit - number - when type: object nullable: true additionalProperties: true properties: by: $ref: '#/components/schemas/User' when: type: string format: date-time nullable: true example: '2026-01-15T10:30:00Z' friendlyWhen: type: string nullable: true example: example_value message: type: string nullable: true example: example_value number: type: integer format: int32 description: Set this to the current version number incremented by one example: 10 minorEdit: description: 'If `minorEdit` is set to ''true'', no notification email or activity stream will be generated for the change.' type: boolean example: true content: $ref: '#/components/schemas/Content' collaborators: $ref: '#/components/schemas/UsersUserKeys' _expandable: type: object properties: content: type: string collaborators: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' contentTypeModified: type: boolean description: True if content type is modifed in this version (e.g. page to blog) example: true confRev: type: string nullable: true description: The revision id provided by confluence to be used as a revision in Synchrony example: example_value syncRev: type: string nullable: true description: The revision id provided by Synchrony example: example_value syncRevSource: type: string nullable: true description: Source of the synchrony revision example: example_value report: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Commit Report description: A report for a commit. properties: uuid: type: string description: The UUID that can be used to identify the report. title: type: string description: The title of the report. details: type: string description: A string to describe the purpose of the report. external_id: type: string description: ID of the report provided by the report creator. It can be used to identify the report as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the report creator for updating or deleting this specific report. Needs to be unique. reporter: type: string description: A string to describe the tool or company who created the report. link: type: string format: uri description: A URL linking to the results of the report in an external tool. remote_link_enabled: type: boolean description: If enabled, a remote link is created in Jira for the issue associated with the commit the report belongs to. logo_url: type: string format: uri description: A URL to the report logo. If none is provided, the default insights logo will be used. report_type: enum: - SECURITY - COVERAGE - TEST - BUG type: string description: The type of the report. result: enum: - PASSED - FAILED - PENDING type: string description: The state of the report. May be set to PENDING and later updated. data: type: array items: $ref: '#/components/schemas/report_data' description: An array of data fields to display information on the report. Maximum 10. created_on: type: string format: date-time description: The timestamp when the report was created. updated_on: type: string format: date-time description: The timestamp when the report was updated. x-bb-default-fields: - uuid - commitHash x-bb-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commitHash}/reports/{uuid} UserDetails: type: object properties: business: type: object properties: position: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' department: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' location: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' example: example_value personal: type: object properties: phone: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' im: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' website: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' email: type: string description: 'This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' example: example_value HorizontalHeaderLookAndFeel: required: - backgroundColor - primaryNavigation type: object properties: backgroundColor: type: string example: example_value button: $ref: '#/components/schemas/ButtonLookAndFeel' primaryNavigation: $ref: '#/components/schemas/TopNavigationLookAndFeel' secondaryNavigation: $ref: '#/components/schemas/NavigationLookAndFeel' search: $ref: '#/components/schemas/SearchFieldLookAndFeel' ButtonLookAndFeel: required: - backgroundColor - color type: object nullable: true properties: backgroundColor: type: string example: example_value color: type: string example: example_value error: type: object title: 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`. properties: type: type: string example: example_value error: type: object properties: message: type: string detail: type: string data: type: object description: Optional structured data that is endpoint-specific. properties: {} additionalProperties: true required: - message additionalProperties: false example: example_value required: - type additionalProperties: true ContentChildType: type: object properties: attachment: required: - _links - value type: object properties: value: type: boolean _links: $ref: '#/components/schemas/GenericLinks' example: example_value comment: required: - _links - value type: object properties: value: type: boolean _links: $ref: '#/components/schemas/GenericLinks' example: example_value page: required: - _links - value type: object properties: value: type: boolean _links: $ref: '#/components/schemas/GenericLinks' example: example_value _expandable: type: object properties: all: type: string attachment: type: string comment: type: string page: type: string whiteboard: type: string example: example_value additionalProperties: true description: 'Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn''t actually contain the child objects.' group: allOf: - $ref: '#/components/schemas/object' - type: object title: Group description: A group object properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false owner: $ref: '#/components/schemas/account' workspace: $ref: '#/components/schemas/workspace' name: type: string slug: type: string description: 'The "sluggified" version of the group''s name. This contains only ASCII characters and can therefore be slightly different than the name' full_slug: type: string description: 'The concatenation of the workspace''s slug and the group''s slug, separated with a colon (e.g. `acme:developers`) ' additionalProperties: true ContentHistory: required: - latest type: object nullable: true properties: latest: type: boolean example: true createdBy: $ref: '#/components/schemas/User' ownedBy: $ref: '#/components/schemas/User' lastOwnedBy: $ref: '#/components/schemas/User' createdDate: type: string format: date-time example: '2026-01-15T10:30:00Z' lastUpdated: $ref: '#/components/schemas/Version' previousVersion: $ref: '#/components/schemas/Version' contributors: type: object properties: publishers: $ref: '#/components/schemas/UsersUserKeys' example: example_value nextVersion: $ref: '#/components/schemas/Version' _expandable: type: object properties: lastUpdated: type: string previousVersion: type: string contributors: type: string nextVersion: type: string ownedBy: type: string lastOwnedBy: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' commitstatus: allOf: - $ref: '#/components/schemas/object' - type: object title: Commit Status description: A commit status object. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commit: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The commit status' id. key: type: string description: "An identifier for the status that's unique to\n its type (current \"build\" is the only supported type) and the vendor,\n e.g. BB-DEPLOY" refname: type: string description: ' 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).' url: type: string 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. state: type: string description: Provides some indication of the status of this commit enum: - INPROGRESS - FAILED - STOPPED - SUCCESSFUL name: type: string description: An identifier for the build itself, e.g. BB-DEPLOY-1 description: type: string description: A description of the build (e.g. "Unit tests in Bamboo") created_on: type: string format: date-time updated_on: type: string format: date-time additionalProperties: true component: allOf: - $ref: '#/components/schemas/object' - type: object title: Component description: A component as defined in a repository's issue tracker. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string id: type: integer additionalProperties: true ScreenLookAndFeel: required: - background type: object properties: background: type: string example: example_value backgroundAttachment: type: string nullable: true example: example_value backgroundBlendMode: type: string nullable: true example: example_value backgroundClip: type: string nullable: true example: example_value backgroundColor: type: string nullable: true example: example_value backgroundImage: type: string nullable: true example: example_value backgroundOrigin: type: string nullable: true example: example_value backgroundPosition: type: string nullable: true example: example_value backgroundRepeat: type: string nullable: true example: example_value backgroundSize: type: string nullable: true example: example_value layer: type: object properties: width: type: string height: type: string nullable: true example: example_value gutterTop: type: string nullable: true example: example_value gutterRight: type: string nullable: true example: example_value gutterBottom: type: string nullable: true example: example_value gutterLeft: type: string nullable: true example: example_value deployment_variable: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment Variable description: A Pipelines deployment variable. properties: uuid: type: string description: The UUID identifying the variable. key: type: string description: The unique name of the variable. value: type: string description: The value of the variable. If the variable is secured, this will be empty. secured: type: boolean description: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API. Group: required: - name - type - id type: object properties: type: type: string default: group enum: - group example: group name: type: string example: Example Title id: type: string example: abc123 _links: $ref: '#/components/schemas/GenericLinks' UserArray: required: - results type: object properties: results: type: array items: $ref: '#/components/schemas/User' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 totalSize: type: integer format: int64 default: 0 description: 'This property will return total count of the objects before pagination is applied. This value is returned if `shouldReturnTotalSize` is set to `true`.' example: 10 _links: $ref: '#/components/schemas/GenericLinks' Label: required: - id - label - name - prefix type: object properties: prefix: type: string example: example_value name: type: string example: Example Title id: type: string example: abc123 label: type: string example: Example Title account_links: type: object title: Account Links description: Links related to an Account. properties: avatar: $ref: '#/components/schemas/link' additionalProperties: true pipeline_known_host: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Known Host description: A Pipelines known host. properties: uuid: type: string description: The UUID identifying the known host. hostname: type: string description: The hostname of the known host. public_key: $ref: '#/components/schemas/pipeline_ssh_public_key' ContentProperty: required: - _links - id - key - value type: object additionalProperties: true properties: id: type: string example: abc123 key: type: string example: example_value value: oneOf: - type: array items: type: string - type: boolean - type: object additionalProperties: true properties: {} - type: string description: The value of the content property. This can be empty or a complex object. example: example_value version: required: - message - minorEdit - number - when type: object additionalProperties: true properties: when: type: string format: date-time message: type: string number: type: integer format: int32 minorEdit: type: boolean contentTypeModified: type: boolean description: True if content type is modifed in this version (e.g. page to blog) example: example_value _links: $ref: '#/components/schemas/GenericLinks' _expandable: type: object properties: content: type: string additionalProperties: type: string example: example_value ContentChildren: type: object additionalProperties: true properties: attachment: $ref: '#/components/schemas/ContentArray' comment: $ref: '#/components/schemas/ContentArray' page: $ref: '#/components/schemas/ContentArray' _expandable: type: object additionalProperties: true properties: attachment: type: string comment: type: string page: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' LookAndFeel: required: - bordersAndDividers - content - header - headings - links - menus type: object properties: headings: required: - color type: object properties: color: type: string example: example_value links: required: - color type: object properties: color: type: string example: example_value menus: $ref: '#/components/schemas/MenusLookAndFeel' header: $ref: '#/components/schemas/HeaderLookAndFeel' horizontalHeader: $ref: '#/components/schemas/HorizontalHeaderLookAndFeel' content: $ref: '#/components/schemas/ContentLookAndFeel' bordersAndDividers: required: - color type: object properties: color: type: string example: example_value spaceReference: type: object nullable: true example: example_value OperationCheckResult: required: - operation - targetType type: object properties: operation: type: string description: The operation itself. enum: - administer - archive - clear_permissions - copy - create - create_space - delete - export - move - purge - purge_version - read - restore - restrict_content - update - use example: administer targetType: type: string description: The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space example: example_value description: An operation and the target entity that it applies to, e.g. create page. base_commit: allOf: - $ref: '#/components/schemas/object' - type: object title: Base Commit description: The common base type for both repository and snippet commits. properties: hash: type: string pattern: '[0-9a-f]{7,}?' date: type: string format: date-time author: $ref: '#/components/schemas/author' message: type: string summary: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false parents: type: array items: $ref: '#/components/schemas/base_commit' minItems: 0 additionalProperties: true ContentLookAndFeel: type: object properties: screen: $ref: '#/components/schemas/ScreenLookAndFeel' container: $ref: '#/components/schemas/ContainerLookAndFeel' header: $ref: '#/components/schemas/ContainerLookAndFeel' body: $ref: '#/components/schemas/ContainerLookAndFeel' webhook_subscription: allOf: - $ref: '#/components/schemas/object' - type: object title: Webhook Subscription description: A Webhook subscription. properties: uuid: type: string description: The webhook's id url: type: string description: The URL events get delivered to. format: uri description: type: string description: A user-defined description of the webhook. subject_type: type: string description: The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined. enum: - repository - workspace subject: $ref: '#/components/schemas/object' active: type: boolean created_at: type: string format: date-time events: type: array description: The events this webhook is subscribed to. items: type: string enum: - pullrequest:comment_reopened - pullrequest:approved - issue:comment_created - repo:push - pullrequest:comment_deleted - pullrequest:fulfilled - pullrequest:comment_created - pullrequest:comment_updated - pullrequest:updated - repo:commit_status_created - pullrequest:unapproved - repo:updated - pullrequest:comment_resolved - repo:transfer - repo:commit_status_updated - pullrequest:changes_request_created - issue:updated - repo:created - pullrequest:changes_request_removed - pullrequest:rejected - pullrequest:created - issue:created - repo:imported - repo:commit_comment_created - project:updated - repo:fork - repo:deleted minItems: 1 uniqueItems: true secret_set: type: boolean description: Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates. secret: type: string description: The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to `null` or "" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret. minLength: 0 maxLength: 128 additionalProperties: true NavigationLookAndFeel: required: - color - hoverOrFocus type: object nullable: true properties: color: type: string example: example_value highlightColor: type: string nullable: true example: example_value hoverOrFocus: required: - backgroundColor - color type: object properties: backgroundColor: type: string color: type: string example: example_value branch: allOf: - $ref: '#/components/schemas/ref' - type: object title: Branch description: A branch object, representing a branch in a repository. properties: merge_strategies: type: array description: Available merge strategies for pull requests targeting this branch. items: type: string enum: - merge_commit - squash - fast_forward default_merge_strategy: type: string description: The default merge strategy for pull requests targeting this branch. additionalProperties: true milestone: allOf: - $ref: '#/components/schemas/object' - type: object title: Milestone description: A milestone as defined in a repository's issue tracker. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string id: type: integer additionalProperties: true ref: type: object title: Ref description: A ref object, representing a branch or tag in a repository. properties: type: type: string example: example_value links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commits: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value name: type: string description: The name of the ref. example: Example Title target: $ref: '#/components/schemas/commit' required: - type additionalProperties: true LabelArray: required: - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/Label' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' Space: required: - _expandable - _links - key - name - status - type nullable: true type: object properties: id: type: integer format: int64 example: abc123 key: type: string example: example_value name: type: string example: Example Title icon: $ref: '#/components/schemas/Icon' description: type: object properties: plain: $ref: '#/components/schemas/SpaceDescription' view: $ref: '#/components/schemas/SpaceDescription' _expandable: type: object properties: view: type: string plain: type: string example: A sample description. homepage: $ref: '#/components/schemas/Content' type: type: string example: example_value metadata: type: object properties: labels: $ref: '#/components/schemas/LabelArray' _expandable: type: object example: example_value operations: type: array items: $ref: '#/components/schemas/OperationCheckResult' example: [] permissions: type: array items: $ref: '#/components/schemas/SpacePermission' example: [] status: type: string example: example_value settings: $ref: '#/components/schemas/SpaceSettings' theme: $ref: '#/components/schemas/Theme' lookAndFeel: $ref: '#/components/schemas/LookAndFeel' history: required: - createdDate type: object properties: createdDate: type: string format: date-time createdBy: $ref: '#/components/schemas/User' example: example_value _expandable: type: object properties: settings: type: string metadata: type: string operations: type: string lookAndFeel: type: string permissions: type: string icon: type: string description: type: string theme: type: string history: type: string homepage: type: string identifiers: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' pipeline_ref_target: allOf: - $ref: '#/components/schemas/pipeline_target' - additionalProperties: true type: object title: Pipeline Ref Target description: A Bitbucket Pipelines reference target. properties: ref_type: enum: - branch - tag - named_branch - bookmark type: string description: The type of reference (branch/tag). ref_name: type: string description: The name of the reference. commit: $ref: '#/components/schemas/commit' selector: $ref: '#/components/schemas/pipeline_selector' GenericLinks: type: object additionalProperties: oneOf: - type: object additionalProperties: true - type: string team_links: allOf: - $ref: '#/components/schemas/account_links' - type: object title: Team Links description: Links related to a Team. properties: self: $ref: '#/components/schemas/link' html: $ref: '#/components/schemas/link' members: $ref: '#/components/schemas/link' projects: $ref: '#/components/schemas/link' repositories: $ref: '#/components/schemas/link' additionalProperties: true project: allOf: - $ref: '#/components/schemas/object' - type: object title: Project description: "A Bitbucket project.\n Projects are used by teams to organize repositories." properties: links: type: object properties: html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false avatar: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The project's immutable id. key: type: string description: The project's key. owner: $ref: '#/components/schemas/team' name: type: string description: The name of the project. description: type: string is_private: type: boolean description: ' 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.' created_on: type: string format: date-time updated_on: type: string format: date-time has_publicly_visible_repos: type: boolean description: ' Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories.' additionalProperties: true A_pullrequest_comment_task: allOf: - $ref: '#/components/schemas/A_pull_request_task' - type: object title: Pull Request Comment Task description: A pullrequest comment task properties: comment: $ref: '#/components/schemas/comment' additionalProperties: false issue: allOf: - $ref: '#/components/schemas/object' - type: object title: Issue description: An issue. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false comments: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false attachments: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false watch: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false vote: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false id: type: integer repository: $ref: '#/components/schemas/repository' title: type: string reporter: $ref: '#/components/schemas/account' assignee: $ref: '#/components/schemas/account' created_on: type: string format: date-time updated_on: type: string format: date-time edited_on: type: string format: date-time state: type: string enum: - submitted - new - open - resolved - on hold - invalid - duplicate - wontfix - closed kind: type: string enum: - bug - enhancement - proposal - task priority: type: string enum: - trivial - minor - major - critical - blocker milestone: $ref: '#/components/schemas/milestone' version: $ref: '#/components/schemas/version' component: $ref: '#/components/schemas/component' votes: type: integer content: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false additionalProperties: true pullrequest: allOf: - $ref: '#/components/schemas/object' - type: object title: Pull Request description: A pull request object. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commits: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false approve: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false diff: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false diffstat: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false comments: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false activity: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false merge: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false decline: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false id: type: integer description: The pull request's unique ID. Note that pull request IDs are only unique within their associated repository. title: type: string description: Title of the pull request. rendered: type: object title: Rendered Pull Request Markup description: User provided pull request text, interpreted in a markup language and rendered in HTML properties: title: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false description: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false reason: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false additionalProperties: false summary: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false state: type: string description: The pull request's current status. enum: - OPEN - MERGED - DECLINED - SUPERSEDED author: $ref: '#/components/schemas/account' source: $ref: '#/components/schemas/pullrequest_endpoint' destination: $ref: '#/components/schemas/pullrequest_endpoint' merge_commit: type: object title: Pull Request Commit properties: hash: type: string pattern: '[0-9a-f]{7,}?' additionalProperties: false comment_count: type: integer description: The number of comments for a specific pull request. minimum: 0 task_count: type: integer description: The number of open tasks for a specific pull request. minimum: 0 close_source_branch: type: boolean description: A boolean flag indicating if merging the pull request closes the source branch. closed_by: $ref: '#/components/schemas/account' reason: type: string description: Explains why a pull request was declined. This field is only applicable to pull requests in rejected state. created_on: type: string description: The ISO8601 timestamp the request was created. format: date-time updated_on: type: string description: The ISO8601 timestamp the request was last updated. format: date-time reviewers: type: array 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' participants: type: array 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' additionalProperties: true SearchFieldLookAndFeel: required: - backgroundColor - color type: object nullable: true properties: backgroundColor: type: string example: example_value color: type: string example: example_value author: allOf: - $ref: '#/components/schemas/object' - type: object title: Author description: The author of a change in a repository properties: raw: type: string 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. user: $ref: '#/components/schemas/account' additionalProperties: true EmbeddedContent: type: object additionalProperties: true properties: entityId: type: integer format: int64 example: '500123' entityType: type: string example: example_value entity: $ref: '#/components/schemas/Embeddable' WebResourceDependencies: type: object properties: _expandable: type: object additionalProperties: true properties: uris: oneOf: - type: string - type: object additionalProperties: true example: example_value keys: type: array items: type: string example: [] contexts: type: array items: type: string example: [] uris: type: object properties: all: oneOf: - type: array items: type: string - type: string css: oneOf: - type: array items: type: string - type: string js: oneOf: - type: array items: type: string - type: string _expandable: type: object additionalProperties: true properties: css: oneOf: - type: array items: type: string - type: string js: oneOf: - type: array items: type: string - type: string example: example_value tags: type: object properties: all: type: string css: type: string data: type: string js: type: string _expandable: type: object additionalProperties: true example: example_value superbatch: $ref: '#/components/schemas/SuperBatchWebResources' team: allOf: - $ref: '#/components/schemas/account' - type: object title: Team description: A team object. properties: links: $ref: '#/components/schemas/team_links' additionalProperties: true project_deploy_key: allOf: - $ref: '#/components/schemas/object' - type: object title: Project Deploy Key description: Represents deploy key for a project. properties: key: type: string description: The deploy key value. project: $ref: '#/components/schemas/project' comment: type: string description: The comment parsed from the deploy key (if present) label: type: string description: The user-defined label for the deploy key added_on: type: string format: date-time last_used: type: string format: date-time links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false created_by: $ref: '#/components/schemas/account' additionalProperties: true snippet: allOf: - $ref: '#/components/schemas/object' - type: object title: Snippet description: A snippet object. properties: id: type: integer minimum: 0 title: type: string scm: type: string description: The DVCS used to store the snippet. enum: - git created_on: type: string format: date-time updated_on: type: string format: date-time owner: $ref: '#/components/schemas/account' creator: $ref: '#/components/schemas/account' is_private: type: boolean additionalProperties: true report_annotation: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Report Annotation description: A report for a commit. properties: external_id: type: string description: ID of the annotation provided by the annotation creator. It can be used to identify the annotation as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the annotation creator for updating or deleting this specific annotation. Needs to be unique. uuid: type: string description: The UUID that can be used to identify the annotation. annotation_type: enum: - VULNERABILITY - CODE_SMELL - BUG type: string description: The type of the report. path: type: string description: The path of the file on which this annotation should be placed. This is the path of the file relative to the git repository. If no path is provided, then it will appear in the overview modal on all pull requests where the tip of the branch is the given commit, regardless of which files were modified. line: type: integer description: The line number that the annotation should belong to. If no line number is provided, then it will default to 0 and in a pull request it will appear at the top of the file specified by the path field. minimum: 1 summary: type: string description: The message to display to users. details: type: string description: The details to show to users when clicking on the annotation. result: enum: - PASSED - FAILED - SKIPPED - IGNORED type: string description: The state of the report. May be set to PENDING and later updated. severity: enum: - CRITICAL - HIGH - MEDIUM - LOW type: string description: The severity of the annotation. link: type: string format: uri description: A URL linking to the annotation in an external tool. created_on: type: string format: date-time description: The timestamp when the report was created. updated_on: type: string format: date-time description: The timestamp when the report was updated. x-bb-default-fields: - uuid x-bb-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commit.hash}/reports/{reportUuid}/annotations/{uuid} version: allOf: - $ref: '#/components/schemas/object' - type: object title: Version description: A version as defined in a repository's issue tracker. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string id: type: integer additionalProperties: true Theme: required: - themeKey type: object properties: themeKey: type: string example: example_value name: type: string example: Example Title description: type: string example: A sample description. icon: $ref: '#/components/schemas/Icon' _links: $ref: '#/components/schemas/GenericLinks' report_data: type: object title: Report Data description: A key-value element that will be displayed along with the report. properties: type: enum: - BOOLEAN - DATE - DURATION - LINK - NUMBER - PERCENTAGE - TEXT type: string description: The type of data contained in the value field. If not provided, then the value will be detected as a boolean, number or string. example: BOOLEAN title: type: string description: A string describing what this data field represents. example: Example Title value: type: object description: The value of the data element. example: example_value ContentPropertyCreate: required: - key - value type: object additionalProperties: true properties: key: maxLength: 255 type: string description: The key of the new property. example: example_value value: oneOf: - type: array items: type: string - type: boolean - type: object additionalProperties: true properties: {} - type: string description: The value of the content property. This can be empty or a complex object. example: example_value pipeline_variable: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Variable description: A Pipelines variable. properties: uuid: type: string description: The UUID identifying the variable. key: type: string description: The unique name of the variable. value: type: string description: The value of the variable. If the variable is secured, this will be empty. secured: type: boolean description: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API. Container: type: object nullable: true additionalProperties: true description: 'Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)' User: required: - type type: object additionalProperties: true nullable: true properties: type: type: string enum: - known - unknown - anonymous - user example: known username: $ref: '#/components/schemas/GenericUserName' userKey: $ref: '#/components/schemas/GenericUserKey' accountId: $ref: '#/components/schemas/GenericAccountId' accountType: type: string description: The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. enum: - atlassian - app - '' example: atlassian email: nullable: true type: string description: The email address of the user. Depending on the user's privacy setting, this may return an empty string. example: user@example.com publicName: type: string description: The public name or nickname of the user. Will always contain a value. example: example_value profilePicture: $ref: '#/components/schemas/Icon' displayName: nullable: true type: string description: The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. example: example_value timeZone: nullable: true type: string description: This displays user time zone. Depending on the user's privacy setting, this may return null. example: example_value isExternalCollaborator: type: boolean description: Whether the user is an external collaborator user example: true externalCollaborator: type: boolean description: Whether the user is an external collaborator user example: true operations: nullable: true type: array items: $ref: '#/components/schemas/OperationCheckResult' example: [] details: $ref: '#/components/schemas/UserDetails' personalSpace: $ref: '#/components/schemas/Space' _expandable: type: object properties: operations: type: string details: type: string personalSpace: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' pipeline_ssh_public_key: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline SSH Public Key description: A Pipelines known host public key. properties: key_type: type: string description: The type of the public key. key: type: string description: The base64 encoded public key. md5_fingerprint: type: string description: The MD5 fingerprint of the public key. sha256_fingerprint: type: string description: The SHA-256 fingerprint of the public key. pullrequest_comment: allOf: - $ref: '#/components/schemas/comment' - type: object title: Pull Request Comment description: A pullrequest comment. properties: pullrequest: $ref: '#/components/schemas/pullrequest' resolution: $ref: '#/components/schemas/comment_resolution' pending: type: boolean additionalProperties: true GroupArray: required: - limit - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/Group' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 Content: required: - status - type nullable: true type: object additionalProperties: true properties: id: type: string example: abc123 type: type: string description: Can be "page", "blogpost", "attachment" or "content" example: example_value status: type: string example: example_value title: type: string example: Example Title space: $ref: '#/components/schemas/Space' history: $ref: '#/components/schemas/ContentHistory' version: $ref: '#/components/schemas/Version' ancestors: nullable: true type: array items: $ref: '#/components/schemas/Content' example: [] operations: type: array items: $ref: '#/components/schemas/OperationCheckResult' example: [] children: $ref: '#/components/schemas/ContentChildren' childTypes: $ref: '#/components/schemas/ContentChildType' descendants: $ref: '#/components/schemas/ContentChildren' container: $ref: '#/components/schemas/Container' body: type: object properties: view: $ref: '#/components/schemas/ContentBody' export_view: $ref: '#/components/schemas/ContentBody' styled_view: $ref: '#/components/schemas/ContentBody' storage: $ref: '#/components/schemas/ContentBody' wiki: $ref: '#/components/schemas/ContentBody' editor: $ref: '#/components/schemas/ContentBody' editor2: $ref: '#/components/schemas/ContentBody' anonymous_export_view: $ref: '#/components/schemas/ContentBody' atlas_doc_format: $ref: '#/components/schemas/ContentBody' dynamic: $ref: '#/components/schemas/ContentBody' raw: $ref: '#/components/schemas/ContentBody' _expandable: type: object properties: editor: type: string view: type: string export_view: type: string styled_view: type: string storage: type: string editor2: type: string anonymous_export_view: type: string atlas_doc_format: type: string wiki: type: string dynamic: type: string raw: type: string example: example_value restrictions: type: object properties: read: $ref: '#/components/schemas/ContentRestriction' update: $ref: '#/components/schemas/ContentRestriction' _expandable: type: object properties: read: type: string update: type: string _links: $ref: '#/components/schemas/GenericLinks' example: example_value metadata: $ref: '#/components/schemas/ContentMetadata' macroRenderedOutput: type: object additionalProperties: type: object example: example_value extensions: type: object example: example_value _expandable: type: object properties: childTypes: type: string container: type: string metadata: type: string operations: type: string children: type: string restrictions: type: string history: type: string ancestors: type: string body: type: string version: type: string descendants: type: string space: type: string extensions: type: string schedulePublishDate: type: string schedulePublishInfo: type: string macroRenderedOutput: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' description: Base object for all content types. GenericUserName: type: string nullable: true description: 'This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' SpaceSettings: nullable: true required: - _links - routeOverrideEnabled type: object properties: routeOverrideEnabled: type: boolean description: 'Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.' example: true editor: required: - page - blogpost - default type: object properties: page: type: string blogpost: type: string default: type: string example: example_value spaceKey: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' requestBodies: project: content: application/json: schema: $ref: '#/components/schemas/project' required: true snippet: content: application/json: schema: $ref: '#/components/schemas/snippet' description: The new snippet object. required: true pipeline_variable2: content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' description: The variable to create. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com. oauth2: type: oauth2 description: OAuth 2.0 authorization for Atlassian Cloud APIs. flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize tokenUrl: https://auth.atlassian.com/oauth/token scopes: read:org:admin: Read organization information. write:org:admin: Modify organization settings. read:user:admin: Read user information. write:user:admin: Modify user accounts. read:policy:admin: Read organization policies. write:policy:admin: Modify organization policies. read:event:admin: Read organization events. externalDocs: description: Atlassian Admin REST API Documentation url: https://developer.atlassian.com/cloud/admin/organization/rest/intro/