{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
    },
    "name": {
      "type": "string",
      "description": "Name of the webhook"
    },
    "events": {
      "type": "array",
      "items": {
        "enum": [
          "workflow-completed",
          "job-completed"
        ],
        "type": "string"
      },
      "description": "Events that will trigger the webhook"
    },
    "verify-tls": {
      "type": "boolean",
      "description": "Whether to enforce TLS certificate verification when delivering the webhook"
    },
    "signing-secret": {
      "type": "string",
      "description": "Secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
    }
  },
  "description": "The parameters for an update webhook request"
}

{
  "type": "object",
  "title": "Webhook",
  "required": [
    "id",
    "scope",
    "name",
    "events",
    "url",
    "verify-tls",
    "signing-secret",
    "created-at",
    "updated-at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique ID of the webhook"
    },
    "url": {
      "type": "string",
      "description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
    },
    "name": {
      "type": "string",
      "description": "Name of the webhook"
    },
    "scope": {
      "type": "object",
      "required": [
        "id",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the scope being used (at the moment, only project ID is supported)"
        },
        "type": {
          "type": "string",
          "description": "Type of the scope being used"
        }
      },
      "description": "The scope in which the relevant events that will trigger webhooks"
    },
    "events": {
      "type": "array",
      "items": {
        "enum": [
          "workflow-completed",
          "job-completed"
        ],
        "type": "string"
      },
      "description": "Events that will trigger the webhook"
    },
    "created-at": {
      "type": "string",
      "format": "date-time",
      "example": "2015-09-21T17:29:21.042Z",
      "description": "The date and time the webhook was created."
    },
    "updated-at": {
      "type": "string",
      "format": "date-time",
      "example": "2015-09-21T17:29:21.042Z",
      "description": "The date and time the webhook was last updated."
    },
    "verify-tls": {
      "type": "boolean",
      "description": "Whether to enforce TLS certificate verification when delivering the webhook"
    },
    "signing-secret": {
      "type": "string",
      "description": "Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
    }
  }
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "MessageResponse",
  "required": [
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message"
    }
  },
  "description": "message response"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "MessageResponse",
  "required": [
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message"
    }
  },
  "description": "message response"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Workflow",
  "required": [
    "id",
    "name",
    "status",
    "created_at",
    "stopped_at",
    "pipeline_id",
    "pipeline_number",
    "project_slug",
    "started_by"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique ID of the workflow."
    },
    "tag": {
      "enum": [
        "setup"
      ],
      "type": "string",
      "example": "setup",
      "x-nullable": true,
      "description": "Tag used for the workflow"
    },
    "name": {
      "type": "string",
      "example": "build-and-test",
      "description": "The name of the workflow."
    },
    "status": {
      "enum": [
        "success",
        "running",
        "not_run",
        "failed",
        "error",
        "failing",
        "on_hold",
        "canceled",
        "unauthorized"
      ],
      "type": "string",
      "description": "The current status of the workflow."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the workflow was created."
    },
    "errored_by": {
      "type": "string",
      "format": "uuid"
    },
    "started_by": {
      "type": "string",
      "format": "uuid"
    },
    "stopped_at": {
      "type": "string",
      "format": "date-time",
      "x-nullable": true,
      "description": "The date and time the workflow stopped."
    },
    "canceled_by": {
      "type": "string",
      "format": "uuid"
    },
    "pipeline_id": {
      "type": "string",
      "format": "uuid",
      "example": "5034460f-c7c4-4c43-9457-de07e2029e7b",
      "description": "The ID of the pipeline this workflow belongs to."
    },
    "project_slug": {
      "type": "string",
      "example": "gh/CircleCI-Public/api-preview-docs",
      "description": "The project-slug for the pipeline this workflow belongs to."
    },
    "pipeline_number": {
      "type": "integer",
      "format": "int64",
      "example": 25,
      "description": "The number of the pipeline this workflow belongs to."
    }
  },
  "description": "A workflow"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "WorkflowJobListResponse",
  "required": [
    "items",
    "next_page_token"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Job",
        "required": [
          "id",
          "name",
          "started_at",
          "dependencies",
          "project_slug",
          "status",
          "type"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique ID of the job."
          },
          "name": {
            "type": "string",
            "description": "The name of the job."
          },
          "type": {
            "enum": [
              "build",
              "approval"
            ],
            "type": "string",
            "description": "The type of job."
          },
          "status": {
            "enum": [
              "success",
              "running",
              "not_run",
              "failed",
              "retried",
              "queued",
              "not_running",
              "infrastructure_fail",
              "timedout",
              "on_hold",
              "terminated-unknown",
              "blocked",
              "canceled",
              "unauthorized"
            ],
            "type": "string",
            "description": "The current status of the job."
          },
          "job_number": {
            "type": "integer",
            "format": "int64",
            "description": "The number of the job."
          },
          "started_at": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the job started."
          },
          "stopped_at": {
            "type": "string",
            "format": "date-time",
            "x-nullable": true,
            "description": "The time when the job stopped."
          },
          "approved_by": {
            "type": "string",
            "format": "uuid",
            "description": "The unique ID of the user."
          },
          "canceled_by": {
            "type": "string",
            "format": "uuid",
            "description": "The unique ID of the user."
          },
          "dependencies": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid",
              "description": "The unique ID of the job."
            },
            "description": "A sequence of the unique job IDs for the jobs that this job depends upon in the workflow."
          },
          "project_slug": {
            "type": "string",
            "example": "gh/CircleCI-Public/api-preview-docs",
            "description": "The project-slug for the job."
          },
          "approval_request_id": {
            "type": "string",
            "format": "uuid",
            "description": "The unique ID of the job."
          }
        },
        "description": "Job"
      }
    },
    "next_page_token": {
      "type": "string",
      "x-nullable": true,
      "description": "A token to pass as a `page-token` query parameter to return the next page of results."
    }
  }
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "RerunWorkflowParameters",
  "properties": {
    "jobs": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "example": [
        "c65b68ef-e73b-4bf2-be9a-7a322a9df150",
        "5e957edd-5e8c-4985-9178-5d0d69561822"
      ],
      "description": "A list of job IDs to rerun."
    },
    "enable_ssh": {
      "type": "boolean",
      "example": false,
      "description": "Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter."
    },
    "from_failed": {
      "type": "boolean",
      "example": false,
      "description": "Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter."
    },
    "sparse_tree": {
      "type": "boolean",
      "example": false,
      "description": "Completes rerun using sparse trees logic, an optimization for workflows that have disconnected subgraphs. Requires jobs parameter and so is mutually exclusive with the from_failed parameter."
    }
  },
  "x-nullable": true,
  "description": "The information you can supply when rerunning a workflow."
}

