# 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 Workflows API
  version: 1.0.0
extends: openapi/github-actions-workflows-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: 7
- target: $.paths['/repos/{owner}/{repo}/actions/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List the workflows defined in a repository
      effect: read
      questions:
      - What GitHub Actions workflows exist in my repository?
      - Which workflow files are active and which are disabled?
      instructions:
      - text: List the workflows defined in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show every workflow file and its state in {repo}.
        slots:
          repo: path.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/workflows/{workflow_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one workflow's definition details
      effect: read
      questions:
      - Can I look up a workflow by its file name, like ci.yml, instead of its numeric ID?
      - What state is a particular workflow in right now?
      instructions:
      - text: Get workflow {workflow_id} in {owner}/{repo}.
        slots:
          workflow_id: path.workflow_id
          owner: path.owner
          repo: path.repo
      - text: Show the path and state of the {workflow_id} workflow file.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Disable a workflow
      effect: write
      questions:
      - How do I stop a workflow from running without deleting its file?
      - Can I pause a scheduled workflow so it stops triggering?
      instructions:
      - text: Disable workflow {workflow_id} in {owner}/{repo}.
        slots:
          workflow_id: path.workflow_id
          owner: path.owner
          repo: path.repo
      - text: Turn off the {workflow_id} workflow so it no longer triggers.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a disabled workflow
      effect: write
      questions:
      - How do I turn a manually disabled workflow back on?
      - Can I reactivate a workflow so it starts triggering again?
      instructions:
      - text: Enable workflow {workflow_id} in {owner}/{repo}.
        slots:
          workflow_id: path.workflow_id
          owner: path.owner
          repo: path.repo
      - text: Reactivate the disabled {workflow_id} workflow.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches'].post
  update:
    x-apievangelist-phrasing:
      intent: Manually trigger a workflow run
      effect: write
      questions:
      - How do I kick off a workflow on demand through the API?
      - Can I pass inputs when I manually trigger a workflow_dispatch workflow?
      - Which branch or tag does a manually dispatched workflow run against?
      instructions:
      - text: Trigger workflow {workflow_id} in {owner}/{repo} on {ref}.
        slots:
          workflow_id: path.workflow_id
          owner: path.owner
          repo: path.repo
          ref: requestBody.ref
      - text: Dispatch {workflow_id} on branch {ref} with inputs {inputs}.
        slots:
          workflow_id: path.workflow_id
          ref: requestBody.ref
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the runs of one specific workflow
      effect: read
      questions:
      - What is the run history of just my deploy workflow?
      - Can I see only the failed runs of one workflow on a given branch?
      instructions:
      - text: List the runs of workflow {workflow_id} in {owner}/{repo}.
        slots:
          workflow_id: path.workflow_id
          owner: path.owner
          repo: path.repo
      - text: Show runs of the {workflow_id} workflow on {branch} with status {status}.
        slots:
          workflow_id: path.workflow_id
          branch: query.branch
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing'].get
  update:
    x-apievangelist-phrasing:
      intent: Check billable minutes used by a workflow
      effect: read
      questions:
      - How many billable minutes has one workflow used this billing cycle?
      - Which runner operating systems is a workflow spending minutes on?
      instructions:
      - text: Get the billable minutes used by workflow {workflow_id} in {owner}/{repo} this cycle.
        slots:
          workflow_id: path.workflow_id
          owner: path.owner
          repo: path.repo
      - text: Show this billing cycle's usage for the {workflow_id} workflow.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'