GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions Self-Hosted Runner Groups API

6 actions 6 updates phrasing extends openapi/github-actions-self-hosted-runner-groups-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['/orgs/{org}/actions/runner-groups'].get

$.paths['/orgs/{org}/actions/runner-groups'].post

$.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].get

$.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].delete

$.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].patch

OpenAPI Overlay

# 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 Self-Hosted Runner Groups API
  version: 1.0.0
extends: openapi/github-actions-self-hosted-runner-groups-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['/orgs/{org}/actions/runner-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's self-hosted runner groups
      effect: read
      questions:
      - What self-hosted runner groups has my organization set up?
      - How are our organization's runners grouped for access control?
      instructions:
      - text: List the self-hosted runner groups in {org}.
        slots:
          org: path.org
      - text: Show every runner group configured for the {org} organization.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/runner-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a self-hosted runner group
      effect: write
      questions:
      - How do I create a new group to organize my organization's self-hosted runners?
      - Can a new runner group be limited to selected repositories from the start?
      instructions:
      - text: Create a runner group named {name} in {org}.
        slots:
          name: requestBody.name
          org: path.org
      - text: Create runner group {name} with visibility {visibility} for repositories {selected_repository_ids}.
        slots:
          name: requestBody.name
          visibility: requestBody.visibility
          selected_repository_ids: requestBody.selected_repository_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the settings of one runner group
      effect: read
      questions:
      - What visibility does a particular self-hosted runner group have?
      - Can I look up a single runner group's settings by its ID?
      instructions:
      - text: Get runner group {runner_group_id} in {org}.
        slots:
          runner_group_id: path.runner_group_id
          org: path.org
      - text: Show the name and visibility of runner group {runner_group_id}.
        slots:
          runner_group_id: path.runner_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a self-hosted runner group
      effect: destructive
      questions:
      - How do I delete a runner group my organization no longer uses?
      - Can I remove a self-hosted runner group from the org entirely?
      instructions:
      - text: Delete runner group {runner_group_id} from {org}.
        slots:
          runner_group_id: path.runner_group_id
          org: path.org
      - text: Remove the unused runner group {runner_group_id}.
        slots:
          runner_group_id: path.runner_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or change visibility of a runner group
      effect: write
      questions:
      - How do I rename an existing self-hosted runner group?
      - Can I change an existing runner group's visibility from all repositories to selected ones?
      instructions:
      - text: Rename runner group {runner_group_id} in {org} to {name}.
        slots:
          runner_group_id: path.runner_group_id
          org: path.org
          name: requestBody.name
      - text: Change existing runner group {runner_group_id} to name {name} and visibility {visibility}.
        slots:
          runner_group_id: path.runner_group_id
          name: requestBody.name
          visibility: requestBody.visibility
      method: generated
      generated: '2026-09-26'