GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions Jobs API

6 actions 6 updates phrasing extends openapi/github-actions-jobs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GitHub Actions's API. It is a proposal applied on top of the contract, not a document GitHub Actions publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/jobs'].get
$.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs'].get
$.paths['/repos/{owner}/{repo}/actions/jobs/{job_id}'].get
$.paths['/repos/{owner}/{repo}/actions/jobs/{job_id}/logs'].get
$.paths['/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GitHub Actions Jobs API
  version: 1.0.0
extends: openapi/github-actions-jobs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the jobs in a workflow run
      effect: read
      questions:
      - Which jobs ran in a workflow run and which of them failed?
      - Can I see only the latest attempt's jobs, or every job across all attempts?
      instructions:
      - text: List the jobs in run {run_id} of {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Show all jobs from every attempt of run {run_id} using filter {filter}.
        slots:
          run_id: path.run_id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs for a specific run attempt
      effect: read
      questions:
      - What jobs ran during the second attempt of a re-run workflow?
      - How do I compare the jobs from one retry attempt of a run?
      instructions:
      - text: List the jobs from attempt {attempt_number} of run {run_id} in {owner}/{repo}.
        slots:
          attempt_number: path.attempt_number
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Show which jobs were part of retry attempt {attempt_number} of run {run_id}.
        slots:
          attempt_number: path.attempt_number
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status and steps of one job
      effect: read
      questions:
      - Which step of a job failed and on what runner did it run?
      - Can I check the conclusion of a single job by its ID?
      instructions:
      - text: Get job {job_id} in {owner}/{repo}.
        slots:
          job_id: path.job_id
          owner: path.owner
          repo: path.repo
      - text: Show the steps and conclusion of job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/jobs/{job_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the log of a single job
      effect: read
      questions:
      - How do I download the plain text log for one job instead of the whole run?
      - How long does a job log download link stay valid?
      instructions:
      - text: Download the log for job {job_id} in {owner}/{repo}.
        slots:
          job_id: path.job_id
          owner: path.owner
          repo: path.repo
      - text: Fetch the text log of job {job_id} so I can see why it failed.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-run a single job and its dependents
      effect: write
      questions:
      - Can I retry just one job instead of the whole workflow run?
      - Is it possible to turn on debug logging when I re-run a single job?
      instructions:
      - text: Re-run job {job_id} in {owner}/{repo}.
        slots:
          job_id: path.job_id
          owner: path.owner
          repo: path.repo
      - text: Retry job {job_id} with debug logging set to {enable_debug_logging}.
        slots:
          job_id: path.job_id
          enable_debug_logging: requestBody.enable_debug_logging
      method: generated
      generated: '2026-09-26'