Atlassian · Schema

pipeline_step

CodeCollaborationPlatformProductivitySoftware Development
View JSON Schema on GitHub

JSON Schema

atlassian-pipeline-step-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pipeline_step",
  "title": "pipeline_step",
  "allOf": [
    {
      "$ref": "#/components/schemas/object"
    },
    {
      "additionalProperties": true,
      "type": "object",
      "title": "Pipeline Step",
      "description": "A step of a Bitbucket pipeline. This represents the actual result of the step execution.",
      "properties": {
        "uuid": {
          "type": "string",
          "description": "The UUID identifying the step."
        },
        "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."
        },
        "state": {
          "$ref": "#/components/schemas/pipeline_step_state"
        },
        "image": {
          "$ref": "#/components/schemas/pipeline_image"
        },
        "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."
        }
      }
    }
  ],
  "x-bb-default-fields": [
    "uuid"
  ],
  "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
}