View Source GitHub.Migrations (GitHub REST API Client v0.0.1)
Provides API endpoints related to migrations
Link to this section Summary
Functions
Cancel an import
Delete a user migration archive
Delete an organization migration archive
Download an organization migration archive
Download a user migration archive
Get commit authors
Get an import status
Get large files
Get a user migration status
Get an organization migration status
List user migrations
List organization migrations
List repositories for a user migration
List repositories in an organization migration
Map a commit author
Update Git LFS preference
Start a user migration
Start an organization migration
Start an import
Unlock a user repository
Unlock an organization repository
Update an import
Link to this section Functions
@spec cancel_import(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Cancel an import
resources
Resources
@spec delete_archive_for_authenticated_user( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a user migration archive
resources
Resources
@spec delete_archive_for_org(String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete an organization migration archive
resources
Resources
@spec download_archive_for_org(String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Download an organization migration archive
resources
Resources
@spec get_archive_for_authenticated_user( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Download a user migration archive
resources
Resources
@spec get_commit_authors(String.t(), String.t(), keyword()) :: {:ok, [GitHub.PorterAuthor.t()]} | {:error, GitHub.Error.t()}
Get commit authors
options
Options
since
(integer): A user ID. Only return users with an ID greater than this ID.
resources
Resources
@spec get_import_status(String.t(), String.t(), keyword()) :: {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
Get an import status
resources
Resources
@spec get_large_files(String.t(), String.t(), keyword()) :: {:ok, [GitHub.PorterLargeFile.t()]} | {:error, GitHub.Error.t()}
Get large files
resources
Resources
@spec get_status_for_authenticated_user( integer(), keyword() ) :: {:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
Get a user migration status
options
Options
exclude
([String.t()]):
resources
Resources
@spec get_status_for_org(String.t(), integer(), keyword()) :: {:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
Get an organization migration status
options
Options
exclude
([String.t()]): Exclude attributes from the API response to improve performance
resources
Resources
@spec list_for_authenticated_user(keyword()) :: {:ok, [GitHub.Migration.t()]} | {:error, GitHub.Error.t()}
List user migrations
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_org( String.t(), keyword() ) :: {:ok, [GitHub.Migration.t()]} | {:error, GitHub.Error.t()}
List organization migrations
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.exclude
([String.t()]): Exclude attributes from the API response to improve performance
resources
Resources
@spec list_repos_for_authenticated_user( integer(), keyword() ) :: {:ok, [GitHub.MinimalRepository.t()]} | {:error, GitHub.Error.t()}
List repositories for a user migration
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repos_for_org(String.t(), integer(), keyword()) :: {:ok, [GitHub.MinimalRepository.t()]} | {:error, GitHub.Error.t()}
List repositories in an organization migration
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec map_commit_author(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PorterAuthor.t()} | {:error, GitHub.Error.t()}
Map a commit author
resources
Resources
@spec set_lfs_preference(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
Update Git LFS preference
resources
Resources
@spec start_for_authenticated_user( map(), keyword() ) :: {:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
Start a user migration
resources
Resources
@spec start_for_org(String.t(), map(), keyword()) :: {:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
Start an organization migration
resources
Resources
@spec start_import(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
Start an import
resources
Resources
unlock_repo_for_authenticated_user(migration_id, repo_name, opts \\ [])
View Source@spec unlock_repo_for_authenticated_user(integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Unlock a user repository
resources
Resources
@spec unlock_repo_for_org(String.t(), integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Unlock an organization repository
resources
Resources
@spec update_import(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
Update an import