GitHub: Migrations schemas
5 GitHub schemas with complete fields and constraints.
← Migrations operations · All schemas
Get large files — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Porter Large File |
oid | string | Required within parent | |
path | string | Required within parent | |
ref_name | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List repositories for a user migration — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A GitHub repository. |
archive_url | string | Required within parent | A template for the API URL to download the repository as an archive. |
assignees_url | string | Required within parent | A template for the API URL to list the available assignees for issues in the repository. |
blobs_url | string | Required within parent | A template for the API URL to create or retrieve a raw Git blob in the repository. |
branches_url | string | Required within parent | A template for the API URL to get information about branches in the repository. |
collaborators_url | string | Required within parent | A template for the API URL to get information about collaborators of the repository. |
comments_url | string | Required within parent | A template for the API URL to get information about comments on the repository. |
commits_url | string | Required within parent | A template for the API URL to get information about commits on the repository. |
compare_url | string | Required within parent | A template for the API URL to compare two commits or refs. |
contents_url | string | Required within parent | A template for the API URL to get the contents of the repository. |
contributors_url | string | Required within parent | A template for the API URL to list the contributors to the repository. Format: uri |
deployments_url | string | Required within parent | The API URL to list the deployments of the repository. Format: uri |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | The repository description. |
description (anyOf 2) | null | Alternative | |
downloads_url | string | Required within parent | The API URL to list the downloads on the repository. Format: uri |
events_url | string | Required within parent | The API URL to list the events of the repository. Format: uri |
fork | boolean | Required within parent | Whether the repository is a fork. |
forks_url | string | Required within parent | The API URL to list the forks of the repository. Format: uri |
full_name | string | Required within parent | The full, globally unique, name of the repository. |
git_commits_url | string | Required within parent | A template for the API URL to get information about Git commits of the repository. |
git_refs_url | string | Required within parent | A template for the API URL to get information about Git refs of the repository. |
git_tags_url | string | Required within parent | A template for the API URL to get information about Git tags of the repository. |
hooks_url | string | Required within parent | The API URL to list the hooks on the repository. Format: uri |
html_url | string | Required within parent | The URL to view the repository on GitHub.com. Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | A unique identifier of the repository. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_comment_url | string | Required within parent | A template for the API URL to get information about issue comments on the repository. |
issue_events_url | string | Required within parent | A template for the API URL to get information about issue events on the repository. |
issues_url | string | Required within parent | A template for the API URL to get information about issues on the repository. |
keys_url | string | Required within parent | A template for the API URL to get information about deploy keys on the repository. |
labels_url | string | Required within parent | A template for the API URL to get information about labels of the repository. |
languages_url | string | Required within parent | The API URL to get information about the languages of the repository. Format: uri |
merges_url | string | Required within parent | The API URL to merge branches in the repository. Format: uri |
milestones_url | string | Required within parent | A template for the API URL to get information about milestones of the repository. |
name | string | Required within parent | The name of the repository. |
node_id | string | Required within parent | The GraphQL identifier of the repository. |
notifications_url | string | Required within parent | A template for the API URL to get information about notifications on the repository. |
owner | Model | Required within parent | Expand List users — response body — item |
private | boolean | Required within parent | Whether the repository is private. |
pulls_url | string | Required within parent | A template for the API URL to get information about pull requests on the repository. |
releases_url | string | Required within parent | A template for the API URL to get information about releases on the repository. |
stargazers_url | string | Required within parent | The API URL to list the stargazers on the repository. Format: uri |
statuses_url | string | Required within parent | A template for the API URL to get information about statuses of a commit. |
subscribers_url | string | Required within parent | The API URL to list the subscribers on the repository. Format: uri |
subscription_url | string | Required within parent | The API URL to subscribe to notifications for this repository. Format: uri |
tags_url | string | Required within parent | The API URL to get information about tags on the repository. Format: uri |
teams_url | string | Required within parent | The API URL to list the teams on the repository. Format: uri |
trees_url | string | Required within parent | A template for the API URL to create or retrieve a raw Git tree of the repository. |
url | string | Required within parent | The URL to get more information about the repository from the GitHub API. Format: uri |
Referenced models: List users — response body — item
Map a commit author — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Porter Author |
email | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
import_url | string | Required within parent | Format: uri |
name | string | Required within parent | |
remote_id | string | Required within parent | |
remote_name | string | Required within parent | |
url | string | Required within parent | Format: uri |
Start a user migration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A migration. |
archive_url | string | Optional | Format: uri |
created_at | string | Required within parent | Format: date-time |
exclude | array | Optional | Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. |
exclude[] | string | Each item | Allowed values that can be passed to the exclude parameter. The array can include any of: `"repositories"`. |
exclude_attachments | boolean | Required within parent | |
exclude_git_data | boolean | Required within parent | |
exclude_metadata | boolean | Required within parent | |
exclude_owner_projects | boolean | Required within parent | |
exclude_releases | boolean | Required within parent | |
guid | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
lock_repositories | boolean | Required within parent | |
node_id | string | Required within parent | |
org_metadata_only | boolean | Required within parent | |
owner | Model | Required within parent | Expand Get an issue — response body — user |
repositories | array | Required within parent | The repositories included in the migration. Only returned for export migrations. |
repositories[] | Model | Each item | Expand List repositories for a user migration — response body — item |
state | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an issue — response body — user, List repositories for a user migration — response body — item
Start an import — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A repository import from an external source. |
authors_count | JSON | Optional | |
authors_count (anyOf 1) | JSON | Alternative | |
authors_count (anyOf 1) (anyOf 1) | integer | Alternative | |
authors_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
authors_count (anyOf 2) | null | Alternative | |
authors_url | string | Required within parent | Format: uri |
commit_count | JSON | Optional | |
commit_count (anyOf 1) | JSON | Alternative | |
commit_count (anyOf 1) (anyOf 1) | integer | Alternative | |
commit_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commit_count (anyOf 2) | null | Alternative | |
error_message | JSON | Optional | |
error_message (anyOf 1) | string | Alternative | |
error_message (anyOf 2) | null | Alternative | |
failed_step | JSON | Optional | |
failed_step (anyOf 1) | string | Alternative | |
failed_step (anyOf 2) | null | Alternative | |
has_large_files | boolean | Optional | |
html_url | string | Required within parent | Format: uri |
import_percent | JSON | Optional | |
import_percent (anyOf 1) | JSON | Alternative | |
import_percent (anyOf 1) (anyOf 1) | integer | Alternative | |
import_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
import_percent (anyOf 2) | null | Alternative | |
large_files_count | JSON | Optional | |
large_files_count (anyOf 1) | integer | Alternative | |
large_files_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
large_files_size | JSON | Optional | |
large_files_size (anyOf 1) | integer | Alternative | |
large_files_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Optional | |
project_choices | array | Optional | |
project_choices[] | object | Each item | |
project_choices[].human_name | string | Optional | |
project_choices[].tfvc_project | string | Optional | |
project_choices[].vcs | string | Optional | |
push_percent | JSON | Optional | |
push_percent (anyOf 1) | JSON | Alternative | |
push_percent (anyOf 1) (anyOf 1) | integer | Alternative | |
push_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
push_percent (anyOf 2) | null | Alternative | |
repository_url | string | Required within parent | Format: uri |
status | string | Required within parent | Known values: auth, error, none, detecting, choose, auth_failed, importing, mapping, waiting_to_push, pushing, complete, setup, unknown, detection_found_multiple, detection_found_nothing, detection_needs_auth |
status_text | JSON | Optional | |
status_text (anyOf 1) | string | Alternative | |
status_text (anyOf 2) | null | Alternative | |
svc_root | string | Optional | |
svn_root | string | Optional | |
tfvc_project | string | Optional | |
url | string | Required within parent | Format: uri |
use_lfs | boolean | Optional | |
vcs | JSON | Required within parent | |
vcs (anyOf 1) | string | Alternative | |
vcs (anyOf 2) | null | Alternative | |
vcs_url | string | Required within parent | The URL of the originating repository. |