GitHub · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for GitHub v3 REST Migrations API
12 actions
12 updates
phrasing
extends
openapi/github-migrations-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 12
$.info
$.paths['/orgs/{org}/migrations'].get
$.paths['/orgs/{org}/migrations'].post
$.paths['/orgs/{org}/migrations/{migration_id}'].get
$.paths['/orgs/{org}/migrations/{migration_id}/archive'].get
$.paths['/orgs/{org}/migrations/{migration_id}/archive'].delete
$.paths['/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock'].delete
$.paths['/orgs/{org}/migrations/{migration_id}/repositories'].get
$.paths['/user/migrations'].get
$.paths['/user/migrations'].post
$.paths['/user/migrations/{migration_id}/archive'].get
$.paths['/user/migrations/{migration_id}/repositories'].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 Migrations API
version: 1.0.0
extends: openapi/github-migrations-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: 11
- target: $.paths['/orgs/{org}/migrations'].get
update:
x-apievangelist-phrasing:
intent: List an organization's recent migrations
effect: read
questions:
- What migrations have been run for my organization recently, exports and imports alike?
- Can I see which organization migration exports are still in progress?
instructions:
- text: List the recent migrations for the {org} organization.
slots:
org: path.org
- text: Show the last {per_page} migrations for {org}.
slots:
org: path.org
per_page: query.per_page
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/migrations'].post
update:
x-apievangelist-phrasing:
intent: Start an organization migration export
effect: write
questions:
- How do I export several of my organization's repositories into a migration archive?
- Can I lock repositories while their organization migration archive is being generated?
- Is it possible to leave out releases or attachments when exporting an org's repos?
instructions:
- text: Start an organization migration for {org} covering the repositories {repositories}.
slots:
org: path.org
repositories: requestBody.repositories
- text: Export {repositories} from {org} into a migration archive and lock them during the export ({lock_repositories}).
slots:
org: path.org
repositories: requestBody.repositories
lock_repositories: requestBody.lock_repositories
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/migrations/{migration_id}'].get
update:
x-apievangelist-phrasing:
intent: Check an organization migration's status
effect: read
questions:
- Has my organization's migration export finished yet, or is it still exporting?
- What state is a specific org migration in right now?
instructions:
- text: Get the status of migration {migration_id} for the {org} organization.
slots:
org: path.org
migration_id: path.migration_id
- text: Check whether org migration {migration_id} in {org} is exported or failed.
slots:
org: path.org
migration_id: path.migration_id
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/migrations/{migration_id}/archive'].get
update:
x-apievangelist-phrasing:
intent: Download an organization migration archive
effect: read
questions:
- Where do I download the archive once my organization migration is exported?
- Can I get a download link for a finished org migration archive?
instructions:
- text: Get the download URL for the archive of migration {migration_id} in {org}.
slots:
org: path.org
migration_id: path.migration_id
- text: Download the {org} organization's migration archive for migration {migration_id}.
slots:
org: path.org
migration_id: path.migration_id
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/migrations/{migration_id}/archive'].delete
update:
x-apievangelist-phrasing:
intent: Delete an organization migration archive
effect: destructive
questions:
- Can I delete an organization migration archive before the seven-day automatic cleanup?
- How do I remove an old org export archive I no longer need?
instructions:
- text: Delete the archive for migration {migration_id} in the {org} organization.
slots:
org: path.org
migration_id: path.migration_id
- text: Remove the {org} org's migration archive from export {migration_id} now instead of waiting seven days.
slots:
org: path.org
migration_id: path.migration_id
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock'].delete
update:
x-apievangelist-phrasing:
intent: Unlock a repository locked for migration
effect: destructive
questions:
- My repository is still locked after an organization migration; how do I unlock it?
- What do I do with repos that were locked during an org export once the migration is done?
instructions:
- text: Unlock repository {repo_name} that was locked by migration {migration_id} in {org}.
slots:
org: path.org
migration_id: path.migration_id
repo_name: path.repo_name
- text: Release the migration lock on {repo_name} in the {org} organization for migration {migration_id}.
slots:
org: path.org
migration_id: path.migration_id
repo_name: path.repo_name
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/migrations/{migration_id}/repositories'].get
update:
x-apievangelist-phrasing:
intent: List repositories in an organization migration
effect: read
questions:
- Which repositories are included in a given organization migration?
- Can I check what repos an org export actually covered?
instructions:
- text: List the repositories included in migration {migration_id} for {org}.
slots:
org: path.org
migration_id: path.migration_id
- text: Show which repos the {org} organization exported in migration {migration_id}.
slots:
org: path.org
migration_id: path.migration_id
method: generated
generated: '2026-09-24'
- target: $.paths['/user/migrations'].get
update:
x-apievangelist-phrasing:
intent: List my user migrations
effect: read
questions:
- What personal account migrations have I started?
- Can I see all the user migration exports I've kicked off on GitHub?
instructions:
- text: List all the user migrations I've started.
- text: Show page {page} of my personal account migrations.
slots:
page: query.page
method: generated
generated: '2026-09-24'
- target: $.paths['/user/migrations'].post
update:
x-apievangelist-phrasing:
intent: Start a user migration export
effect: write
questions:
- How do I export my own personal repositories into a migration archive?
- Can I exclude git data or metadata when exporting my user account's repos?
instructions:
- text: Start a user migration that exports my repositories {repositories}.
slots:
repositories: requestBody.repositories
- text: Create a personal migration archive for {repositories} and lock them while exporting ({lock_repositories}).
slots:
repositories: requestBody.repositories
lock_repositories: requestBody.lock_repositories
method: generated
generated: '2026-09-24'
- target: $.paths['/user/migrations/{migration_id}/archive'].get
update:
x-apievangelist-phrasing:
intent: Download my user migration archive
effect: read
questions:
- Where can I download the tar.gz archive from my personal account migration?
- What's in a user migration archive once I download it?
instructions:
- text: Get the download link for my user migration archive {migration_id}.
slots:
migration_id: path.migration_id
- text: Download the tar.gz from my personal migration {migration_id}.
slots:
migration_id: path.migration_id
method: generated
generated: '2026-09-24'
- target: $.paths['/user/migrations/{migration_id}/repositories'].get
update:
x-apievangelist-phrasing:
intent: List repositories in my user migration
effect: read
questions:
- Which of my repositories were included in a personal account migration?
- Can I list the repos covered by one of my own user migrations?
instructions:
- text: List the repositories in my user migration {migration_id}.
slots:
migration_id: path.migration_id
- text: Show which of my repos personal migration {migration_id} exported.
slots:
migration_id: path.migration_id
method: generated
generated: '2026-09-24'