pipeline_step_error
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Step Error",
"properties": {
"key": {
"type": "string",
"description": "The error key."
},
"message": {
"type": "string",
"description": "The error message."
}
},
"description": "An error causing a step failure.",
"additionalProperties": true
}
]
}
pipeline_step_state
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Step State",
"properties": {},
"description": "The representation of the progress state of a pipeline step.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"COMPLETED"
],
"type": "string",
"description": "The name of pipeline step state (COMPLETED)."
},
"result": {
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
}
},
"description": "A Bitbucket Pipelines COMPLETED pipeline step state.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_error
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"ERROR"
],
"type": "string",
"description": "The name of the result (ERROR)"
},
"error": {
"$ref": "#/components/schemas/pipeline_step_error"
}
},
"description": "A Bitbucket Pipelines ERROR pipeline step result.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_expired
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"EXPIRED"
],
"type": "string",
"description": "The name of the result (EXPIRED)"
}
},
"description": "A Bitbucket Pipelines EXPIRED pipeline step result.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_failed
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"FAILED"
],
"type": "string",
"description": "The name of the result (FAILED)"
}
},
"description": "A Bitbucket Pipelines FAILED pipeline step result.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_not_run
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"NOT_RUN"
],
"type": "string",
"description": "The name of the result (NOT_RUN)"
}
},
"description": "A Bitbucket Pipelines NOT_RUN pipeline step result.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_result
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Completed Step Result",
"properties": {},
"description": "A result of a completed pipeline step state.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_stopped
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"STOPPED"
],
"type": "string",
"description": "The name of the result (STOPPED)"
}
},
"description": "A Bitbucket Pipelines STOPPED pipeline step result.",
"additionalProperties": true
}
]
}
pipeline_step_state_completed_successful
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"SUCCESSFUL"
],
"type": "string",
"description": "The name of the result (SUCCESSFUL)"
}
},
"description": "A Bitbucket Pipelines SUCCESSFUL pipeline step result.",
"additionalProperties": true
}
]
}
pipeline_step_state_in_progress
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"IN_PROGRESS"
],
"type": "string",
"description": "The name of pipeline step state (IN_PROGRESS)."
}
},
"description": "A Bitbucket Pipelines IN_PROGRESS pipeline step state.",
"additionalProperties": true
}
]
}
pipeline_step_state_pending
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"PENDING"
],
"type": "string",
"description": "The name of pipeline step state (PENDING)."
}
},
"description": "A Bitbucket Pipelines PENDING pipeline step state.",
"additionalProperties": true
}
]
}
pipeline_step_state_ready
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_step_state"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"READY"
],
"type": "string",
"description": "The name of pipeline step state (READY)."
}
},
"description": "A Bitbucket Pipelines READY pipeline step state.",
"additionalProperties": true
}
]
}
pipeline_target
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Target",
"properties": {},
"description": "A representation of the target that a pipeline executes on.",
"additionalProperties": true
}
]
}
pipeline_trigger
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Trigger",
"properties": {},
"description": "A representation of the trigger used for a pipeline.",
"additionalProperties": true
}
]
}
pipeline_trigger_manual
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_trigger"
},
{
"type": "object",
"title": "Pipeline Manual Trigger",
"properties": {},
"description": "A Bitbucket Pipelines MANUAL trigger.",
"additionalProperties": true
}
]
}
pipeline_trigger_push
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_trigger"
},
{
"type": "object",
"title": "Pipeline Push Trigger",
"properties": {},
"description": "A Bitbucket Pipelines PUSH trigger.",
"additionalProperties": true
}
]
}
pipeline_variable
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Variable",
"properties": {
"key": {
"type": "string",
"description": "The unique name of the variable."
},
"uuid": {
"type": "string",
"description": "The UUID identifying 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."
}
},
"description": "A Pipelines variable.",
"additionalProperties": true
}
]
}
pipelines_config
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipelines Configuration",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether Pipelines is enabled for the repository."
},
"repository": {
"$ref": "#/components/schemas/repository"
}
},
"description": "The Pipelines configuration for a repository.",
"additionalProperties": true
}
]
}
pipelines_ddev_links_section_href
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Links href",
"properties": {
"href": {
"type": "string",
"format": "uri",
"description": "A link"
}
},
"description": "A links section href",
"additionalProperties": true
}
]
}
pipelines_ddev_pipeline
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID identifying the pipeline."
},
"links": {
"$ref": "#/components/schemas/pipelines_ddev_pipeline_links"
},
"state": {
"$ref": "#/components/schemas/pipeline_state"
},
"target": {
"$ref": "#/components/schemas/pipeline_target"
},
"creator": {
"$ref": "#/components/schemas/account"
},
"trigger": {
"$ref": "#/components/schemas/pipeline_trigger"
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pipeline_variable"
},
"minItems": 0,
"description": "The variables for the pipeline."
},
"created_on": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the pipeline was created."
},
"repository": {
"$ref": "#/components/schemas/repository"
},
"build_number": {
"type": "integer",
"description": "The build number of the pipeline."
},
"completed_on": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress."
},
"build_seconds_used": {
"type": "integer",
"description": "The number of build seconds used by this pipeline."
}
},
"description": "A Bitbucket Pipeline. This represents an actual pipeline result.",
"additionalProperties": true
}
]
}
pipelines_ddev_pipeline_error
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Error",
"properties": {
"key": {
"type": "string",
"description": "The error key."
},
"message": {
"type": "string",
"description": "The error message"
}
},
"description": "An error causing a pipeline failure.",
"additionalProperties": true
}
]
}
pipelines_ddev_pipeline_links
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Links",
"properties": {
"self": {
"$ref": "#/components/schemas/pipelines_ddev_links_section_href"
},
"steps": {
"$ref": "#/components/schemas/pipelines_ddev_links_section_href"
}
},
"description": "Links section for a Pipeline.",
"additionalProperties": true
}
]
}
pipelines_ddev_pipeline_step
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"description": "A step of a Bitbucket pipeline. This represents the actual result of the step execution.",
"additionalProperties": true
}
],
"x-bb-url": "/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}",
"x-bb-batch-url": "/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/steps_batch",
"x-bb-batch-max-size": 100,
"x-bb-default-fields": [
"uuid"
]
}
pipelines_stg_west_pipeline_step
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"description": "A step of a Bitbucket pipeline. This represents the actual result of the step execution.",
"additionalProperties": true
}
],
"x-bb-url": "/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid}",
"x-bb-batch-url": "/rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/steps_batch",
"x-bb-batch-max-size": 100,
"x-bb-default-fields": [
"uuid"
]
}
project
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Project",
"properties": {
"key": {
"type": "string",
"description": "The project's key."
},
"name": {
"type": "string",
"description": "The name of the project."
},
"uuid": {
"type": "string",
"description": "The project's immutable id."
},
"links": {
"type": "object",
"properties": {
"html": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"avatar": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"owner": {
"$ref": "#/components/schemas/team"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"is_private": {
"type": "boolean",
"description": "\nIndicates whether the project is publicly accessible, or whether it is\nprivate to the team and consequently only visible to team members.\nNote that private projects cannot contain public repositories."
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"has_publicly_visible_repos": {
"type": "boolean",
"description": "\nIndicates whether the project contains publicly visible repositories.\nNote that private projects cannot contain public repositories."
}
},
"description": "A Bitbucket project.\n Projects are used by teams to organize repositories.",
"additionalProperties": true
}
]
}
project_branching_model
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Project Branching Model",
"properties": {
"production": {
"type": "object",
"required": [
"name",
"use_mainbranch"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the target branch. If inherited by a repository, it will default to the main branch if the specified branch does not exist."
},
"use_mainbranch": {
"type": "boolean",
"description": "Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`)."
}
}
},
"development": {
"type": "object",
"required": [
"name",
"use_mainbranch"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the target branch. If inherited by a repository, it will default to the main branch if the specified branch does not exist."
},
"use_mainbranch": {
"type": "boolean",
"description": "Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`)."
}
}
},
"branch_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"prefix"
],
"properties": {
"kind": {
"enum": [
"feature",
"bugfix",
"release",
"hotfix"
],
"type": "string",
"description": "The kind of branch."
},
"prefix": {
"type": "string",
"description": "The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`."
}
}
},
"maxItems": 4,
"minItems": 0,
"description": "The active branch types.",
"uniqueItems": true
}
},
"description": "A project's branching model",
"additionalProperties": true
}
]
}
project_deploy_key
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Project Deploy Key",
"properties": {
"key": {
"type": "string",
"description": "The deploy key value."
},
"label": {
"type": "string",
"description": "The user-defined label for the deploy key"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"comment": {
"type": "string",
"description": "The comment parsed from the deploy key (if present)"
},
"project": {
"$ref": "#/components/schemas/project"
},
"added_on": {
"type": "string",
"format": "date-time"
},
"last_used": {
"type": "string",
"format": "date-time"
},
"created_by": {
"$ref": "#/components/schemas/account"
}
},
"description": "Represents deploy key for a project.",
"additionalProperties": true
}
]
}
project_group_permission
{
"type": "object",
"title": "Project Group Permission",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"group": {
"$ref": "#/components/schemas/group"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"project": {
"$ref": "#/components/schemas/project"
},
"permission": {
"enum": [
"read",
"write",
"create-repo",
"admin",
"none"
],
"type": "string"
}
},
"description": "A group's permission for a given project.",
"additionalProperties": true
}
project_user_permission
{
"type": "object",
"title": "Project User Permission",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/user"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"project": {
"$ref": "#/components/schemas/project"
},
"permission": {
"enum": [
"read",
"write",
"create-repo",
"admin",
"none"
],
"type": "string"
}
},
"description": "A user's direct permission for a given project.",
"additionalProperties": true
}
pullrequest
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pull Request",
"properties": {
"id": {
"type": "integer",
"description": "The pull request's unique ID. Note that pull request IDs are only unique within their associated repository."
},
"links": {
"type": "object",
"properties": {
"diff": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"html": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"merge": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"approve": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"commits": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"decline": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"activity": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"comments": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"diffstat": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"state": {
"enum": [
"OPEN",
"MERGED",
"DECLINED",
"SUPERSEDED"
],
"type": "string",
"description": "The pull request's current status."
},
"title": {
"type": "string",
"description": "Title of the pull request."
},
"author": {
"$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."
},
"source": {
"$ref": "#/components/schemas/pullrequest_endpoint"
},
"summary": {
"type": "object",
"properties": {
"raw": {
"type": "string",
"description": "The text as it was typed by a user."
},
"html": {
"type": "string",
"description": "The user's content rendered as HTML."
},
"markup": {
"enum": [
"markdown",
"creole",
"plaintext"
],
"type": "string",
"description": "The type of markup language the raw content is to be interpreted in."
}
}
},
"rendered": {
"type": "object",
"title": "Rendered Pull Request Markup",
"properties": {
"title": {
"type": "object",
"properties": {
"raw": {
"type": "string",
"description": "The text as it was typed by a user."
},
"html": {
"type": "string",
"description": "The user's content rendered as HTML."
},
"markup": {
"enum": [
"markdown",
"creole",
"plaintext"
],
"type": "string",
"description": "The type of markup language the raw content is to be interpreted in."
}
}
},
"reason": {
"type": "object",
"properties": {
"raw": {
"type": "string",
"description": "The text as it was typed by a user."
},
"html": {
"type": "string",
"description": "The user's content rendered as HTML."
},
"markup": {
"enum": [
"markdown",
"creole",
"plaintext"
],
"type": "string",
"description": "The type of markup language the raw content is to be interpreted in."
}
}
},
"description": {
"type": "object",
"properties": {
"raw": {
"type": "string",
"description": "The text as it was typed by a user."
},
"html": {
"type": "string",
"description": "The user's content rendered as HTML."
},
"markup": {
"enum": [
"markdown",
"creole",
"plaintext"
],
"type": "string",
"description": "The type of markup language the raw content is to be interpreted in."
}
}
}
},
"description": "User provided pull request text, interpreted in a markup language and rendered in HTML"
},
"closed_by": {
"$ref": "#/components/schemas/account"
},
"reviewers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account"
},
"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."
},
"created_on": {
"type": "string",
"format": "date-time",
"description": "The ISO8601 timestamp the request was created."
},
"task_count": {
"type": "integer",
"minimum": 0,
"description": "The number of open tasks for a specific pull request."
},
"updated_on": {
"type": "string",
"format": "date-time",
"description": "The ISO8601 timestamp the request was last updated."
},
"destination": {
"$ref": "#/components/schemas/pullrequest_endpoint"
},
"merge_commit": {
"type": "object",
"title": "Pull Request Commit",
"properties": {
"hash": {
"type": "string",
"pattern": "[0-9a-f]{7,}?"
}
}
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/participant"
},
"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 "
},
"comment_count": {
"type": "integer",
"minimum": 0,
"description": "The number of comments for a specific pull request."
},
"close_source_branch": {
"type": "boolean",
"description": "A boolean flag indicating if merging the pull request closes the source branch."
}
},
"description": "A pull request object.",
"additionalProperties": true
}
]
}
pullrequest_comment
{
"allOf": [
{
"$ref": "#/components/schemas/comment"
},
{
"type": "object",
"title": "Pull Request Comment",
"properties": {
"pending": {
"type": "boolean"
},
"resolution": {
"$ref": "#/components/schemas/comment_resolution"
},
"pullrequest": {
"$ref": "#/components/schemas/pullrequest"
}
},
"description": "A pullrequest comment.",
"additionalProperties": true
}
]
}
pullrequest_endpoint
{
"type": "object",
"title": "Pull Request Endpoint",
"properties": {
"branch": {
"type": "object",
"title": "Pull Request Branch",
"properties": {
"name": {
"type": "string"
},
"merge_strategies": {
"type": "array",
"items": {
"enum": [
"merge_commit",
"squash",
"fast_forward"
],
"type": "string"
},
"description": "Available merge strategies, when this endpoint is the destination of the pull request."
},
"default_merge_strategy": {
"type": "string",
"description": "The default merge strategy, when this endpoint is the destination of the pull request."
}
}
},
"commit": {
"type": "object",
"title": "Pull Request Commit",
"properties": {
"hash": {
"type": "string",
"pattern": "[0-9a-f]{7,}?"
}
}
},
"repository": {
"$ref": "#/components/schemas/repository"
}
}
}
pullrequest_merge_parameters
{
"type": "object",
"title": "Pull Request Merge Parameters",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"message": {
"type": "string",
"description": "The commit message that will be used on the resulting commit. Note that the size of the message is limited to 128 KiB."
},
"merge_strategy": {
"enum": [
"merge_commit",
"squash",
"fast_forward"
],
"type": "string",
"default": "merge_commit",
"description": "The merge strategy that will be used to merge the pull request."
},
"close_source_branch": {
"type": "boolean",
"description": "Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False"
}
},
"description": "The metadata that describes a pull request merge.",
"additionalProperties": true
}
ref
{
"type": "object",
"title": "Ref",
"required": [
"type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the ref."
},
"type": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"html": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"commits": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"target": {
"$ref": "#/components/schemas/commit"
}
},
"description": "A ref object, representing a branch or tag in a repository.",
"additionalProperties": true
}
report
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Commit Report",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/report_data"
},
"description": "An array of data fields to display information on the report. Maximum 10."
},
"link": {
"type": "string",
"format": "uri",
"description": "A URL linking to the results of the report in an external tool."
},
"uuid": {
"type": "string",
"description": "The UUID that can be used to identify the report."
},
"title": {
"type": "string",
"description": "The title of the report."
},
"result": {
"enum": [
"PASSED",
"FAILED",
"PENDING"
],
"type": "string",
"description": "The state of the report. May be set to PENDING and later updated."
},
"details": {
"type": "string",
"description": "A string to describe the purpose of the report."
},
"logo_url": {
"type": "string",
"format": "uri",
"description": "A URL to the report logo. If none is provided, the default insights logo will be used."
},
"reporter": {
"type": "string",
"description": "A string to describe the tool or company who created the report."
},
"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."
},
"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."
},
"report_type": {
"enum": [
"SECURITY",
"COVERAGE",
"TEST",
"BUG"
],
"type": "string",
"description": "The type of the report."
},
"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."
}
},
"description": "A report for a commit.",
"additionalProperties": true
}
],
"x-bb-url": "/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commitHash}/reports/{uuid}",
"x-bb-default-fields": [
"uuid",
"commitHash"
]
}
report_annotation
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Report Annotation",
"properties": {
"line": {
"type": "integer",
"minimum": 1,
"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."
},
"link": {
"type": "string",
"format": "uri",
"description": "A URL linking to the annotation in an external tool."
},
"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."
},
"uuid": {
"type": "string",
"description": "The UUID that can be used to identify the annotation."
},
"result": {
"enum": [
"PASSED",
"FAILED",
"SKIPPED",
"IGNORED"
],
"type": "string",
"description": "The state of the report. May be set to PENDING and later updated."
},
"details": {
"type": "string",
"description": "The details to show to users when clicking on the annotation."
},
"summary": {
"type": "string",
"description": "The message to display to users."
},
"severity": {
"enum": [
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW"
],
"type": "string",
"description": "The severity of the annotation."
},
"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."
},
"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."
},
"annotation_type": {
"enum": [
"VULNERABILITY",
"CODE_SMELL",
"BUG"
],
"type": "string",
"description": "The type of the report."
}
},
"description": "A report for a commit.",
"additionalProperties": true
}
],
"x-bb-url": "/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commit.hash}/reports/{reportUuid}/annotations/{uuid}",
"x-bb-default-fields": [
"uuid"
]
}
report_data
{
"type": "object",
"title": "Report Data",
"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."
},
"title": {
"type": "string",
"description": "A string describing what this data field represents."
},
"value": {
"type": "object",
"description": "The value of the data element."
}
},
"description": "A key-value element that will be displayed along with the report."
}
repository
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Repository",
"properties": {
"scm": {
"enum": [
"git"
],
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"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."
},
"links": {
"type": "object",
"properties": {
"html": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"clone": {
"type": "array",
"items": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
},
"forks": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"hooks": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"avatar": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"commits": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"watchers": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"downloads": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"pullrequests": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"owner": {
"$ref": "#/components/schemas/account"
},
"parent": {
"$ref": "#/components/schemas/repository"
},
"project": {
"$ref": "#/components/schemas/project"
},
"has_wiki": {
"type": "boolean",
"description": "\nThe wiki for this repository is enabled. Wiki\nfeatures are not supported for repositories in workspaces\nadministered through admin.atlassian.com.\n"
},
"language": {
"type": "string"
},
"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."
},
"created_on": {
"type": "string",
"format": "date-time"
},
"has_issues": {
"type": "boolean",
"description": "\nThe issue tracker for this repository is enabled. Issue Tracker\nfeatures are not supported for repositories in workspaces\nadministered through admin.atlassian.com.\n"
},
"is_private": {
"type": "boolean"
},
"mainbranch": {
"$ref": "#/components/schemas/branch"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"fork_policy": {
"enum": [
"allow_forks",
"no_public_forks",
"no_forks"
],
"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"
}
},
"description": "A Bitbucket repository.",
"additionalProperties": true
}
]
}
repository_group_permission
{
"type": "object",
"title": "Repository Group Permission",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"group": {
"$ref": "#/components/schemas/group"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"permission": {
"enum": [
"read",
"write",
"admin",
"none"
],
"type": "string"
},
"repository": {
"$ref": "#/components/schemas/repository"
}
},
"description": "A group's permission for a given repository.",
"additionalProperties": true
}
repository_inheritance_state
{
"type": "object",
"title": "Repository Inheritance State",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"override_settings": {
"type": "object"
}
},
"description": "A json object representing the repository's inheritance state values",
"additionalProperties": true
}
repository_permission
{
"type": "object",
"title": "Repository Permission",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/user"
},
"permission": {
"enum": [
"read",
"write",
"admin",
"none"
],
"type": "string"
},
"repository": {
"$ref": "#/components/schemas/repository"
}
},
"description": "A user's permission for a given repository.",
"additionalProperties": true
}
repository_user_permission
{
"type": "object",
"title": "Repository User Permission",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/user"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"permission": {
"enum": [
"read",
"write",
"admin",
"none"
],
"type": "string"
},
"repository": {
"$ref": "#/components/schemas/repository"
}
},
"description": "A user's direct permission for a given repository.",
"additionalProperties": true
}
search_code_search_result
{
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/commit_file"
},
"type": {
"type": "string",
"readOnly": true
},
"path_matches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/search_segment"
},
"readOnly": true
},
"content_matches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/search_content_match"
},
"readOnly": true
},
"content_match_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
}
}
search_content_match
{
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/search_line"
},
"readOnly": true
}
}
}
search_line
{
"type": "object",
"properties": {
"line": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/search_segment"
},
"readOnly": true
}
}
}
search_result_page
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"readOnly": true
},
"page": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"size": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/search_code_search_result"
},
"readOnly": true
},
"pagelen": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"previous": {
"type": "string",
"format": "uri",
"readOnly": true
},
"query_substituted": {
"type": "boolean",
"readOnly": true
}
}
}
search_segment
{
"type": "object",
"properties": {
"text": {
"type": "string",
"readOnly": true
},
"match": {
"type": "boolean",
"readOnly": true
}
}
}
snippet
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Snippet",
"properties": {
"id": {
"type": "integer",
"minimum": 0
},
"scm": {
"enum": [
"git"
],
"type": "string",
"description": "The DVCS used to store the snippet."
},
"owner": {
"$ref": "#/components/schemas/account"
},
"title": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/account"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"is_private": {
"type": "boolean"
},
"updated_on": {
"type": "string",
"format": "date-time"
}
},
"description": "A snippet object.",
"additionalProperties": true
}
]
}
snippet_comment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Snippet Comment",
"properties": {
"links": {
"type": "object",
"properties": {
"html": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"self": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"snippet": {
"$ref": "#/components/schemas/snippet"
}
},
"description": "A comment on a snippet.",
"additionalProperties": true
}
]
}