GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions Permissions API

7 actions 7 updates phrasing extends openapi/github-actions-permissions-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 7

$.info
$.paths['/repos/{owner}/{repo}/actions/permissions'].get
$.paths['/repos/{owner}/{repo}/actions/permissions'].put
$.paths['/repos/{owner}/{repo}/actions/permissions/workflow'].get
$.paths['/repos/{owner}/{repo}/actions/permissions/workflow'].put
$.paths['/orgs/{org}/actions/permissions'].get
$.paths['/orgs/{org}/actions/permissions'].put

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 Permissions API
  version: 1.0.0
extends: openapi/github-actions-permissions-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: 6
- target: $.paths['/repos/{owner}/{repo}/actions/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Actions is enabled on a repository
      effect: read
      questions:
      - Is GitHub Actions turned on for this repository, and which actions is it allowed to use?
      - What is the allowed-actions policy for one of my repos?
      instructions:
      - text: Show the Actions permissions policy for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Tell me which actions {owner}/{repo} is allowed to run.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/permissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable Actions and set allowed actions for a repo
      effect: write
      questions:
      - How do I turn off GitHub Actions for a single repository?
      - Can I restrict a repository to only selected actions and reusable workflows?
      instructions:
      - text: Set Actions enabled to {enabled} for {owner}/{repo}.
        slots:
          enabled: requestBody.enabled
          owner: path.owner
          repo: path.repo
      - text: Restrict {owner}/{repo} to allowed actions {allowed_actions}.
        slots:
          owner: path.owner
          repo: path.repo
          allowed_actions: requestBody.allowed_actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/permissions/workflow'].get
  update:
    x-apievangelist-phrasing:
      intent: View default GITHUB_TOKEN permissions for a repo
      effect: read
      questions:
      - Does the GITHUB_TOKEN in my repository's workflows get read-only or read-write access by default?
      - Are workflows in this repo allowed to approve pull request reviews?
      instructions:
      - text: Show the default GITHUB_TOKEN workflow permissions for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Check if workflows in {owner}/{repo} can approve pull requests.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/permissions/workflow'].put
  update:
    x-apievangelist-phrasing:
      intent: Set default GITHUB_TOKEN permissions for a repo
      effect: write
      questions:
      - How do I make the GITHUB_TOKEN read-only by default in a repository?
      - Can I stop workflows from approving pull request reviews in my repo?
      instructions:
      - text: Set the default GITHUB_TOKEN permissions in {owner}/{repo} to {default_workflow_permissions}.
        slots:
          owner: path.owner
          repo: path.repo
          default_workflow_permissions: requestBody.default_workflow_permissions
      - text: Set whether workflows in {owner}/{repo} can approve PR reviews to {can_approve_pull_request_reviews}.
        slots:
          owner: path.owner
          repo: path.repo
          can_approve_pull_request_reviews: requestBody.can_approve_pull_request_reviews
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: View an organization's Actions permissions policy
      effect: read
      questions:
      - Which repositories in my organization are allowed to use GitHub Actions?
      - What actions and reusable workflows does our org policy allow?
      instructions:
      - text: Read the organization-wide Actions policy that {org} applies to all its repositories.
        slots:
          org: path.org
      - text: Tell me which repositories in {org} have Actions enabled by policy.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/permissions'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's Actions permissions policy
      effect: write
      questions:
      - How do I limit GitHub Actions to only selected repositories across my organization?
      - Can I set an org-wide rule that only allows selected actions?
      instructions:
      - text: Enable Actions for {enabled_repositories} repositories in {org}.
        slots:
          enabled_repositories: requestBody.enabled_repositories
          org: path.org
      - text: Set the {org} organization's allowed actions to {allowed_actions}.
        slots:
          org: path.org
          allowed_actions: requestBody.allowed_actions
      method: generated
      generated: '2026-09-26'