View Source CircleCI.Workflow (CircleCI API Client v0.1.0)

Provides API endpoints related to workflow

Summary

Types

Link to this type

get_workflow_by_id_default_json_resp()

View Source
@type get_workflow_by_id_default_json_resp() :: %{message: String.t() | nil}
Link to this type

list_workflow_jobs_200_json_resp()

View Source
@type list_workflow_jobs_200_json_resp() :: %{
  items: [CircleCI.Job.t()],
  next_page_token: String.t() | nil
}
Link to this type

list_workflow_jobs_default_json_resp()

View Source
@type list_workflow_jobs_default_json_resp() :: %{message: String.t() | nil}
@type t() :: %CircleCI.Workflow{
  canceled_by: String.t() | nil,
  created_at: DateTime.t(),
  errored_by: String.t() | nil,
  id: String.t(),
  name: String.t(),
  pipeline_id: String.t(),
  pipeline_number: integer(),
  project_slug: String.t(),
  started_by: String.t(),
  status: String.t(),
  stopped_at: DateTime.t() | nil,
  tag: String.t() | nil
}

Functions

Link to this function

get_workflow_by_id(id, opts \\ [])

View Source
@spec get_workflow_by_id(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, map()}

Get a workflow

Returns summary fields of a workflow by ID.

Link to this function

list_workflow_jobs(id, opts \\ [])

View Source
@spec list_workflow_jobs(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, map()}

Get a workflow's jobs

Returns a sequence of jobs for a workflow.