{
  "type": "object",
  "required": [
    "workflow_id"
  ],
  "properties": {
    "workflow_id": {
      "type": "string",
      "format": "uuid",
      "example": "0e53027b-521a-4c40-9042-47e72b3c63a3",
      "description": "The ID of the newly-created workflow."
    }
  },
  "description": "A response to rerunning a workflow"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID of the restriction"
          },
          "name": {
            "type": "string",
            "description": "Contains a human-readable reference for the restriction. For\n\"project\" restrictions this is the name of the project.\n\nMay be null.\n"
          },
          "context_id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID of the context"
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "deprecated": true,
            "description": "Deprecated - For \"project\" restrictions read the project ID from\n\"restriction_value\" instead.\n\nUUID of the project used in a project restriction.\n"
          },
          "restriction_type": {
            "enum": [
              "project",
              "expression"
            ],
            "type": "string",
            "description": "Type of the restriction"
          },
          "restriction_value": {
            "type": "string",
            "description": "Value used to evaluate the restriction"
          }
        },
        "additionalProperties": false
      }
    },
    "next_page_token": {
      "type": "string",
      "nullable": true,
      "description": "Token that can be used to retrieve next page of results"
    }
  }
}

{
  "type": "object",
  "properties": {
    "advanced": {
      "type": "object",
      "properties": {
        "oss": {
          "type": "boolean",
          "description": "Free and Open Source. Enabling this grants additional credits, and lets others see your builds, both through the web UI and the API."
        },
        "disable_ssh": {
          "type": "boolean",
          "description": "When set to true, job re-runs with SSH debugging access will be disabled for the project."
        },
        "build_fork_prs": {
          "type": "boolean",
          "description": "Run builds for pull requests from forks."
        },
        "build_prs_only": {
          "type": "boolean",
          "description": "Once enabled, we will only build branches that have associated pull requests open."
        },
        "setup_workflows": {
          "type": "boolean",
          "description": "Enabling allows you to conditionally trigger configurations outside of the primary `.circleci` parent directory."
        },
        "autocancel_builds": {
          "type": "boolean",
          "description": "Except for the default branch, cancel running pipelines on a branch when a new pipeline starts on that branch."
        },
        "set_github_status": {
          "type": "boolean",
          "description": "Report the status of every pushed commit to GitHub's status API. Updates reported per job."
        },
        "pr_only_branch_overrides": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "This field is used in conjunction with the `build_prs_only`, it allows you to specify a list of branches that will always triger a build. The value passed will overwrite the existing value."
        },
        "forks_receive_secret_env_vars": {
          "type": "boolean",
          "description": "Run builds for forked pull requests with this project's configuration, environment variables, and secrets."
        },
        "write_settings_requires_admin": {
          "type": "boolean",
          "description": "Whether updating these settings requires a user to be an organization administrator. When disabled, updating settings can be done by any member."
        }
      }
    }
  }
}

{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "UUID of the project restriction"
    },
    "name": {
      "type": "string",
      "description": "Contains a human-readable reference for the restriction. For\n\"project\" restrictions this is the name of the project.\n\nMay be null.\n"
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Deprecated - For \"project\" restrictions read the project ID from\n\"restriction_value\" instead.\n\nUUID of the project used in a project restriction.\n"
    },
    "restriction_type": {
      "enum": [
        "project",
        "expression"
      ],
      "type": "string",
      "description": "Type of the restriction"
    },
    "restriction_value": {
      "type": "string",
      "description": "Value used to evaluate the restriction"
    }
  },
  "additionalProperties": false
}

{
  "properties": {
    "message": {
      "type": "string",
      "description": "Response message"
    }
  },
  "additionalProperties": false
}