# 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 Workflow Runs API
  version: 1.0.0
extends: openapi/github-actions-workflow-runs-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: 17
- target: $.paths['/repos/{owner}/{repo}/actions/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow runs across a whole repository
      effect: read
      questions:
      - What workflow runs have happened in my repository recently, across all workflows?
      - Can I filter all of a repo's runs by who triggered them or by event type?
      - Which runs in the repository are still in progress?
      instructions:
      - text: List all workflow runs in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show repo-wide runs in {owner}/{repo} triggered by {actor} on branch {branch}.
        slots:
          owner: path.owner
          repo: path.repo
          actor: query.actor
          branch: query.branch
      - text: List every run in the repository with status {status} from {event} events.
        slots:
          status: query.status
          event: query.event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of one workflow run
      effect: read
      questions:
      - Did a particular workflow run succeed or fail?
      - What commit and branch did a given run build?
      instructions:
      - text: Get workflow run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Tell me the status and conclusion of run {run_id}.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workflow run
      effect: destructive
      questions:
      - How do I remove an old workflow run from my repository's history?
      - Who is allowed to delete a workflow run?
      instructions:
      - text: Delete workflow run {run_id} from {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Remove run {run_id} from the run history entirely.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a first-time contributor's fork run
      effect: write
      questions:
      - How do I let a workflow run from a first-time contributor's fork pull request go ahead?
      - Why is a fork PR's workflow waiting, and can I approve it through the API?
      instructions:
      - text: Approve the fork pull request run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Allow the first-time contributor's workflow run {run_id} to start.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/approvals'].get
  update:
    x-apievangelist-phrasing:
      intent: See the deployment review history for a run
      effect: read
      questions:
      - Who approved or rejected the deployments in a workflow run, and with what comment?
      - What is the review history for a run that went through environment approvals?
      instructions:
      - text: Show the review history for run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: List who reviewed the deployments in run {run_id} and what they decided.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attempt of a re-run workflow
      effect: read
      questions:
      - What was the outcome of the first attempt before I re-ran a workflow?
      - Can I look at a specific retry attempt of a run?
      instructions:
      - text: Get 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 the conclusion of attempt {attempt_number} of workflow 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/runs/{run_id}/attempts/{attempt_number}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Download logs for one attempt of a run
      effect: read
      questions:
      - How do I download the logs from an earlier attempt of a run I have since re-run?
      - Can I get the log archive for just one retry attempt?
      instructions:
      - text: Download the logs for 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: Fetch the log archive 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/runs/{run_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a workflow run
      effect: destructive
      questions:
      - How do I stop a workflow run that is in progress?
      - Can I cancel a queued run before it starts?
      instructions:
      - text: Cancel workflow run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Stop the in-progress run {run_id}.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a custom deployment protection rule
      effect: write
      questions:
      - How does a custom deployment protection rule app approve a waiting run?
      - Can I reject a custom protection gate for an environment and leave a comment?
      instructions:
      - text: Set the custom protection rule for environment {environment_name} on run {run_id} in {owner}/{repo} to {state}.
        slots:
          environment_name: requestBody.environment_name
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
          state: requestBody.state
      - text: Reject the custom deployment gate for {environment_name} on run {run_id} with comment {comment}.
        slots:
          environment_name: requestBody.environment_name
          run_id: path.run_id
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Force cancel a stuck workflow run
      effect: destructive
      questions:
      - What can I do when a workflow run ignores a normal cancel request?
      - Is there a way to force-stop a hung run?
      instructions:
      - text: Force cancel run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Force-stop the unresponsive run {run_id} that will not cancel normally.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Download all logs for a workflow run
      effect: read
      questions:
      - How do I download the complete log archive of a workflow run?
      - How long does the run log download link stay valid?
      instructions:
      - text: Download the full log archive for run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Get me the zipped logs of every job in run {run_id}.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/logs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the logs of a workflow run
      effect: destructive
      questions:
      - How do I wipe the logs of a run that accidentally printed a secret?
      - Can I delete a run's logs but keep the run record?
      instructions:
      - text: Delete all logs for run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Purge the log output of run {run_id}.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments waiting on protection rules
      effect: read
      questions:
      - Which environments is a workflow run waiting on before it can deploy?
      - Is my run stuck waiting for a required reviewer, and who can approve it?
      instructions:
      - text: Show the pending deployments for run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: List the environments run {run_id} is waiting to deploy to.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject deployments awaiting a reviewer
      effect: write
      questions:
      - How do I approve a deployment that is waiting for me as a required reviewer?
      - Can I reject a pending deployment to several environments at once?
      instructions:
      - text: Mark pending deployments to environments {environment_ids} on run {run_id} in {owner}/{repo} as {state} with comment {comment}.
        slots:
          environment_ids: requestBody.environment_ids
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
          state: requestBody.state
          comment: requestBody.comment
      - text: 'As required reviewer, approve the waiting deployment to {environment_ids} for run {run_id}: {comment}.'
        slots:
          environment_ids: requestBody.environment_ids
          run_id: path.run_id
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/rerun'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-run an entire workflow run
      effect: write
      questions:
      - How do I re-run every job in a workflow run?
      - Can I re-run a whole workflow with debug logging turned on?
      instructions:
      - text: Re-run the whole of workflow run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Re-run all jobs of run {run_id} with debug logging {enable_debug_logging}.
        slots:
          run_id: path.run_id
          enable_debug_logging: requestBody.enable_debug_logging
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-run only the failed jobs of a run
      effect: write
      questions:
      - Can I retry just the jobs that failed in a run and skip the ones that passed?
      - How do I re-run failed jobs along with the jobs that depend on them?
      instructions:
      - text: Re-run the failed jobs in run {run_id} of {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Retry only what failed in run {run_id}, with debug logging {enable_debug_logging}.
        slots:
          run_id: path.run_id
          enable_debug_logging: requestBody.enable_debug_logging
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/timing'].get
  update:
    x-apievangelist-phrasing:
      intent: Check billable minutes and run time for a run
      effect: read
      questions:
      - How many billable minutes did a single workflow run consume?
      - How long did one run take in total?
      instructions:
      - text: Get the billable minutes and run duration of run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Show how much time run {run_id} was billed for.
        slots:
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'