GitHub · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for GitHub v3 REST Actions API
138 actions
138 updates
phrasing
extends
openapi/github-actions-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for GitHub's API. It is a proposal applied on top of the contract, not a document GitHub publishes.
What the actions change
x-apievangelist-phrasing
Targets 138 · first 16 shown; the file carries all of them
$.info
$.paths['/enterprises/{enterprise}/actions/cache/usage'].get
$.paths['/enterprises/{enterprise}/actions/cache/usage-policy'].get
$.paths['/enterprises/{enterprise}/actions/cache/usage-policy'].patch
$.paths['/enterprises/{enterprise}/actions/permissions/workflow'].get
$.paths['/enterprises/{enterprise}/actions/permissions/workflow'].put
$.paths['/orgs/{org}/actions/cache/usage'].get
$.paths['/orgs/{org}/actions/cache/usage-by-repository'].get
$.paths['/orgs/{org}/actions/permissions'].get
$.paths['/orgs/{org}/actions/permissions'].put
$.paths['/orgs/{org}/actions/permissions/repositories'].get
$.paths['/orgs/{org}/actions/permissions/repositories'].put
$.paths['/orgs/{org}/actions/permissions/repositories/{repository_id}'].put
$.paths['/orgs/{org}/actions/permissions/repositories/{repository_id}'].delete
$.paths['/orgs/{org}/actions/permissions/selected-actions'].get
$.paths['/orgs/{org}/actions/permissions/selected-actions'].put
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 v3 REST Actions API
version: 1.0.0
extends: openapi/github-actions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-24'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 137
- target: $.paths['/enterprises/{enterprise}/actions/cache/usage'].get
update:
x-apievangelist-phrasing:
intent: Check Actions cache usage for an enterprise
effect: read
questions:
- How much GitHub Actions cache storage is my whole enterprise using right now?
- Is enterprise-wide Actions cache usage data real time, or delayed by a few minutes?
instructions:
- text: Show total Actions cache usage across enterprise {enterprise}.
slots:
enterprise: path.enterprise
- text: Tell me how many active caches enterprise {enterprise} has and their total size.
slots:
enterprise: path.enterprise
method: generated
generated: '2026-09-24'
- target: $.paths['/enterprises/{enterprise}/actions/cache/usage-policy'].get
update:
x-apievangelist-phrasing:
intent: Get the enterprise Actions cache size policy
effect: read
questions:
- What cache size limit do repos in my enterprise get for GitHub Actions by default?
- Which maximum repo cache size has my enterprise set as its Actions policy?
instructions:
- text: Get the Actions cache usage policy for enterprise {enterprise}.
slots:
enterprise: path.enterprise
- text: Show the default and maximum repo cache size limits configured for enterprise {enterprise}.
slots:
enterprise: path.enterprise
method: generated
generated: '2026-09-24'
- target: $.paths['/enterprises/{enterprise}/actions/cache/usage-policy'].patch
update:
x-apievangelist-phrasing:
intent: Set the enterprise Actions cache size policy
effect: write
questions:
- Can I raise the default Actions cache size limit for every repo in my enterprise?
- How do I cap how large a repository's Actions cache can be enterprise-wide?
instructions:
- text: Set the default repo Actions cache limit for enterprise {enterprise} to {repo_cache_size_limit_in_gb} GB.
slots:
enterprise: path.enterprise
repo_cache_size_limit_in_gb: requestBody.repo_cache_size_limit_in_gb
- text: Cap the maximum repo cache size in enterprise {enterprise} at {max_repo_cache_size_limit_in_gb} GB.
slots:
enterprise: path.enterprise
max_repo_cache_size_limit_in_gb: requestBody.max_repo_cache_size_limit_in_gb
method: generated
generated: '2026-09-24'
- target: $.paths['/enterprises/{enterprise}/actions/permissions/workflow'].get
update:
x-apievangelist-phrasing:
intent: Get default GITHUB_TOKEN permissions for an enterprise
effect: read
questions:
- What permissions does GITHUB_TOKEN get by default in workflows across my enterprise?
- Are Actions workflows in my enterprise allowed to approve pull requests?
instructions:
- text: Show the default workflow token permissions for enterprise {enterprise}.
slots:
enterprise: path.enterprise
- text: Check whether Actions can approve pull request reviews in enterprise {enterprise}.
slots:
enterprise: path.enterprise
method: generated
generated: '2026-09-24'
- target: $.paths['/enterprises/{enterprise}/actions/permissions/workflow'].put
update:
x-apievangelist-phrasing:
intent: Set default GITHUB_TOKEN permissions for an enterprise
effect: write
questions:
- Can I make GITHUB_TOKEN read-only by default for every workflow in my enterprise?
- How do I stop Actions from approving pull requests anywhere in my enterprise?
instructions:
- text: Set the default workflow token permissions for enterprise {enterprise} to {default_workflow_permissions}.
slots:
enterprise: path.enterprise
default_workflow_permissions: requestBody.default_workflow_permissions
- text: Set whether Actions can approve pull request reviews in enterprise {enterprise} to {can_approve_pull_request_reviews}.
slots:
enterprise: path.enterprise
can_approve_pull_request_reviews: requestBody.can_approve_pull_request_reviews
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/cache/usage'].get
update:
x-apievangelist-phrasing:
intent: Check Actions cache usage for an organization
effect: read
questions:
- How much Actions cache storage is my organization using in total?
- What is the combined size of all active GitHub Actions caches in my org?
instructions:
- text: Show total Actions cache usage for organization {org}.
slots:
org: path.org
- text: Tell me the org-wide Actions cache count and size for {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/cache/usage-by-repository'].get
update:
x-apievangelist-phrasing:
intent: List repos by Actions cache usage in an org
effect: read
questions:
- Which repositories in my organization are using the most Actions cache?
- Can I see a per-repository breakdown of Actions cache usage across my org?
instructions:
- text: List each repository's Actions cache usage in organization {org}.
slots:
org: path.org
- text: Show page {page} of the per-repo Actions cache breakdown for {org}.
slots:
page: query.page
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions'].get
update:
x-apievangelist-phrasing:
intent: Get the Actions permissions policy for an org
effect: read
questions:
- Which repositories in my organization are allowed to run GitHub Actions?
- 'What actions policy does my org apply to repos: all actions, local only, or selected?'
instructions:
- text: Get the Actions permissions policy for organization {org}.
slots:
org: path.org
- text: Show which repos and which actions are allowed to run in {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions'].put
update:
x-apievangelist-phrasing:
intent: Set the Actions permissions policy for an org
effect: write
questions:
- Can I turn GitHub Actions on for only selected repositories in my organization?
- How do I restrict my org so only certain actions are allowed to run?
instructions:
- text: Set Actions in organization {org} to run in {enabled_repositories} repositories.
slots:
org: path.org
enabled_repositories: requestBody.enabled_repositories
- text: Enable Actions for {enabled_repositories} repos in {org} and allow {allowed_actions} actions.
slots:
enabled_repositories: requestBody.enabled_repositories
org: path.org
allowed_actions: requestBody.allowed_actions
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/repositories'].get
update:
x-apievangelist-phrasing:
intent: List repos enabled for Actions in an org
effect: read
questions:
- Which specific repositories have been picked to run Actions in my org?
- When my org enables Actions for selected repos only, how do I see that list?
instructions:
- text: List the repositories selected to run Actions in organization {org}.
slots:
org: path.org
- text: Show page {page} of Actions-enabled selected repos in {org}.
slots:
page: query.page
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/repositories'].put
update:
x-apievangelist-phrasing:
intent: Replace the repos enabled for Actions in an org
effect: write
questions:
- Can I replace the whole list of repositories allowed to run Actions in my org at once?
- What happens to repos left out when I reset the org's Actions-enabled repository list?
instructions:
- text: Replace the Actions-enabled repositories in organization {org} with {selected_repository_ids}.
slots:
org: path.org
selected_repository_ids: requestBody.selected_repository_ids
- text: Make only repository IDs {selected_repository_ids} able to run Actions in {org}.
slots:
selected_repository_ids: requestBody.selected_repository_ids
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/repositories/{repository_id}'].put
update:
x-apievangelist-phrasing:
intent: Enable Actions for one repo in an org
effect: write
questions:
- How do I let one more repository in my org start running GitHub Actions?
- Can I add a single repo to my org's selected Actions repositories without touching the rest?
instructions:
- text: Enable Actions for repository {repository_id} in organization {org}.
slots:
repository_id: path.repository_id
org: path.org
- text: Add repo {repository_id} to the Actions-enabled list in {org}.
slots:
repository_id: path.repository_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/repositories/{repository_id}'].delete
update:
x-apievangelist-phrasing:
intent: Disable Actions for one repo in an org
effect: destructive
questions:
- How do I stop one repository in my org from running GitHub Actions?
- Can I pull a single repo out of my org's Actions-enabled list?
instructions:
- text: Disable Actions for repository {repository_id} in organization {org}.
slots:
repository_id: path.repository_id
org: path.org
- text: Remove repo {repository_id} from the Actions-enabled repositories in {org}.
slots:
repository_id: path.repository_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/selected-actions'].get
update:
x-apievangelist-phrasing:
intent: Get the allowed actions list for an org
effect: read
questions:
- Which actions and reusable workflows are allowed to run in my organization?
- Does my org allow GitHub-owned actions, and what name patterns are permitted?
instructions:
- text: Show the allowed actions settings for organization {org}.
slots:
org: path.org
- text: List the action patterns permitted in {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/selected-actions'].put
update:
x-apievangelist-phrasing:
intent: Set the allowed actions list for an org
effect: write
questions:
- Can I allow only GitHub-owned actions plus a few named patterns in my org?
- How do I allowlist specific third-party actions for my whole organization?
instructions:
- text: Allow actions matching {patterns_allowed} in organization {org}.
slots:
patterns_allowed: requestBody.patterns_allowed
org: path.org
- text: Set GitHub-owned actions allowed to {github_owned_allowed} and patterns to {patterns_allowed} for {org}.
slots:
github_owned_allowed: requestBody.github_owned_allowed
patterns_allowed: requestBody.patterns_allowed
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/workflow'].get
update:
x-apievangelist-phrasing:
intent: Get default GITHUB_TOKEN permissions for an org
effect: read
questions:
- What access does GITHUB_TOKEN have by default in my organization's workflows?
- Can workflows in my org approve pull requests right now?
instructions:
- text: Show default workflow token permissions for organization {org}.
slots:
org: path.org
- text: Check whether Actions may approve pull request reviews in {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/permissions/workflow'].put
update:
x-apievangelist-phrasing:
intent: Set default GITHUB_TOKEN permissions for an org
effect: write
questions:
- How can I make workflow tokens read-only by default across my organization?
- Can I let Actions approve pull requests in my org?
instructions:
- text: Set default workflow token permissions in organization {org} to {default_workflow_permissions}.
slots:
org: path.org
default_workflow_permissions: requestBody.default_workflow_permissions
- text: Set pull request approval by Actions in {org} to {can_approve_pull_request_reviews}.
slots:
org: path.org
can_approve_pull_request_reviews: requestBody.can_approve_pull_request_reviews
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups'].get
update:
x-apievangelist-phrasing:
intent: List self-hosted runner groups in an org
effect: read
questions:
- Which self-hosted runner groups exist in my organization, including enterprise ones?
- Can I see only the runner groups a particular repository is allowed to use?
instructions:
- text: List self-hosted runner groups in organization {org}.
slots:
org: path.org
- text: Show runner groups in {org} visible to repository {visible_to_repository}.
slots:
org: path.org
visible_to_repository: query.visible_to_repository
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups'].post
update:
x-apievangelist-phrasing:
intent: Create a self-hosted runner group in an org
effect: write
questions:
- How do I create a new group to organize self-hosted runners in my organization?
- Can a new runner group be limited to selected repositories or specific workflows?
instructions:
- text: Create a runner group named {name} in organization {org}.
slots:
name: requestBody.name
org: path.org
- text: Create runner group {name} in {org} with {visibility} visibility for repositories {selected_repository_ids}.
slots:
name: requestBody.name
org: path.org
visibility: requestBody.visibility
selected_repository_ids: requestBody.selected_repository_ids
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a self-hosted runner group in an org
effect: read
questions:
- What are the settings of a specific runner group in my org?
- Is one of my org's runner groups restricted to certain workflows?
instructions:
- text: Get runner group {runner_group_id} in organization {org}.
slots:
runner_group_id: path.runner_group_id
org: path.org
- text: Show the visibility and workflow restrictions of runner group {runner_group_id} in {org}.
slots:
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a self-hosted runner group from an org
effect: destructive
questions:
- How do I delete a runner group my organization no longer needs?
- Can I remove an entire self-hosted runner group from my org?
instructions:
- text: Delete runner group {runner_group_id} from organization {org}.
slots:
runner_group_id: path.runner_group_id
org: path.org
- text: Remove the self-hosted runner group {runner_group_id} in {org}.
slots:
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a self-hosted runner group in an org
effect: write
questions:
- Can I rename a runner group or change who can see it in my org?
- How do I let an existing runner group be used by public repositories?
instructions:
- text: Rename runner group {runner_group_id} in organization {org} to {name}.
slots:
runner_group_id: path.runner_group_id
org: path.org
name: requestBody.name
- text: Set runner group {runner_group_id} in {org} to name {name} with {visibility} visibility.
slots:
runner_group_id: path.runner_group_id
org: path.org
name: requestBody.name
visibility: requestBody.visibility
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories'].get
update:
x-apievangelist-phrasing:
intent: List repos that can use an org runner group
effect: read
questions:
- Which repositories are allowed to use a given runner group in my org?
- What repos currently have access to one of my organization's runner groups?
instructions:
- text: List repositories with access to runner group {runner_group_id} in organization {org}.
slots:
runner_group_id: path.runner_group_id
org: path.org
- text: Show page {page} of repos that can use runner group {runner_group_id} in {org}.
slots:
page: query.page
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories'].put
update:
x-apievangelist-phrasing:
intent: Replace the repos that can use an org runner group
effect: write
questions:
- Can I overwrite the full list of repos allowed to use a runner group in one call?
- What does resetting a runner group's repository access to a new list look like?
instructions:
- text: Replace the repos with access to runner group {runner_group_id} in {org} with {selected_repository_ids}.
slots:
runner_group_id: path.runner_group_id
org: path.org
selected_repository_ids: requestBody.selected_repository_ids
- text: Give only repositories {selected_repository_ids} access to runner group {runner_group_id} in {org}.
slots:
selected_repository_ids: requestBody.selected_repository_ids
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}'].put
update:
x-apievangelist-phrasing:
intent: Grant one repo access to an org runner group
effect: write
questions:
- How do I let one more repository use a runner group with selected visibility?
- Can I add a single repo to a runner group's access list?
instructions:
- text: Grant repository {repository_id} access to runner group {runner_group_id} in organization {org}.
slots:
repository_id: path.repository_id
runner_group_id: path.runner_group_id
org: path.org
- text: Add repo {repository_id} to runner group {runner_group_id} in {org}.
slots:
repository_id: path.repository_id
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}'].delete
update:
x-apievangelist-phrasing:
intent: Revoke one repo's access to an org runner group
effect: destructive
questions:
- How do I stop a repository from using one of my org's runner groups?
- Can I take a single repo out of a runner group's access list?
instructions:
- text: Revoke repository {repository_id} access to runner group {runner_group_id} in organization {org}.
slots:
repository_id: path.repository_id
runner_group_id: path.runner_group_id
org: path.org
- text: Remove repo {repository_id} from runner group {runner_group_id} access in {org}.
slots:
repository_id: path.repository_id
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/runners'].get
update:
x-apievangelist-phrasing:
intent: List the runners in an org runner group
effect: read
questions:
- Which self-hosted runners belong to a particular group in my org?
- What machines are assigned to one of my organization's runner groups?
instructions:
- text: List the runners in runner group {runner_group_id} in organization {org}.
slots:
runner_group_id: path.runner_group_id
org: path.org
- text: Show page {page} of runners assigned to group {runner_group_id} in {org}.
slots:
page: query.page
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/runners'].put
update:
x-apievangelist-phrasing:
intent: Replace the runners in an org runner group
effect: write
questions:
- Can I replace every runner in a group with a new set in one step?
- How do I redefine exactly which runners make up an org runner group?
instructions:
- text: Replace the runners in group {runner_group_id} in {org} with {runners}.
slots:
runner_group_id: path.runner_group_id
org: path.org
runners: requestBody.runners
- text: Make runner group {runner_group_id} in organization {org} contain only runners {runners}.
slots:
runner_group_id: path.runner_group_id
org: path.org
runners: requestBody.runners
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}'].put
update:
x-apievangelist-phrasing:
intent: Add a runner to an org runner group
effect: write
questions:
- How do I move a self-hosted runner into a specific runner group in my org?
- Can I assign one runner to a runner group without changing the others?
instructions:
- text: Add runner {runner_id} to runner group {runner_group_id} in organization {org}.
slots:
runner_id: path.runner_id
runner_group_id: path.runner_group_id
org: path.org
- text: Put self-hosted runner {runner_id} into group {runner_group_id} in {org}.
slots:
runner_id: path.runner_id
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a runner from an org runner group
effect: destructive
questions:
- What happens to a runner when I take it out of an org runner group?
- Can I send a runner back to the default group in my organization?
instructions:
- text: Remove runner {runner_id} from runner group {runner_group_id} in organization {org}.
slots:
runner_id: path.runner_id
runner_group_id: path.runner_group_id
org: path.org
- text: Move runner {runner_id} out of group {runner_group_id} in {org} back to the default group.
slots:
runner_id: path.runner_id
runner_group_id: path.runner_group_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners'].get
update:
x-apievangelist-phrasing:
intent: List self-hosted runners in an org
effect: read
questions:
- Which self-hosted runners are registered to my organization?
- Can I see every org-level runner along with its status?
instructions:
- text: List all self-hosted runners in organization {org}.
slots:
org: path.org
- text: Show page {page} of self-hosted runners for {org}.
slots:
page: query.page
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/downloads'].get
update:
x-apievangelist-phrasing:
intent: List runner app downloads for an org
effect: read
questions:
- Where do I download the runner application binaries to set up an org runner?
- Which operating systems and architectures is the runner application offered for?
instructions:
- text: List runner application downloads for organization {org}.
slots:
org: path.org
- text: Get the runner binaries I can install for {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/registration-token'].post
update:
x-apievangelist-phrasing:
intent: Create a token to register an org runner
effect: write
questions:
- How do I get a token to register a new self-hosted runner with my organization?
- How long does an org runner registration token stay valid?
instructions:
- text: Create a runner registration token for organization {org}.
slots:
org: path.org
- text: Generate a token so I can configure a new self-hosted runner in {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/remove-token'].post
update:
x-apievangelist-phrasing:
intent: Create a token to remove an org runner
effect: write
questions:
- What token do I need to unregister a self-hosted runner from my organization with the config script?
- Can I generate a one-hour token for removing an org runner?
instructions:
- text: Create a runner remove token for organization {org}.
slots:
org: path.org
- text: Generate a token to unregister a self-hosted runner from {org}.
slots:
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/{runner_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a self-hosted runner in an org
effect: read
questions:
- Is a specific self-hosted runner in my org online and busy?
- What details does GitHub hold for one of my organization's runners?
instructions:
- text: Get self-hosted runner {runner_id} in organization {org}.
slots:
runner_id: path.runner_id
org: path.org
- text: Show the status of runner {runner_id} registered to {org}.
slots:
runner_id: path.runner_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/{runner_id}'].delete
update:
x-apievangelist-phrasing:
intent: Force-remove a self-hosted runner from an org
effect: destructive
questions:
- How do I remove a runner from my org when its machine no longer exists?
- Can I force-delete an organization runner without running the config script?
instructions:
- text: Delete self-hosted runner {runner_id} from organization {org}.
slots:
runner_id: path.runner_id
org: path.org
- text: Force-remove runner {runner_id} from {org}.
slots:
runner_id: path.runner_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/{runner_id}/labels'].get
update:
x-apievangelist-phrasing:
intent: List labels on an org runner
effect: read
questions:
- Which labels are attached to one of my organization's self-hosted runners?
- What labels can workflows target on a given org runner?
instructions:
- text: List labels on self-hosted runner {runner_id} in organization {org}.
slots:
runner_id: path.runner_id
org: path.org
- text: Show all labels for runner {runner_id} in {org}.
slots:
runner_id: path.runner_id
org: path.org
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/{runner_id}/labels'].put
update:
x-apievangelist-phrasing:
intent: Replace custom labels on an org runner
effect: write
questions:
- Can I wipe an org runner's custom labels and set a fresh list in one call?
- How do I overwrite all custom labels on a runner in my organization?
instructions:
- text: Replace the custom labels on runner {runner_id} in organization {org} with {labels}.
slots:
runner_id: path.runner_id
org: path.org
labels: requestBody.labels
- text: Set runner {runner_id} in {org} to have exactly the custom labels {labels}.
slots:
runner_id: path.runner_id
org: path.org
labels: requestBody.labels
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/{runner_id}/labels'].post
update:
x-apievangelist-phrasing:
intent: Add custom labels to an org runner
effect: write
questions:
- How do I tag an org self-hosted runner with extra labels like gpu?
- Can I append custom labels to a runner without losing the ones it already has?
instructions:
- text: Add labels {labels} to self-hosted runner {runner_id} in organization {org}.
slots:
labels: requestBody.labels
runner_id: path.runner_id
org: path.org
- text: Tag runner {runner_id} in {org} with {labels}.
slots:
runner_id: path.runner_id
org: path.org
labels: requestBody.labels
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/actions/runners/{runner_id}/labels'].delete
update:
x-apievangelist-phrasing:
intent: Clear all custom labels from an org runner
effect: destructive
questions:
- How do I strip every custom label from an org runner and keep only the built-in ones?
- Which labels remain after clearing custom labels from a runner?
instructions:
- text: Remove all custom labels from runner {runner_id} in organization {org}.
slots:
runner_id: path.runner_id
org: path.org
- text: Clear custom labels on self-hosted runner {runner_id} in {org}.
slots:
runner_id: path.runner_id
org: path.org
method: generated
generated: '2026-09-24'
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/overlays/github-actions-api-phrasing-overlay.yaml