DEdepot
CIService

GetJobSummary

Returns authored step summary markdown for a job, a specific attempt, or both.

post/depot.ci.v1.CIService/GetJobSummary

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

jobIdstring

Unique identifier for the job whose current attempt should be summarized. Required unless attemptId is set.

attemptIdstring

Unique identifier for a specific job attempt to summarize. Required unless jobId is set. When sent alongside jobId, the attempt must belong to that job.

Response

Success

orgIdstring

Organization that owns this job.

runIdstring

Unique identifier for the parent CI run.

workflowIdstring

Unique identifier for the parent workflow.

jobIdstring

Unique identifier for the job.

attemptIdstring

Unique identifier for the job attempt. Empty when no attempt exists yet.

attemptinteger

Attempt number, starting at 1. Zero when no attempt exists yet.

jobStatusstring

Current state of the job. Can be "queued", "waiting", "running", "finished", "failed", "cancelled", or "skipped". "waiting" means the job is blocked behind another run that holds the same concurrency: group slot.

attemptStatusstring

Current state of the attempt. Can be "queued", "waiting", "running", "finished", "failed", or "cancelled". Empty when no attempt exists yet.

hasSummaryboolean

True when authored step summary markdown is available for the selected attempt.

emptyReasonstring

Set when hasSummary is false, for example "no_summary" or "no_attempt".

stepCountinteger

Count of non-empty step summaries included in markdown.

markdownstring

Authored step summary markdown joined in step order.

Changes

No recorded changes to this operation across all 1 revision of this API.