Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.bitbucket.org/2.0
No endpoints found for this provider.
A_pull_request_task
{
"allOf": [
{
"$ref": "#/components/schemas/task"
},
{
"type": "object",
"title": "Pull Request Task",
"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."
}
}
}
},
"description": "A pull request task."
}
]
}
A_pullrequest_comment_task
{
"allOf": [
{
"$ref": "#/components/schemas/A_pull_request_task"
},
{
"type": "object",
"title": "Pull Request Comment Task",
"properties": {
"comment": {
"$ref": "#/components/schemas/comment"
}
},
"description": "A pullrequest comment task"
}
]
}
A_pullrequest_task_create
{
"type": "object",
"title": "Pull Request Task Create",
"required": [
"content"
],
"properties": {
"comment": {
"$ref": "#/components/schemas/comment"
},
"content": {
"type": "object",
"title": "Task Raw Content",
"required": [
"raw"
],
"properties": {
"raw": {
"type": "string",
"description": "The task contents"
}
},
"description": "task raw content"
},
"pending": {
"type": "boolean"
}
},
"description": "A pullrequest task create"
}
A_pullrequest_task_update
{
"type": "object",
"title": "Pull Request Task Update",
"properties": {
"state": {
"enum": [
"RESOLVED",
"UNRESOLVED"
],
"type": "string"
},
"content": {
"type": "object",
"title": "Task Raw Content",
"required": [
"raw"
],
"properties": {
"raw": {
"type": "string",
"description": "The task contents"
}
},
"description": "task raw content"
}
},
"description": "A pullrequest task update"
}
ReportsBulkCreateOrUpdateAnnotationsRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/report_annotation"
},
"maxItems": 100,
"minItems": 1
}
ReportsBulkCreateOrUpdateAnnotationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/report_annotation"
}
}
account
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Account",
"properties": {
"uuid": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/account_links"
},
"username": {
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-]+$"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"display_name": {
"type": "string"
}
},
"description": "An account object.",
"additionalProperties": true
}
]
}
account_links
{
"type": "object",
"title": "Account Links",
"properties": {
"avatar": {
"$ref": "#/components/schemas/link"
}
},
"description": "Links related to an Account.",
"additionalProperties": true
}
app_user
{
"allOf": [
{
"$ref": "#/components/schemas/account"
},
{
"type": "object",
"title": "App User",
"properties": {
"kind": {
"type": "string",
"description": "The kind of App User."
},
"account_id": {
"type": "string",
"description": "The user's Atlassian account ID."
},
"account_status": {
"type": "string",
"description": "The status of the account. Currently the only possible value is \"active\", but more values may be added in the future."
}
},
"description": "An app user object.",
"additionalProperties": true
}
]
}
application_property
{
"type": "object",
"title": "Application Property",
"properties": {
"_attributes": {
"type": "array",
"items": {
"enum": [
"public",
"read_only"
],
"type": "string"
}
}
},
"description": "An application property. It is a caller defined JSON object that Bitbucket will store and return. \nThe `_attributes` field at its top level can be used to control who is allowed to read and update the property. \nThe keys of the JSON object must match an allowed pattern. For details, \nsee [Application properties](https://dac-static.atlassian.com).\n",
"additionalProperties": true
}
author
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Author",
"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"
}
},
"description": "The author of a change in a repository",
"additionalProperties": true
}
]
}
base_commit
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Base Commit",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"hash": {
"type": "string",
"pattern": "[0-9a-f]{7,}?"
},
"author": {
"$ref": "#/components/schemas/author"
},
"message": {
"type": "string"
},
"parents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/base_commit"
},
"minItems": 0
},
"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."
}
}
}
},
"description": "The common base type for both repository and snippet commits.",
"additionalProperties": true
}
]
}
bitbucket.apps.permissions.serializers.ProjectPermissionUpdateSchema
{
"type": "object",
"required": [
"permission"
],
"properties": {
"permission": {
"enum": [
"read",
"write",
"create-repo",
"admin"
],
"type": "string"
}
}
}
bitbucket.apps.permissions.serializers.RepoPermissionUpdateSchema
{
"type": "object",
"required": [
"permission"
],
"properties": {
"permission": {
"enum": [
"read",
"write",
"admin"
],
"type": "string"
}
}
}
branch
{
"allOf": [
{
"$ref": "#/components/schemas/ref"
},
{
"type": "object",
"title": "Branch",
"properties": {
"merge_strategies": {
"type": "array",
"items": {
"enum": [
"merge_commit",
"squash",
"fast_forward"
],
"type": "string"
},
"description": "Available merge strategies for pull requests targeting this branch."
},
"default_merge_strategy": {
"type": "string",
"description": "The default merge strategy for pull requests targeting this branch."
}
},
"description": "A branch object, representing a branch in a repository.",
"additionalProperties": true
}
]
}
branching_model
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Branching Model",
"properties": {
"production": {
"type": "object",
"required": [
"name",
"use_mainbranch"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty."
},
"branch": {
"$ref": "#/components/schemas/branch"
},
"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. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty."
},
"branch": {
"$ref": "#/components/schemas/branch"
},
"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 repository's branching model",
"additionalProperties": true
}
]
}
branching_model_settings
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Branching Model Settings",
"properties": {
"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."
}
}
},
"production": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The configured branch. It must be `null` when `use_mainbranch` is `true`. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set). In this case `is_valid` will be `false`. The branch must exist when updating/setting the `name` or an error will occur."
},
"enabled": {
"type": "boolean",
"description": "Indicates if branch is enabled or not."
},
"is_valid": {
"type": "boolean",
"description": "Indicates if the configured branch is valid, that is, if the configured branch actually exists currently. Is always `true` when `use_mainbranch` is `true` (even if the main branch does not exist). This field is read-only. This field is ignored when updating/creating settings."
},
"use_mainbranch": {
"type": "boolean",
"description": "Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). When `true` the `name` must be `null` or not provided. When `false` the `name` must contain a non-empty branch name."
}
}
},
"development": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The configured branch. It must be `null` when `use_mainbranch` is `true`. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set). In this case `is_valid` will be `false`. The branch must exist when updating/setting the `name` or an error will occur."
},
"is_valid": {
"type": "boolean",
"description": "Indicates if the configured branch is valid, that is, if the configured branch actually exists currently. Is always `true` when `use_mainbranch` is `true` (even if the main branch does not exist). This field is read-only. This field is ignored when updating/creating settings."
},
"use_mainbranch": {
"type": "boolean",
"description": "Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). When `true` the `name` must be `null` or not provided. When `false` the `name` must contain a non-empty branch name."
}
}
},
"branch_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"feature",
"bugfix",
"release",
"hotfix"
],
"type": "string",
"description": "The kind of the branch type."
},
"prefix": {
"type": "string",
"description": "The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The `prefix` of an enabled branch type must be a valid branch prefix.Additionally, it cannot be blank, empty or `null`. The `prefix` for a disabled branch type can be empty or invalid."
},
"enabled": {
"type": "boolean",
"description": "Whether the branch type is enabled or not. A disabled branch type may contain an invalid `prefix`."
}
}
},
"maxItems": 4,
"minItems": 0,
"uniqueItems": true
}
},
"description": "A repository's branching model settings",
"additionalProperties": true
}
]
}
branchrestriction
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Branch Restriction",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account"
},
"minItems": 0
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
},
"minItems": 0
}
},
"description": "A branch restriction rule.",
"additionalProperties": true
}
]
}
comment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Comment",
"properties": {
"id": {
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/account"
},
"links": {
"type": "object",
"properties": {
"code": {
"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."
}
}
},
"inline": {
"type": "object",
"required": [
"path"
],
"properties": {
"to": {
"type": "integer",
"minimum": 1,
"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."
},
"from": {
"type": "integer",
"minimum": 1,
"description": "The comment's anchor line in the old version of the file."
},
"path": {
"type": "string",
"description": "The path of the file this comment is anchored to."
}
}
},
"parent": {
"$ref": "#/components/schemas/comment"
},
"content": {
"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."
}
}
},
"deleted": {
"type": "boolean"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"updated_on": {
"type": "string",
"format": "date-time"
}
},
"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`).",
"additionalProperties": true
}
]
}
comment_resolution
{
"type": "object",
"title": "Comment Resolution",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/account"
},
"created_on": {
"type": "string",
"format": "date-time",
"description": "The ISO8601 timestamp the resolution was created."
}
},
"description": "The resolution object for a Comment.",
"additionalProperties": true
}
commit
{
"allOf": [
{
"$ref": "#/components/schemas/base_commit"
},
{
"type": "object",
"title": "Commit",
"properties": {
"repository": {
"$ref": "#/components/schemas/repository"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/participant"
},
"minItems": 0
}
},
"description": "A repository commit object.",
"additionalProperties": true
}
]
}
commit_comment
{
"allOf": [
{
"$ref": "#/components/schemas/comment"
},
{
"type": "object",
"title": "Commit Comment",
"properties": {
"commit": {
"$ref": "#/components/schemas/commit"
}
},
"description": "A commit comment.",
"additionalProperties": true
}
]
}
commit_file
{
"type": "object",
"title": "Commit File",
"required": [
"type"
],
"properties": {
"path": {
"type": "string",
"description": "The path in the repository"
},
"type": {
"type": "string"
},
"commit": {
"$ref": "#/components/schemas/commit"
},
"attributes": {
"enum": [
"link",
"executable",
"subrepository",
"binary",
"lfs"
],
"type": "string"
},
"escaped_path": {
"type": "string",
"description": "The escaped version of the path as it appears in a diff. If the path does not require escaping this will be the same as path."
}
},
"description": "A file object, representing a file at a commit in a repository",
"additionalProperties": true
}
commitstatus
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Commit Status",
"properties": {
"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"
},
"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."
},
"name": {
"type": "string",
"description": "An identifier for the build itself, e.g. BB-DEPLOY-1"
},
"uuid": {
"type": "string",
"description": "The commit status' id."
},
"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."
},
"commit": {
"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": [
"FAILED",
"INPROGRESS",
"STOPPED",
"SUCCESSFUL"
],
"type": "string",
"description": "Provides some indication of the status of this commit"
},
"refname": {
"type": "string",
"description": "\nThe name of the ref that pointed to this commit at the time the status\nobject was created. Note that this the ref may since have moved off of\nthe commit. This optional field can be useful for build systems whose\nbuild triggers and configuration are branch-dependent (e.g. a Pipeline\nbuild).\nIt is legitimate for this field to not be set, or even apply (e.g. a\nstatic linting job)."
},
"created_on": {
"type": "string",
"format": "date-time"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"description": "A description of the build (e.g. \"Unit tests in Bamboo\")"
}
},
"description": "A commit status object.",
"additionalProperties": true
}
]
}
component
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Component",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"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."
}
}
}
},
"description": "A component as defined in a repository's issue tracker.",
"additionalProperties": true
}
]
}
ddev_report
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"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"
]
}
default_reviewer_and_type
{
"type": "object",
"title": "Default Reviewer and Type",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/user"
},
"reviewer_type": {
"type": "string"
}
},
"description": "Object containing a user that is a default reviewer and the type of reviewer",
"additionalProperties": true
}
deploy_key
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "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."
}
}
},
"owner": {
"$ref": "#/components/schemas/account"
},
"comment": {
"type": "string",
"description": "The comment parsed from the deploy key (if present)"
},
"added_on": {
"type": "string",
"format": "date-time"
},
"last_used": {
"type": "string",
"format": "date-time"
},
"repository": {
"$ref": "#/components/schemas/repository"
}
},
"description": "Represents deploy key for a repository.",
"additionalProperties": true
}
]
}
deployment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID identifying the deployment."
},
"state": {
"$ref": "#/components/schemas/deployment_state"
},
"release": {
"$ref": "#/components/schemas/deployment_release"
},
"environment": {
"$ref": "#/components/schemas/deployment_environment"
}
},
"description": "A Bitbucket Deployment.",
"additionalProperties": true
}
]
}
deployment_environment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Environment",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment."
},
"uuid": {
"type": "string",
"description": "The UUID identifying the environment."
}
},
"description": "A Bitbucket Deployment Environment.",
"additionalProperties": true
}
],
"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,
"x-bb-default-fields": [
"uuid"
]
}
deployment_environment_lock
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Environment Lock",
"properties": {
"environmentUuid": {
"type": "string",
"description": "The UUID identifying the environment."
}
},
"description": "A Bitbucket Deployment Environment Lock.",
"additionalProperties": true
}
],
"x-bb-batch-url": "/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/locks_batch",
"x-bb-batch-max-size": 100,
"x-bb-default-fields": [
"*",
"lock_opener.*",
"owner.*"
]
}
deployment_release
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Release",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Link to the pipeline that produced the release."
},
"name": {
"type": "string",
"description": "The name of the release."
},
"uuid": {
"type": "string",
"description": "The UUID identifying the release."
},
"commit": {
"$ref": "#/components/schemas/commit"
},
"created_on": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the release was created."
}
},
"description": "A Bitbucket Deployment Release.",
"additionalProperties": true
}
]
}
deployment_state
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment State",
"properties": {},
"description": "The representation of the progress state of a deployment.",
"additionalProperties": true
}
]
}
deployment_state_completed
{
"allOf": [
{
"$ref": "#/components/schemas/deployment_state"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Link to the deployment result."
},
"name": {
"enum": [
"COMPLETED"
],
"type": "string",
"description": "The name of deployment state (COMPLETED)."
},
"status": {
"$ref": "#/components/schemas/deployment_state_completed_status"
},
"deployer": {
"$ref": "#/components/schemas/account"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the deployment was started."
},
"completion_date": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the deployment completed."
}
},
"description": "A Bitbucket Deployment COMPLETED deployment state.",
"additionalProperties": true
}
]
}
deployment_state_completed_status
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Completed Deployment",
"properties": {},
"description": "The status of a completed deployment.",
"additionalProperties": true
}
]
}
deployment_state_completed_status_failed
{
"allOf": [
{
"$ref": "#/components/schemas/deployment_state_completed_status"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"FAILED"
],
"type": "string",
"description": "The name of the completed deployment status (FAILED)."
}
},
"description": "A FAILED completed deployment status.",
"additionalProperties": true
}
]
}
deployment_state_completed_status_stopped
{
"allOf": [
{
"$ref": "#/components/schemas/deployment_state_completed_status"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"STOPPED"
],
"type": "string",
"description": "The name of the completed deployment status (STOPPED)."
}
},
"description": "A STOPPED completed deployment status.",
"additionalProperties": true
}
]
}
deployment_state_completed_status_successful
{
"allOf": [
{
"$ref": "#/components/schemas/deployment_state_completed_status"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"SUCCESSFUL"
],
"type": "string",
"description": "The name of the completed deployment status (SUCCESSFUL)."
}
},
"description": "A SUCCESSFUL completed deployment status.",
"additionalProperties": true
}
]
}
deployment_state_in_progress
{
"allOf": [
{
"$ref": "#/components/schemas/deployment_state"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Link to the deployment result."
},
"name": {
"enum": [
"IN_PROGRESS"
],
"type": "string",
"description": "The name of deployment state (IN_PROGRESS)."
},
"deployer": {
"$ref": "#/components/schemas/account"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the deployment was started."
}
},
"description": "A Bitbucket Deployment IN_PROGRESS deployment state.",
"additionalProperties": true
}
]
}
deployment_state_undeployed
{
"allOf": [
{
"$ref": "#/components/schemas/deployment_state"
},
{
"type": "object",
"properties": {
"name": {
"enum": [
"UNDEPLOYED"
],
"type": "string",
"description": "The name of deployment state (UNDEPLOYED)."
},
"trigger_url": {
"type": "string",
"format": "uri",
"description": "Link to trigger the deployment."
}
},
"description": "A Bitbucket Deployment UNDEPLOYED deployment state.",
"additionalProperties": true
}
]
}
deployment_variable
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment 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 deployment variable.",
"additionalProperties": true
}
]
}
deployments_ddev_deployment_environment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Environment",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment."
},
"uuid": {
"type": "string",
"description": "The UUID identifying the environment."
}
},
"description": "A Bitbucket Deployment Environment.",
"additionalProperties": true
}
],
"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,
"x-bb-default-fields": [
"uuid"
]
}
deployments_ddev_deployment_environment_lock
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Environment Lock",
"properties": {
"environmentUuid": {
"type": "string",
"description": "The UUID identifying the environment."
}
},
"description": "A Bitbucket Deployment Environment Lock.",
"additionalProperties": true
}
],
"x-bb-batch-url": "/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/locks_batch",
"x-bb-batch-max-size": 100,
"x-bb-default-fields": [
"*",
"lock_opener.*",
"owner.*"
]
}
deployments_ddev_paginated_environments
{
"type": "object",
"title": "Paginated Deployment Environments",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/deployments_ddev_deployment_environment"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of environments"
}
deployments_stg_west_deployment_environment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Environment",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment."
},
"uuid": {
"type": "string",
"description": "The UUID identifying the environment."
}
},
"description": "A Bitbucket Deployment Environment.",
"additionalProperties": true
}
],
"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,
"x-bb-default-fields": [
"uuid"
]
}
deployments_stg_west_deployment_environment_lock
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Deployment Environment Lock",
"properties": {
"environmentUuid": {
"type": "string",
"description": "The UUID identifying the environment."
}
},
"description": "A Bitbucket Deployment Environment Lock.",
"additionalProperties": true
}
],
"x-bb-batch-url": "/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/locks_batch",
"x-bb-batch-max-size": 100,
"x-bb-default-fields": [
"*",
"lock_opener.*",
"owner.*"
]
}
deployments_stg_west_paginated_environments
{
"type": "object",
"title": "Paginated Deployment Environments",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/deployments_stg_west_deployment_environment"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of environments"
}
diffstat
{
"type": "object",
"title": "Diff Stat",
"required": [
"type"
],
"properties": {
"new": {
"$ref": "#/components/schemas/commit_file"
},
"old": {
"$ref": "#/components/schemas/commit_file"
},
"type": {
"type": "string"
},
"status": {
"enum": [
"added",
"removed",
"modified",
"renamed"
],
"type": "string"
},
"lines_added": {
"type": "integer"
},
"lines_removed": {
"type": "integer"
}
},
"description": "A diffstat object that includes a summary of changes made to a file between two commits.",
"additionalProperties": true
}
effective_repo_branching_model
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Effective Repository Branching Model",
"properties": {
"production": {
"type": "object",
"required": [
"name",
"use_mainbranch"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty."
},
"branch": {
"$ref": "#/components/schemas/branch"
},
"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. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty."
},
"branch": {
"$ref": "#/components/schemas/branch"
},
"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 repository's effective branching model",
"additionalProperties": true
}
]
}
error
{
"type": "object",
"title": "Error",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"error": {
"type": "object",
"required": [
"message"
],
"properties": {
"data": {
"type": "object",
"properties": {},
"description": "Optional structured data that is endpoint-specific.",
"additionalProperties": true
},
"detail": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"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`.",
"additionalProperties": true
}
export_options
{
"type": "object",
"title": "Export Options",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"send_email": {
"type": "boolean"
},
"project_key": {
"type": "string"
},
"project_name": {
"type": "string"
},
"include_attachments": {
"type": "boolean"
}
},
"description": "Options for issue export.",
"additionalProperties": true
}
group
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Group",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string",
"description": "The \"sluggified\" version of the group's name. This contains only ASCII\ncharacters and can therefore be slightly different than the name"
},
"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."
}
}
},
"owner": {
"$ref": "#/components/schemas/account"
},
"full_slug": {
"type": "string",
"description": "The concatenation of the workspace's slug and the group's slug,\nseparated with a colon (e.g. `acme:developers`)\n"
},
"workspace": {
"$ref": "#/components/schemas/workspace"
}
},
"description": "A group object",
"additionalProperties": true
}
]
}
hook_event
{
"type": "object",
"title": "Hook Event",
"properties": {
"event": {
"enum": [
"pullrequest:updated",
"issue:comment_created",
"repo:transfer",
"issue:created",
"pullrequest:rejected",
"repo:deleted",
"pullrequest:fulfilled",
"repo:commit_status_created",
"repo:imported",
"pullrequest:changes_request_created",
"repo:push",
"pullrequest:created",
"pullrequest:comment_created",
"project:updated",
"repo:created",
"repo:commit_status_updated",
"pullrequest:unapproved",
"repo:commit_comment_created",
"pullrequest:comment_reopened",
"repo:fork",
"repo:updated",
"pullrequest:comment_deleted",
"issue:updated",
"pullrequest:changes_request_removed",
"pullrequest:comment_resolved",
"pullrequest:approved",
"pullrequest:comment_updated"
],
"type": "string",
"description": "The event identifier."
},
"label": {
"type": "string",
"description": "Summary of the webhook event type."
},
"category": {
"type": "string",
"description": "The category this event belongs to."
},
"description": {
"type": "string",
"description": "More detailed description of the webhook event type."
}
},
"description": "An event, associated with a resource or subject type."
}
issue
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Issue",
"properties": {
"id": {
"type": "integer"
},
"kind": {
"enum": [
"bug",
"enhancement",
"proposal",
"task"
],
"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."
},
"vote": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"watch": {
"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."
},
"attachments": {
"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": [
"submitted",
"new",
"open",
"resolved",
"on hold",
"invalid",
"duplicate",
"wontfix",
"closed"
],
"type": "string"
},
"title": {
"type": "string"
},
"votes": {
"type": "integer"
},
"content": {
"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."
}
}
},
"version": {
"$ref": "#/components/schemas/version"
},
"assignee": {
"$ref": "#/components/schemas/account"
},
"priority": {
"enum": [
"trivial",
"minor",
"major",
"critical",
"blocker"
],
"type": "string"
},
"reporter": {
"$ref": "#/components/schemas/account"
},
"component": {
"$ref": "#/components/schemas/component"
},
"edited_on": {
"type": "string",
"format": "date-time"
},
"milestone": {
"$ref": "#/components/schemas/milestone"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"repository": {
"$ref": "#/components/schemas/repository"
},
"updated_on": {
"type": "string",
"format": "date-time"
}
},
"description": "An issue.",
"additionalProperties": true
}
]
}
issue_attachment
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Issue Attachment",
"properties": {
"name": {
"type": "string"
},
"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."
}
}
}
},
"description": "An issue file attachment's meta data. Note this does not contain the file's actual contents.",
"additionalProperties": true
}
]
}
issue_change
{
"type": "object",
"title": "Issue Change",
"required": [
"type"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/account"
},
"issue": {
"$ref": "#/components/schemas/issue"
},
"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."
},
"issue": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"changes": {
"type": "object",
"properties": {
"kind": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"state": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"title": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"content": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"version": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"assignee": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"priority": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"component": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
},
"milestone": {
"type": "object",
"properties": {
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
}
}
},
"message": {
"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."
}
}
},
"created_on": {
"type": "string",
"format": "date-time"
}
},
"description": "An issue change.",
"additionalProperties": true
}
issue_comment
{
"allOf": [
{
"$ref": "#/components/schemas/comment"
},
{
"type": "object",
"title": "Issue Comment",
"properties": {
"issue": {
"$ref": "#/components/schemas/issue"
}
},
"description": "A issue comment.",
"additionalProperties": true
}
]
}
issue_job_status
{
"type": "object",
"title": "Issue Job Status",
"properties": {
"pct": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "The percentage of issues already imported/exported"
},
"type": {
"type": "string"
},
"count": {
"type": "integer",
"description": "The total number of issues already imported/exported"
},
"phase": {
"type": "string",
"description": "The phase of the import/export job"
},
"total": {
"type": "integer",
"description": "The total number of issues being imported/exported"
},
"status": {
"enum": [
"ACCEPTED",
"STARTED",
"RUNNING",
"FAILURE"
],
"type": "string",
"description": "The status of the import/export job"
}
},
"description": "The status of an import or export job"
}
jira_project
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"description": "A Jira Project.",
"additionalProperties": true
}
],
"x-bb-url": "/api/{target_user.uuid}/jira/sites/{cloudId}/projects/{id}?atlassian_account_id={user.account_id}",
"x-bb-detail-fields": [
"key",
"name",
"url",
"avatarUrls.*",
"site"
],
"x-bb-default-fields": [
"type",
"cloudId",
"id"
]
}
jira_site
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"description": "A Jira Site.",
"additionalProperties": true
}
],
"x-bb-url": "/api/{target_user.uuid}/jira/sites/{cloudId}?atlassian_account_id={user.account_id}",
"x-bb-detail-fields": [
"connected"
],
"x-bb-default-fields": [
"type",
"cloudId",
"cloudUrl",
"cloudName"
]
}
link
{
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
milestone
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Milestone",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"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."
}
}
}
},
"description": "A milestone as defined in a repository's issue tracker.",
"additionalProperties": true
}
]
}
object
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
}
},
"description": "Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.",
"discriminator": {
"propertyName": "type"
},
"additionalProperties": true
}
page
{
"type": "object",
"title": "Page",
"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."
},
"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."
}
}
}
paginated_accounts
{
"type": "object",
"title": "Paginated Accounts",
"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/account"
},
"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 accounts."
}
paginated_annotations
{
"type": "object",
"title": "Paginated Annotations",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/report_annotation"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 annotations."
}
paginated_branches
{
"type": "object",
"title": "Paginated Branches",
"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/branch"
},
"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 branches."
}
paginated_branchrestrictions
{
"type": "object",
"title": "Paginated Branch Restrictions",
"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/branchrestriction"
},
"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 branch restriction rules."
}
paginated_changeset
{
"type": "object",
"title": "Page",
"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/base_commit"
},
"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 commits."
}
paginated_commit_comments
{
"type": "object",
"title": "Paginated Commit 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/commit_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 commit comments."
}
paginated_commitstatuses
{
"type": "object",
"title": "Paginated Commit Statuses",
"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/commitstatus"
},
"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 status objects."
}
paginated_components
{
"type": "object",
"title": "Paginated Components",
"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/component"
},
"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 components."
}
paginated_default_reviewer_and_type
{
"type": "object",
"title": "Paginated Default Reviewer and Type",
"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/default_reviewer_and_type"
},
"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 default reviewers with reviewer type."
}
paginated_deploy_keys
{
"type": "object",
"title": "Paginated Deploy 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/deploy_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 deploy keys."
}
paginated_deployment_variable
{
"type": "object",
"title": "Paginated Deployment Variables",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/deployment_variable"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of deployment variables."
}
paginated_deployments
{
"type": "object",
"title": "Paginated Deployments",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/deployment"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of deployments"
}
paginated_diffstats
{
"type": "object",
"title": "Paginated Diff Stat",
"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/diffstat"
},
"minItems": 0,
"uniqueItems": true
},
"pagelen": {
"type": "integer",
"minimum": 1,
"description": "Current number of objects on the existing page. The default value is 500 with 5000 being the maximum allowed value."
},
"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 diffstats."
}
paginated_environments
{
"type": "object",
"title": "Paginated Deployment Environments",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/deployment_environment"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of environments"
}
paginated_files
{
"type": "object",
"title": "Paginated Files",
"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/commit_file"
},
"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 objects."
}
paginated_hook_events
{
"type": "object",
"title": "Paginated Hook Events",
"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/hook_event"
},
"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 types available to subscribe on."
}
paginated_issue_attachments
{
"type": "object",
"title": "Paginated Issue Attachment",
"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/issue_attachment"
},
"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 issue attachments."
}
paginated_issue_comments
{
"type": "object",
"title": "Paginated Issue 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/issue_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 issue comments."
}
paginated_issues
{
"type": "object",
"title": "Paginated Issues",
"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/issue"
},
"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 issues."
}
paginated_log_entries
{
"type": "object",
"title": "Paginated Log Entries",
"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/issue_change"
},
"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 issue changes."
}
paginated_milestones
{
"type": "object",
"title": "Paginated Milestones",
"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/milestone"
},
"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 milestones."
}
paginated_pipeline_caches
{
"type": "object",
"title": "Paginated Pipeline Cache",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline_cache"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of pipeline caches"
}
paginated_pipeline_known_hosts
{
"type": "object",
"title": "Paginated Pipeline Known Hosts",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline_known_host"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of known hosts."
}
paginated_pipeline_schedule_executions
{
"type": "object",
"title": "Paginated Pipeline Schedule Executions",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline_schedule_execution"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of the executions of a schedule."
}
paginated_pipeline_schedules
{
"type": "object",
"title": "Paginated Pipeline Schedule",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline_schedule"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of schedules"
}
paginated_pipeline_steps
{
"type": "object",
"title": "Paginated Pipeline Steps",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline_step"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of pipeline steps."
}
paginated_pipeline_variables
{
"type": "object",
"title": "Paginated Pipeline Variables",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline_variable"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of variables."
}
paginated_pipelines
{
"type": "object",
"title": "Paginated Pipelines",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/pipeline"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 paged list of pipelines"
}
paginated_project_deploy_keys
{
"type": "object",
"title": "Paginated Project Deploy 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/project_deploy_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 project deploy keys."
}
paginated_project_group_permissions
{
"type": "object",
"title": "Paginated Project 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/project_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 project group permissions."
}
paginated_project_user_permissions
{
"type": "object",
"title": "Paginated Project 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/project_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 project user permissions."
}
paginated_projects
{
"type": "object",
"title": "Paginated Projects",
"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/project"
},
"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 projects"
}
paginated_pullrequest_comments
{
"type": "object",
"title": "Paginated Pull Request 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/pullrequest_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 pullrequest comments."
}
paginated_pullrequests
{
"type": "object",
"title": "Paginated Pull Requests",
"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/pullrequest"
},
"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 pullrequests."
}
paginated_refs
{
"type": "object",
"title": "Paginated Refs",
"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/ref"
},
"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 refs."
}
paginated_reports
{
"type": "object",
"title": "Paginated Reports",
"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",
"description": "Page number of the current results. This is an optional element that is not provided in all responses."
},
"size": {
"type": "integer",
"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/report"
},
"minItems": 0,
"description": "The values of the current page."
},
"pagelen": {
"type": "integer",
"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 reports."
}
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"
]
}
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
}
]
}
snippet_commit
{
"allOf": [
{
"$ref": "#/components/schemas/base_commit"
},
{
"type": "object",
"title": "Snippet Commit",
"properties": {
"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."
}
}
},
"snippet": {
"$ref": "#/components/schemas/snippet"
}
},
"description": "",
"additionalProperties": true
}
]
}
ssh_account_key
{
"allOf": [
{
"$ref": "#/components/schemas/ssh_key"
},
{
"type": "object",
"title": "SSH Account Key",
"properties": {
"owner": {
"$ref": "#/components/schemas/account"
}
},
"description": "Represents an SSH public key for a user.",
"additionalProperties": true
}
]
}
ssh_key
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "SSH Key",
"properties": {
"key": {
"type": "string",
"description": "The SSH public key value in OpenSSH format."
},
"uuid": {
"type": "string",
"description": "The SSH key's immutable ID."
},
"label": {
"type": "string",
"description": "The user-defined label for the SSH 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 SSH key (if present)"
},
"last_used": {
"type": "string",
"format": "date-time"
},
"created_on": {
"type": "string",
"format": "date-time"
}
},
"description": "Base type for representing SSH public keys.",
"additionalProperties": true
}
]
}
stg_west_report
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"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"
]
}
subject_types
{
"type": "object",
"title": "Subject Types",
"properties": {
"workspace": {
"type": "object",
"properties": {
"events": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"repository": {
"type": "object",
"properties": {
"events": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
}
},
"description": "The mapping of resource/subject types pointing to their individual event types."
}
tag
{
"allOf": [
{
"$ref": "#/components/schemas/ref"
},
{
"type": "object",
"title": "Tag",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "The date that the tag was created, if available"
},
"tagger": {
"$ref": "#/components/schemas/author"
},
"message": {
"type": "string",
"description": "The message associated with the tag, if available."
}
},
"description": "A tag object, representing a tag in a repository.",
"additionalProperties": true
}
]
}
task
{
"type": "object",
"title": "Task",
"required": [
"created_on",
"updated_on",
"state",
"content",
"creator"
],
"properties": {
"id": {
"type": "integer"
},
"state": {
"enum": [
"RESOLVED",
"UNRESOLVED"
],
"type": "string"
},
"content": {
"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."
}
}
},
"creator": {
"$ref": "#/components/schemas/account"
},
"pending": {
"type": "boolean"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"resolved_by": {
"$ref": "#/components/schemas/account"
},
"resolved_on": {
"type": "string",
"format": "date-time",
"description": "The ISO8601 timestamp for when the task was resolved."
}
},
"description": "A task object."
}
team
{
"allOf": [
{
"$ref": "#/components/schemas/account"
},
{
"type": "object",
"title": "Team",
"properties": {
"links": {
"$ref": "#/components/schemas/team_links"
}
},
"description": "A team object.",
"additionalProperties": true
}
]
}
team_links
{
"allOf": [
{
"$ref": "#/components/schemas/account_links"
},
{
"type": "object",
"title": "Team Links",
"properties": {
"html": {
"$ref": "#/components/schemas/link"
},
"self": {
"$ref": "#/components/schemas/link"
},
"members": {
"$ref": "#/components/schemas/link"
},
"projects": {
"$ref": "#/components/schemas/link"
},
"repositories": {
"$ref": "#/components/schemas/link"
}
},
"description": "Links related to a Team.",
"additionalProperties": true
}
]
}
treeentry
{
"type": "object",
"title": "Tree Entry",
"required": [
"type"
],
"properties": {
"path": {
"type": "string",
"description": "The path in the repository"
},
"type": {
"type": "string"
},
"commit": {
"$ref": "#/components/schemas/commit"
}
},
"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`.",
"additionalProperties": true
}
user
{
"allOf": [
{
"$ref": "#/components/schemas/account"
},
{
"type": "object",
"title": "User",
"properties": {
"links": {
"$ref": "#/components/schemas/user_links"
},
"website": {
"type": "string"
},
"is_staff": {
"type": "boolean"
},
"nickname": {
"type": "string",
"description": "Account name defined by the owner. Should be used instead of the \"username\" field. Note that \"nickname\" cannot be used in place of \"username\" in URLs and queries, as \"nickname\" is not guaranteed to be unique."
},
"account_id": {
"type": "string",
"description": "The user's Atlassian account ID."
},
"account_status": {
"type": "string",
"description": "The status of the account. Currently the only possible value is \"active\", but more values may be added in the future."
},
"has_2fa_enabled": {
"type": "boolean"
}
},
"description": "A user object.",
"additionalProperties": true
}
]
}
user_links
{
"allOf": [
{
"$ref": "#/components/schemas/account_links"
},
{
"type": "object",
"title": "User Links",
"properties": {
"html": {
"$ref": "#/components/schemas/link"
},
"self": {
"$ref": "#/components/schemas/link"
},
"repositories": {
"$ref": "#/components/schemas/link"
}
},
"description": "Links related to a User.",
"additionalProperties": true
}
]
}
version
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Version",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"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."
}
}
}
},
"description": "A version as defined in a repository's issue tracker.",
"additionalProperties": true
}
]
}
webhook_subscription
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Webhook Subscription",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The URL events get delivered to."
},
"uuid": {
"type": "string",
"description": "The webhook's id"
},
"active": {
"type": "boolean"
},
"events": {
"type": "array",
"items": {
"enum": [
"pullrequest:updated",
"issue:comment_created",
"repo:transfer",
"issue:created",
"pullrequest:rejected",
"repo:deleted",
"pullrequest:fulfilled",
"repo:commit_status_created",
"repo:imported",
"pullrequest:changes_request_created",
"repo:push",
"pullrequest:created",
"pullrequest:comment_created",
"project:updated",
"repo:created",
"repo:commit_status_updated",
"pullrequest:unapproved",
"repo:commit_comment_created",
"pullrequest:comment_reopened",
"repo:fork",
"repo:updated",
"pullrequest:comment_deleted",
"issue:updated",
"pullrequest:changes_request_removed",
"pullrequest:comment_resolved",
"pullrequest:approved",
"pullrequest:comment_updated"
],
"type": "string"
},
"minItems": 1,
"description": "The events this webhook is subscribed to.",
"uniqueItems": true
},
"secret": {
"type": "string",
"maxLength": 128,
"minLength": 0,
"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."
},
"subject": {
"$ref": "#/components/schemas/object"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"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."
},
"description": {
"type": "string",
"description": "A user-defined description of the webhook."
},
"subject_type": {
"enum": [
"repository",
"workspace"
],
"type": "string",
"description": "The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined."
}
},
"description": "A Webhook subscription.",
"additionalProperties": true
}
]
}
workspace
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Workspace",
"properties": {
"name": {
"type": "string",
"description": "The name of the workspace."
},
"slug": {
"type": "string",
"description": "The short label that identifies this workspace."
},
"uuid": {
"type": "string",
"description": "The workspace'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."
},
"self": {
"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."
},
"owners": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"members": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"projects": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"snippets": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
},
"repositories": {
"type": "object",
"title": "Link",
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"name": {
"type": "string"
}
},
"description": "A link to a resource related to this object."
}
}
},
"created_on": {
"type": "string",
"format": "date-time"
},
"is_private": {
"type": "boolean",
"description": "Indicates whether the workspace is publicly accessible, or whether it is\nprivate to the members and consequently only visible to members."
},
"updated_on": {
"type": "string",
"format": "date-time"
}
},
"description": "A Bitbucket workspace.\n Workspaces are used to organize repositories.",
"additionalProperties": true
}
]
}
workspace_membership
{
"allOf": [
{
"$ref": "#/components/schemas/object"
},
{
"type": "object",
"title": "Workspace Membership",
"properties": {
"user": {
"$ref": "#/components/schemas/account"
},
"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."
}
}
},
"workspace": {
"$ref": "#/components/schemas/workspace"
}
},
"description": "A Bitbucket workspace membership.\n Links a user to a workspace.",
"additionalProperties": true
}
]
}