GitHub · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for GitHub v3 REST Repos API
164 actions
164 updates
phrasing
extends
openapi/github-repos-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 164 · first 16 shown; the file carries all of them
$.info
$.paths['/orgs/{org}/repos'].get
$.paths['/orgs/{org}/repos'].post
$.paths['/repos/{owner}/{repo}'].get
$.paths['/repos/{owner}/{repo}'].delete
$.paths['/repos/{owner}/{repo}'].patch
$.paths['/repos/{owner}/{repo}/autolinks'].get
$.paths['/repos/{owner}/{repo}/autolinks'].post
$.paths['/repos/{owner}/{repo}/autolinks/{autolink_id}'].get
$.paths['/repos/{owner}/{repo}/autolinks/{autolink_id}'].delete
$.paths['/repos/{owner}/{repo}/branches'].get
$.paths['/repos/{owner}/{repo}/branches/{branch}'].get
$.paths['/repos/{owner}/{repo}/branches/{branch}/protection'].get
$.paths['/repos/{owner}/{repo}/branches/{branch}/protection'].put
$.paths['/repos/{owner}/{repo}/branches/{branch}/protection'].delete
$.paths['/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins'].get
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 Repos API
version: 1.0.0
extends: openapi/github-repos-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: 163
- target: $.paths['/orgs/{org}/repos'].get
update:
x-apievangelist-phrasing:
intent: List an organization's repositories
effect: read
questions:
- What repositories does my GitHub organization own?
- Can I list only an org's private or forked repositories?
- Which repos in our org were pushed to most recently?
instructions:
- text: List every repository in the {org} organization.
slots:
org: path.org
- text: Show {type} repositories in {org}, sorted by {sort}.
slots:
type: query.type
org: path.org
sort: query.sort
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/repos'].post
update:
x-apievangelist-phrasing:
intent: Create a repository in an organization
effect: write
questions:
- How do I create a new repository under my organization rather than my personal account?
- Can a new org repo start with a README, a .gitignore template and a license?
- Is it possible to make a new organization repository internal instead of public?
instructions:
- text: Create a repository named {name} in the {org} organization.
slots:
name: requestBody.name
org: path.org
- text: Create a {visibility} repo {name} in {org} with a {license_template} license.
slots:
visibility: requestBody.visibility
name: requestBody.name
org: path.org
license_template: requestBody.license_template
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}'].get
update:
x-apievangelist-phrasing:
intent: Get a repository's details
effect: read
questions:
- Where can I see a repository's default branch, visibility and settings?
- What does the API tell me about a single repo's metadata?
instructions:
- text: Get the details of repository {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show me the default branch and visibility of {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a repository
effect: destructive
questions:
- How do I permanently delete a GitHub repository?
- What permission do I need to delete a repo I administer?
instructions:
- text: Delete the repository {owner}/{repo} permanently.
slots:
owner: path.owner
repo: path.repo
- text: Remove the {repo} repository owned by {owner}.
slots:
repo: path.repo
owner: path.owner
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}'].patch
update:
x-apievangelist-phrasing:
intent: Update a repository's settings
effect: write
questions:
- Can I rename a repository or change its description through the API?
- Is there a way to switch a repo's default branch or turn off its wiki?
- Could I turn on delete-branch-on-merge for an existing repository?
instructions:
- text: Rename repository {owner}/{repo} to {name}.
slots:
owner: path.owner
repo: path.repo
name: requestBody.name
- text: Change the description of {owner}/{repo} to {description}.
slots:
owner: path.owner
repo: path.repo
description: requestBody.description
- text: Set the default branch of {owner}/{repo} to {default_branch}.
slots:
owner: path.owner
repo: path.repo
default_branch: requestBody.default_branch
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/autolinks'].get
update:
x-apievangelist-phrasing:
intent: List a repository's autolinks
effect: read
questions:
- Which autolink references are configured on my repository?
- Can I see all the ticket-number autolinks a repo has set up?
instructions:
- text: List all autolinks configured on {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show the autolink references for the {repo} repo owned by {owner}.
slots:
repo: path.repo
owner: path.owner
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/autolinks'].post
update:
x-apievangelist-phrasing:
intent: Create an autolink reference
effect: write
questions:
- How do I make ticket IDs like JIRA-123 in commits link to our tracker automatically?
- Can an autolink match alphanumeric IDs or only numbers?
instructions:
- text: Add an autolink on {owner}/{repo} turning {key_prefix} references into links to {url_template}.
slots:
owner: path.owner
repo: path.repo
key_prefix: requestBody.key_prefix
url_template: requestBody.url_template
- text: Create an autolink with prefix {key_prefix} and URL template {url_template} in {owner}/{repo}, alphanumeric set to {is_alphanumeric}.
slots:
key_prefix: requestBody.key_prefix
url_template: requestBody.url_template
owner: path.owner
repo: path.repo
is_alphanumeric: requestBody.is_alphanumeric
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/autolinks/{autolink_id}'].get
update:
x-apievangelist-phrasing:
intent: Get one autolink reference
effect: read
questions:
- What URL template does a specific autolink use?
- Can I look up a single autolink by its ID?
instructions:
- text: Get autolink {autolink_id} from {owner}/{repo}.
slots:
autolink_id: path.autolink_id
owner: path.owner
repo: path.repo
- text: Show the prefix and URL template of autolink {autolink_id} on {owner}/{repo}.
slots:
autolink_id: path.autolink_id
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/autolinks/{autolink_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an autolink reference
effect: destructive
questions:
- How do I stop a prefix from being auto-linked in my repository?
- Can I remove an autolink I no longer need?
instructions:
- text: Delete autolink {autolink_id} from {owner}/{repo}.
slots:
autolink_id: path.autolink_id
owner: path.owner
repo: path.repo
- text: Remove the autolink reference {autolink_id} in the {repo} repo of {owner}.
slots:
autolink_id: path.autolink_id
repo: path.repo
owner: path.owner
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches'].get
update:
x-apievangelist-phrasing:
intent: List a repository's branches
effect: read
questions:
- What branches exist in this repository?
- Can I list only the protected branches of a repo?
instructions:
- text: List the branches of {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show only branches in {owner}/{repo} where protected is {protected}.
slots:
owner: path.owner
repo: path.repo
protected: query.protected
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}'].get
update:
x-apievangelist-phrasing:
intent: Get a branch
effect: read
questions:
- Which commit is a given branch pointing at right now?
- Is there a way to check if one particular branch is protected?
instructions:
- text: Get branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show the latest commit on the {branch} branch in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection'].get
update:
x-apievangelist-phrasing:
intent: Get a branch's protection rules
effect: read
questions:
- What protection rules are applied to my main branch?
- Can I see the full branch protection configuration in one call?
instructions:
- text: Get the full protection settings for {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show me every protection rule on branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection'].put
update:
x-apievangelist-phrasing:
intent: Set a branch's protection rules
effect: write
questions:
- How do I protect a branch so it requires reviews and passing checks before merging?
- Can I require a linear history and block force pushes on a branch?
- Does replacing branch protection overwrite the users and teams allowed to push?
instructions:
- text: Protect {branch} in {owner}/{repo} with status checks {required_status_checks} and reviews {required_pull_request_reviews}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
required_status_checks: requestBody.required_status_checks
required_pull_request_reviews: requestBody.required_pull_request_reviews
- text: 'Replace the protection on {branch} in {owner}/{repo}, enforcing it for admins: {enforce_admins}.'
slots:
branch: path.branch
owner: path.owner
repo: path.repo
enforce_admins: requestBody.enforce_admins
- text: Require linear history ({required_linear_history}) on {branch} of {owner}/{repo} in its protection rules.
slots:
required_linear_history: requestBody.required_linear_history
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection'].delete
update:
x-apievangelist-phrasing:
intent: Remove all protection from a branch
effect: destructive
questions:
- How do I completely unprotect a branch?
- Can I drop every protection rule on a branch at once?
instructions:
- text: Remove all branch protection from {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Unprotect the {branch} branch of {owner}/{repo} entirely.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins'].get
update:
x-apievangelist-phrasing:
intent: Check if admins are bound by protection
effect: read
questions:
- Are repository admins also subject to the protection rules on this branch?
- Can I tell whether enforce-for-admins is on for a protected branch?
instructions:
- text: Check whether admin enforcement is on for {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Get the enforce_admins setting of branch {branch} on {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins'].post
update:
x-apievangelist-phrasing:
intent: Enforce branch protection for admins
effect: write
questions:
- How do I make repository admins follow the same branch rules as everyone else?
- Can I stop admins from bypassing protection on a branch?
instructions:
- text: Turn on admin enforcement for branch {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Make admins of {owner}/{repo} obey the protection rules on {branch}.
slots:
owner: path.owner
repo: path.repo
branch: path.branch
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins'].delete
update:
x-apievangelist-phrasing:
intent: Stop enforcing protection for admins
effect: destructive
questions:
- How do I let admins bypass branch protection again?
- Can I turn off enforce-for-admins on a protected branch?
instructions:
- text: Turn off admin enforcement on branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Let admins of {owner}/{repo} bypass protection on {branch} again.
slots:
owner: path.owner
repo: path.repo
branch: path.branch
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews'].get
update:
x-apievangelist-phrasing:
intent: Get required review settings for a branch
effect: read
questions:
- How many approving reviews does this protected branch require?
- Does the branch require code owner reviews before merging?
instructions:
- text: Get the required pull request review settings for {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show how many approvals merging into {branch} of {owner}/{repo} needs.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews'].delete
update:
x-apievangelist-phrasing:
intent: Stop requiring reviews on a branch
effect: destructive
questions:
- How do I remove the required-reviews rule from a protected branch?
- Can pull requests merge into a branch without any approvals after I drop this rule?
instructions:
- text: Remove the required pull request reviews rule from {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Stop requiring review approvals on branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews'].patch
update:
x-apievangelist-phrasing:
intent: Change required review rules on a branch
effect: write
questions:
- Can I raise the number of required approvals on a protected branch?
- Is there a way to dismiss stale reviews automatically when new commits are pushed?
- Could I require approval of the most recent push by someone other than the pusher?
instructions:
- text: Require {required_approving_review_count} approving reviews to merge into {branch} of {owner}/{repo}.
slots:
required_approving_review_count: requestBody.required_approving_review_count
branch: path.branch
owner: path.owner
repo: path.repo
- text: Set require code owner reviews to {require_code_owner_reviews} on {branch} in {owner}/{repo}.
slots:
require_code_owner_reviews: requestBody.require_code_owner_reviews
branch: path.branch
owner: path.owner
repo: path.repo
- text: Turn dismiss stale reviews {dismiss_stale_reviews} for branch {branch} of {owner}/{repo}.
slots:
dismiss_stale_reviews: requestBody.dismiss_stale_reviews
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures'].get
update:
x-apievangelist-phrasing:
intent: Check if a branch requires signed commits
effect: read
questions:
- Does this protected branch require signed commits?
- Can I see whether commit signature verification is enforced on a branch?
instructions:
- text: Check if signed commits are required on {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Get the commit signature protection status of {branch} on {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures'].post
update:
x-apievangelist-phrasing:
intent: Require signed commits on a branch
effect: write
questions:
- How do I force every commit on a protected branch to be signed?
- Can I require GPG or SSH signed commits on main?
instructions:
- text: Require signed commits on branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Turn on commit signature protection for {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures'].delete
update:
x-apievangelist-phrasing:
intent: Stop requiring signed commits on a branch
effect: destructive
questions:
- How do I allow unsigned commits on a protected branch again?
- Can I switch off the signed-commits requirement?
instructions:
- text: Stop requiring signed commits on {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Turn off commit signature protection for branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks'].get
update:
x-apievangelist-phrasing:
intent: Get required status checks for a branch
effect: read
questions:
- Which status checks must pass before merging into this branch?
- Is the branch required to be up to date before merging?
instructions:
- text: Get the required status checks protection for {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show whether {branch} of {owner}/{repo} is strict about being up to date with required checks.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks'].delete
update:
x-apievangelist-phrasing:
intent: Stop requiring status checks on a branch
effect: destructive
questions:
- How do I remove the required status checks rule from a branch entirely?
- Can a branch accept merges without CI passing once I drop this rule?
instructions:
- text: Remove the required status checks rule from {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Stop requiring any status checks to pass before merging into {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks'].patch
update:
x-apievangelist-phrasing:
intent: Change required status check rules
effect: write
questions:
- Can I require branches to be up to date before they merge?
- Is it possible to change which CI checks are required on a protected branch?
instructions:
- text: Set strict up-to-date checking to {strict} on {branch} in {owner}/{repo}.
slots:
strict: requestBody.strict
branch: path.branch
owner: path.owner
repo: path.repo
- text: Require the checks {checks} to pass before merging into {branch} of {owner}/{repo}.
slots:
checks: requestBody.checks
branch: path.branch
owner: path.owner
repo: path.repo
- text: Update the required status check contexts on {branch} in {owner}/{repo} to {contexts}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
contexts: requestBody.contexts
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts'].get
update:
x-apievangelist-phrasing:
intent: List required status check contexts
effect: read
questions:
- What are the names of the status check contexts required on this branch?
- Can I get just the list of required check context names for a branch?
instructions:
- text: List the required status check contexts for {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show the context names required to pass on branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts'].put
update:
x-apievangelist-phrasing:
intent: Replace required status check contexts
effect: write
questions:
- Can I overwrite the whole list of required check contexts on a branch in one go?
- What happens to existing required contexts when I set a new list?
instructions:
- text: Replace the required status check contexts on {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Overwrite the full set of required check contexts for branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts'].post
update:
x-apievangelist-phrasing:
intent: Add required status check contexts
effect: write
questions:
- How do I add one more required CI check to a protected branch without touching the others?
- Can I append a context to the required checks list?
instructions:
- text: Add required status check contexts to {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Append new contexts to the required checks on branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts'].delete
update:
x-apievangelist-phrasing:
intent: Remove required status check contexts
effect: destructive
questions:
- Can I drop just one required check context from a branch and keep the rest?
- How do I stop a retired CI job from being required on a branch?
instructions:
- text: Remove specific required status check contexts from {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Take a retired context off the required checks list for branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions'].get
update:
x-apievangelist-phrasing:
intent: See who may push to a protected branch
effect: read
questions:
- Who is allowed to push to this protected branch?
- Can I see the users, teams and apps with push access on a restricted branch in one response?
instructions:
- text: Get the push access restrictions on {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show every user, team and app allowed to push to {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions'].delete
update:
x-apievangelist-phrasing:
intent: Remove push restrictions from a branch
effect: destructive
questions:
- How do I let anyone with write access push to a restricted branch again?
- Can I lift all push restrictions on a protected branch at once?
instructions:
- text: Delete all push access restrictions on {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Lift the who-can-push restriction from branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps'].get
update:
x-apievangelist-phrasing:
intent: List apps allowed to push to a branch
effect: read
questions:
- Which GitHub Apps can push to this protected branch?
- Does any installed app have push rights on the restricted main branch?
instructions:
- text: List the apps with push access to {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show which GitHub Apps may push to protected branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps'].put
update:
x-apievangelist-phrasing:
intent: Replace the apps allowed to push to a branch
effect: write
questions:
- Can I swap out the entire list of apps permitted to push to a protected branch?
- What happens to apps that already had push access when I set a new app list?
instructions:
- text: Replace the apps allowed to push to {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Reset the app push allowlist on branch {branch} of {owner}/{repo} to a new set.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps'].post
update:
x-apievangelist-phrasing:
intent: Grant an app push access to a branch
effect: write
questions:
- How do I give an installed GitHub App permission to push to a protected branch?
- Can I add an app to a branch's push allowlist without removing the others?
instructions:
- text: Add apps to the push allowlist of {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Grant another GitHub App push access on protected branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps'].delete
update:
x-apievangelist-phrasing:
intent: Revoke an app's push access to a branch
effect: destructive
questions:
- Can I stop a specific GitHub App from pushing to a protected branch?
- How do I take an app off a branch's push allowlist?
instructions:
- text: Remove apps from the push allowlist of {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Revoke a GitHub App's push access on protected branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams'].get
update:
x-apievangelist-phrasing:
intent: List teams allowed to push to a branch
effect: read
questions:
- Which teams can push to this protected branch?
- Is my team on the push allowlist for the release branch?
instructions:
- text: List the teams with push access to {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Show which teams may push to protected branch {branch} of {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams'].put
update:
x-apievangelist-phrasing:
intent: Replace the teams allowed to push to a branch
effect: write
questions:
- Can I overwrite the whole list of teams that may push to a protected branch?
- Does setting a new team list remove teams that could push before?
instructions:
- text: Replace the teams allowed to push to {branch} in {owner}/{repo}.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
- text: Reset the team push allowlist on branch {branch} of {owner}/{repo} to a new set.
slots:
branch: path.branch
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/overlays/github-repos-api-phrasing-overlay.yaml