View Source GitHub.Migrations (GitHub REST API Client v0.0.1-beta.0)

Provides API endpoints related to migrations

Link to this section Summary

Functions

Delete an organization migration archive

Download an organization migration archive

Get an organization migration status

List organization migrations

List repositories for a user migration

List repositories in an organization migration

Start an organization migration

Link to this section Functions

Link to this function

cancel_import(owner, repo, opts \\ [])

View Source
@spec cancel_import(String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Cancel an import

resources

Resources

Link to this function

delete_archive_for_authenticated_user(migration_id, opts \\ [])

View Source
@spec delete_archive_for_authenticated_user(
  integer(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Delete a user migration archive

resources

Resources

Link to this function

delete_archive_for_org(org, migration_id, opts \\ [])

View Source
@spec delete_archive_for_org(String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete an organization migration archive

resources

Resources

Link to this function

download_archive_for_org(org, migration_id, opts \\ [])

View Source
@spec download_archive_for_org(String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Download an organization migration archive

resources

Resources

Link to this function

get_archive_for_authenticated_user(migration_id, opts \\ [])

View Source
@spec get_archive_for_authenticated_user(
  integer(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Download a user migration archive

resources

Resources

Link to this function

get_commit_authors(owner, repo, opts \\ [])

View Source
@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

Link to this function

get_import_status(owner, repo, opts \\ [])

View Source
@spec get_import_status(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}

Get an import status

resources

Resources

Link to this function

get_large_files(owner, repo, opts \\ [])

View Source
@spec get_large_files(String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.PorterLargeFile.t()]} | {:error, GitHub.Error.t()}

Get large files

resources

Resources

Link to this function

get_status_for_authenticated_user(migration_id, opts \\ [])

View Source
@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

Link to this function

get_status_for_org(org, migration_id, opts \\ [])

View Source
@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

Link to this function

list_for_authenticated_user(opts \\ [])

View Source
@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

Link to this function

list_for_org(org, opts \\ [])

View Source
@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

Link to this function

list_repos_for_authenticated_user(migration_id, opts \\ [])

View Source
@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

Link to this function

list_repos_for_org(org, migration_id, opts \\ [])

View Source
@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

Link to this function

map_commit_author(owner, repo, author_id, body, opts \\ [])

View Source
@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

Link to this function

set_lfs_preference(owner, repo, body, opts \\ [])

View Source
@spec set_lfs_preference(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}

Update Git LFS preference

resources

Resources

Link to this function

start_for_authenticated_user(body, opts \\ [])

View Source
@spec start_for_authenticated_user(
  map(),
  keyword()
) :: {:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}

Start a user migration

resources

Resources

Link to this function

start_for_org(org, body, opts \\ [])

View Source
@spec start_for_org(String.t(), map(), keyword()) ::
  {:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}

Start an organization migration

resources

Resources

Link to this function

start_import(owner, repo, body, opts \\ [])

View Source
@spec start_import(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}

Start an import

resources

Resources

Link to this function

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

Link to this function

unlock_repo_for_org(org, migration_id, repo_name, opts \\ [])

View Source
@spec unlock_repo_for_org(String.t(), integer(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Unlock an organization repository

resources

Resources

Link to this function

update_import(owner, repo, body, opts \\ [])

View Source
@spec update_import(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}

Update an import

resources

Resources