Atlassian · Schema

pipeline_schedule_post_request_body

CodeCollaborationPlatformProductivitySoftware Development
View JSON Schema on GitHub

JSON Schema

atlassian-pipeline-schedule-post-request-body-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pipeline_schedule_post_request_body",
  "title": "pipeline_schedule_post_request_body",
  "allOf": [
    {
      "$ref": "#/components/schemas/object"
    },
    {
      "additionalProperties": true,
      "type": "object",
      "title": "Request body for Pipeline Schedule POST request",
      "properties": {
        "target": {
          "type": "object",
          "description": "The target on which the schedule will be executed.",
          "properties": {
            "selector": {
              "$ref": "#/components/schemas/pipeline_selector"
            },
            "ref_name": {
              "type": "string",
              "description": "The name of the reference."
            },
            "ref_type": {
              "type": "string",
              "description": "The type of reference (branch only).",
              "enum": [
                "branch"
              ]
            }
          },
          "required": [
            "selector",
            "ref_name",
            "ref_type"
          ]
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether the schedule is enabled."
        },
        "cron_pattern": {
          "type": "string",
          "description": "The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day."
        }
      },
      "required": [
        "target",
        "cron_pattern"
      ]
    }
  ]
}