paginated_repositories
{
"type": "object",
"title": "Paginated Repositories",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/repository"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of repositories."
}
paginated_repository_group_permissions
{
"type": "object",
"title": "Paginated Repository Group Permissions",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/repository_group_permission"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of repository group permissions."
}
paginated_repository_permissions
{
"type": "object",
"title": "Paginated Repository Permissions",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/repository_permission"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of repository permissions."
}
paginated_repository_user_permissions
{
"type": "object",
"title": "Paginated Repository User Permissions",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/repository_user_permission"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of repository user permissions."
}
paginated_snippet_comments
{
"type": "object",
"title": "Paginated Snippet Comments",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snippet_comment"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of snippet comments."
}
paginated_snippet_commit
{
"type": "object",
"title": "Paginated Snippet Commits",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snippet_commit"
},
"minItems": 0
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of snippet commits."
}
paginated_snippets
{
"type": "object",
"title": "Paginated Snippets",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/snippet"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of snippets."
}
paginated_ssh_user_keys
{
"type": "object",
"title": "Paginated SSH User Keys",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssh_account_key"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of SSH keys."
}
paginated_tags
{
"type": "object",
"title": "Paginated Tags",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of tags."
}
paginated_tasks
{
"type": "object",
"title": "Paginated Tasks",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/A_pullrequest_comment_task"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of tasks."
}
paginated_treeentries
{
"type": "object",
"title": "Paginated Tree Entry",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/treeentry"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of commit_file and/or commit_directory objects."
}
paginated_versions
{
"type": "object",
"title": "Paginated Versions",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/version"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of issue tracker versions."
}
paginated_webhook_subscriptions
{
"type": "object",
"title": "Paginated Webhook Subscriptions",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook_subscription"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of webhook subscriptions"
}
paginated_workspace_memberships
{
"type": "object",
"title": "Paginated Workspace Memberships",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workspace_membership"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of workspace memberships."
}
paginated_workspaces
{
"type": "object",
"title": "Paginated Workspaces",
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"minimum": 0,
"description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workspace"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values."
},
"previous": {
"type": "string",
"format": "uri",
"description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs."
}
},
"description": "A paginated list of workspaces."
}
participant
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Participant",
"properties": {
"role": {
"enum": [
"PARTICIPANT",
"REVIEWER"
],
"type": "string"
},
"user": {
"$ref": "#/components/schemas/account"
},
"state": {
"enum": [
"approved",
"changes_requested",
null
],
"type": "string"
},
"approved": {
"type": "boolean"
},
"participated_on": {
"type": "string",
"format": "date-time",
"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."
}
},
"description": "Object describing a user's role on resources like commits or pull requests.",
"additionalProperties": true
}
]
}
pipeline
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID identifying the pipeline."
},
"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."
},
"configuration_sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pipeline_configuration_source"
},
"minItems": 0,
"description": "An ordered list of sources of the pipeline configuration"
}
},
"description": "A Bitbucket Pipeline. This represents an actual pipeline result.",
"additionalProperties": true
}
]
}
pipeline_build_number
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Build Number",
"properties": {
"next": {
"type": "integer",
"description": "The next number that will be used as build number."
}
},
"description": "A Pipelines build number.",
"additionalProperties": true
}
]
}
pipeline_cache
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Cache",
"properties": {
"name": {
"type": "string",
"description": "The name of the cache."
},
"path": {
"type": "string",
"description": "The path where the cache contents were retrieved from."
},
"uuid": {
"type": "string",
"description": "The UUID identifying the pipeline cache."
},
"key_hash": {
"type": "string",
"description": "The key hash of the cache version."
},
"step_uuid": {
"type": "string",
"description": "The uuid of the step that created the cache."
},
"created_on": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the cache was created."
},
"pipeline_uuid": {
"type": "string",
"description": "The UUID of the pipeline that created the cache."
},
"file_size_bytes": {
"type": "integer",
"description": "The size of the file containing the archive of the cache."
}
},
"description": "A representation of metadata for a pipeline cache for given repository.",
"additionalProperties": true
}
]
}
pipeline_cache_content_uri
{
"type": "object",
"title": "Pipeline Cache Content URI",
"properties": {
"uri": {
"type": "string",
"format": "uri",
"description": "The uri for pipeline cache content."
}
},
"description": "A representation of the location of pipeline cache content."
}
pipeline_command
{
"type": "object",
"title": "Pipeline Command",
"properties": {
"name": {
"type": "string",
"description": "The name of the command."
},
"command": {
"type": "string",
"description": "The executable command."
}
},
"description": "An executable pipeline command."
}
pipeline_commit_target
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_target"
},
{
"type": "object",
"title": "Pipeline Commit Target",
"properties": {
"commit": {
"$ref": "#/components/schemas/commit"
},
"selector": {
"$ref": "#/components/schemas/pipeline_selector"
}
},
"description": "A Bitbucket Pipelines commit target.",
"additionalProperties": true
}
]
}
pipeline_configuration_source
{
"type": "object",
"required": [
"source",
"uri"
],
"properties": {
"uri": {
"type": "string",
"format": "uri",
"description": "Link to the configuration source view or its immediate content"
},
"source": {
"type": "string",
"description": "Identifier of the configuration source"
}
},
"description": "Information about the source of the pipeline configuration"
}
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
}
]
}
pipeline_image
{
"type": "object",
"title": "Pipeline Image",
"properties": {
"name": {
"type": "string",
"description": "The name of the image. If the image is hosted on DockerHub the short name can be used, otherwise the fully qualified name is required here."
},
"email": {
"type": "string",
"description": "The email needed to authenticate with the Docker registry. Only required when using a private Docker image."
},
"password": {
"type": "string",
"description": "The password needed to authenticate with the Docker registry. Only required when using a private Docker image."
},
"username": {
"type": "string",
"description": "The username needed to authenticate with the Docker registry. Only required when using a private Docker image."
}
},
"description": "The definition of a Docker image that can be used for a Bitbucket Pipelines step execution context."
}
pipeline_known_host
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline 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"
}
},
"description": "A Pipelines known host.",
"additionalProperties": true
}
]
}
pipeline_ref_target
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_target"
},
{
"type": "object",
"title": "Pipeline Ref Target",
"properties": {
"commit": {
"$ref": "#/components/schemas/commit"
},
"ref_name": {
"type": "string",
"description": "The name of the reference."
},
"ref_type": {
"enum": [
"branch",
"tag",
"named_branch",
"bookmark"
],
"type": "string",
"description": "The type of reference (branch/tag)."
},
"selector": {
"$ref": "#/components/schemas/pipeline_selector"
}
},
"description": "A Bitbucket Pipelines reference target.",
"additionalProperties": true
}
]
}
pipeline_schedule
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Schedule",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID identifying the schedule."
},
"target": {
"$ref": "#/components/schemas/pipeline_ref_target"
},
"enabled": {
"type": "boolean",
"description": "Whether the schedule is enabled."
},
"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."
},
"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."
}
},
"description": "A Pipelines schedule.",
"additionalProperties": true
}
]
}
pipeline_schedule_execution
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Schedule Execution",
"properties": {},
"description": "A Pipelines schedule execution.",
"additionalProperties": true
}
]
}
pipeline_schedule_execution_errored
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_schedule_execution"
},
{
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/pipeline_error"
}
},
"description": "A Pipelines schedule execution that failed to be executed.",
"additionalProperties": true
}
]
}
pipeline_schedule_execution_executed
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_schedule_execution"
},
{
"type": "object",
"properties": {
"pipeline": {
"$ref": "#/components/schemas/pipeline"
}
},
"description": "A Pipelines executed schedule execution.",
"additionalProperties": true
}
]
}
pipeline_schedule_post_request_body
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Request body for Pipeline Schedule POST request",
"required": [
"target",
"cron_pattern"
],
"properties": {
"target": {
"type": "object",
"required": [
"selector",
"ref_name",
"ref_type"
],
"properties": {
"ref_name": {
"type": "string",
"description": "The name of the reference."
},
"ref_type": {
"enum": [
"branch"
],
"type": "string",
"description": "The type of reference (branch only)."
},
"selector": {
"$ref": "#/components/schemas/pipeline_selector"
}
},
"description": "The target on which the schedule will be executed."
},
"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."
}
},
"additionalProperties": true
}
]
}
pipeline_schedule_put_request_body
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Request body for Pipeline Schedule PUT request",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the schedule is enabled."
}
},
"additionalProperties": true
}
]
}
pipeline_selector
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Selector",
"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."
}
},
"description": "A representation of the selector that was used to identify the pipeline in the YML file.",
"additionalProperties": true
}
]
}
pipeline_ssh_key_pair
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline SSH Key Pair",
"properties": {
"public_key": {
"type": "string",
"description": "The SSH public key."
},
"private_key": {
"type": "string",
"description": "The SSH private key. This value will be empty when retrieving the SSH key pair."
}
},
"description": "A Pipelines SSH key pair.",
"additionalProperties": true
}
]
}
pipeline_ssh_public_key
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline SSH Public Key",
"properties": {
"key": {
"type": "string",
"description": "The base64 encoded public key."
},
"key_type": {
"type": "string",
"description": "The type of the 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."
}
},
"description": "A Pipelines known host public key.",
"additionalProperties": true
}
]
}
pipeline_state
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline State",
"properties": {},
"description": "The representation of the progress state of a pipeline.",
"additionalProperties": true
}
]
}
pipeline_state_completed
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state"
},
{
"type": "object",
"title": "Pipeline Completed State",
"properties": {
"name": {
"enum": [
"COMPLETED"
],
"type": "string",
"description": "The name of pipeline state (COMPLETED)."
},
"result": {
"$ref": "#/components/schemas/pipeline_state_completed_result"
}
},
"description": "A Bitbucket Pipelines COMPLETED pipeline state.",
"additionalProperties": true
}
]
}
pipeline_state_completed_error
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_completed_result"
},
{
"type": "object",
"title": "Pipeline Completed Error",
"properties": {
"name": {
"enum": [
"ERROR"
],
"type": "string",
"description": "The name of the result (ERROR)"
},
"error": {
"$ref": "#/components/schemas/pipeline_error"
}
},
"description": "A Bitbucket Pipelines ERROR pipeline result.",
"additionalProperties": true
}
]
}
pipeline_state_completed_expired
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"EXPIRED"
],
"type": "string",
"description": "The name of the stopped result (EXPIRED)."
}
},
"description": "A Bitbucket Pipelines EXPIRED pipeline result.",
"additionalProperties": true
}
]
}
pipeline_state_completed_failed
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"FAILED"
],
"type": "string",
"description": "The name of the failed result (FAILED)."
}
},
"description": "A Bitbucket Pipelines FAILED pipeline result.",
"additionalProperties": true
}
]
}
pipeline_state_completed_result
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Completed Result",
"properties": {},
"description": "A result of a completed pipeline state.",
"additionalProperties": true
}
]
}
pipeline_state_completed_stopped
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"STOPPED"
],
"type": "string",
"description": "The name of the stopped result (STOPPED)."
}
},
"description": "A Bitbucket Pipelines STOPPED pipeline result.",
"additionalProperties": true
}
]
}
pipeline_state_completed_successful
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_completed_result"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"SUCCESSFUL"
],
"type": "string",
"description": "The name of the successful result (SUCCESSFUL)."
}
},
"description": "A Bitbucket Pipelines SUCCESSFUL pipeline result.",
"additionalProperties": true
}
]
}
pipeline_state_in_progress
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state"
},
{
"type": "object",
"title": "Pipeline In-Progress State",
"properties": {
"name": {
"enum": [
"IN_PROGRESS"
],
"type": "string",
"description": "The name of pipeline state (IN_PROGRESS)."
},
"stage": {
"$ref": "#/components/schemas/pipeline_state_in_progress_stage"
}
},
"description": "A Bitbucket Pipelines IN_PROGRESS pipeline state.",
"additionalProperties": true
}
]
}
pipeline_state_in_progress_paused
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_in_progress_stage"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"PAUSED"
],
"type": "string",
"description": "The name of the stage (PAUSED)"
}
},
"description": "A Bitbucket Pipelines PAUSED stage of a pipeline that is in progress.",
"additionalProperties": true
}
]
}
pipeline_state_in_progress_running
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state_in_progress_stage"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"RUNNING"
],
"type": "string",
"description": "The name of the stage (RUNNING)"
}
},
"description": "A Bitbucket Pipelines RUNNING stage of a pipeline that is in progress.",
"additionalProperties": true
}
]
}
pipeline_state_in_progress_stage
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline In-Progress Stage",
"properties": {},
"description": "A result of an in progress pipeline state.",
"additionalProperties": true
}
]
}
pipeline_state_pending
{
"allOf": [
{
"$ref": "#/components/schemas/pipeline_state"
},
{
"type": "object",
"title": "Pipeline Pending State",
"properties": {
"name": {
"enum": [
"PENDING"
],
"type": "string",
"description": "The name of pipeline state (PENDING)."
}
},
"description": "A Bitbucket Pipelines PENDING pipeline state.",
"additionalProperties": true
}
]
}
pipeline_step
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Pipeline Step",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID identifying the step."
},
"image": {
"$ref": "#/components/schemas/pipeline_image"
},
"state": {
"$ref": "#/components/schemas/pipeline_step_state"
},
"started_on": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the step execution was started. This is not set when the step hasn't executed yet."
},
"completed_on": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the step execution was completed. This is not set if the step is still in progress."
},
"setup_commands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pipeline_command"
},
"description": "The list of commands that are executed as part of the setup phase of the build. These commands are executed outside the build container."
},
"script_commands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pipeline_command"
},
"description": "The list of build commands. These commands are executed in the build container."
}
},
"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"
]
}