defmodule GitHub.Migrations do
@moduledoc """
Provides API endpoints related to migrations
"""
@default_client GitHub.Client
@doc """
Cancel an import
Stop an import for a repository.
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#cancel-an-import)
"""
@spec cancel_import(String.t(), String.t(), keyword) :: :ok | {:error, GitHub.Error.t()}
def cancel_import(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Migrations, :cancel_import},
url: "/repos/#{owner}/#{repo}/import",
method: :delete,
response: [{204, :null}, {503, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Delete a user migration archive
Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive)
"""
@spec delete_archive_for_authenticated_user(integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_archive_for_authenticated_user(migration_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [migration_id: migration_id],
call: {GitHub.Migrations, :delete_archive_for_authenticated_user},
url: "/user/migrations/#{migration_id}/archive",
method: :delete,
response: [
{204, :null},
{304, :null},
{401, {GitHub.BasicError, :t}},
{403, {GitHub.BasicError, :t}},
{404, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Delete an organization migration archive
Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive)
"""
@spec delete_archive_for_org(String.t(), integer, keyword) :: :ok | {:error, GitHub.Error.t()}
def delete_archive_for_org(org, migration_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, migration_id: migration_id],
call: {GitHub.Migrations, :delete_archive_for_org},
url: "/orgs/#{org}/migrations/#{migration_id}/archive",
method: :delete,
response: [{204, :null}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Download an organization migration archive
Fetches the URL to a migration archive.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive)
"""
@spec download_archive_for_org(String.t(), integer, keyword) :: :ok | {:error, GitHub.Error.t()}
def download_archive_for_org(org, migration_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, migration_id: migration_id],
call: {GitHub.Migrations, :download_archive_for_org},
url: "/orgs/#{org}/migrations/#{migration_id}/archive",
method: :get,
response: [{302, :null}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Download a user migration archive
Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
* attachments
* bases
* commit\_comments
* issue\_comments
* issue\_events
* issues
* milestones
* organizations
* projects
* protected\_branches
* pull\_request\_reviews
* pull\_requests
* releases
* repositories
* review\_comments
* schema
* users
The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive)
"""
@spec get_archive_for_authenticated_user(integer, keyword) :: :ok | {:error, GitHub.Error.t()}
def get_archive_for_authenticated_user(migration_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [migration_id: migration_id],
call: {GitHub.Migrations, :get_archive_for_authenticated_user},
url: "/user/migrations/#{migration_id}/archive",
method: :get,
response: [
{302, :null},
{304, :null},
{401, {GitHub.BasicError, :t}},
{403, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Get commit authors
Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.
This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Options
* `since`: A user ID. Only return users with an ID greater than this ID.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#get-commit-authors)
"""
@spec get_commit_authors(String.t(), String.t(), keyword) ::
{:ok, [GitHub.PorterAuthor.t()]} | {:error, GitHub.Error.t()}
def get_commit_authors(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:since])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Migrations, :get_commit_authors},
url: "/repos/#{owner}/#{repo}/import/authors",
method: :get,
query: query,
response: [
{200, [{GitHub.PorterAuthor, :t}]},
{404, {GitHub.BasicError, :t}},
{503, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Get an import status
View the progress of an import.
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
**Import status**
This section includes details about the possible values of the `status` field of the Import Progress response.
An import that does not have errors will progress through these steps:
* `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
* `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
* `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
* `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
* `complete` - the import is complete, and the repository is ready on GitHub.
If there are problems, you will see one of these in the `status` field:
* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
**The project_choices field**
When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
**Git LFS related fields**
This section includes details about Git LFS related fields that may be present in the Import Progress response.
* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#get-an-import-status)
"""
@spec get_import_status(String.t(), String.t(), keyword) ::
{:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
def get_import_status(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Migrations, :get_import_status},
url: "/repos/#{owner}/#{repo}/import",
method: :get,
response: [
{200, {GitHub.Import, :t}},
{404, {GitHub.BasicError, :t}},
{503, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Get large files
List files larger than 100MB found during the import
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#get-large-files)
"""
@spec get_large_files(String.t(), String.t(), keyword) ::
{:ok, [GitHub.PorterLargeFile.t()]} | {:error, GitHub.Error.t()}
def get_large_files(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Migrations, :get_large_files},
url: "/repos/#{owner}/#{repo}/import/large_files",
method: :get,
response: [{200, [{GitHub.PorterLargeFile, :t}]}, {503, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Get a user migration status
Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:
* `pending` - the migration hasn't started yet.
* `exporting` - the migration is in progress.
* `exported` - the migration finished successfully.
* `failed` - the migration failed.
Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).
## Options
* `exclude`
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#get-a-user-migration-status)
"""
@spec get_status_for_authenticated_user(integer, keyword) ::
{:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
def get_status_for_authenticated_user(migration_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:exclude])
client.request(%{
args: [migration_id: migration_id],
call: {GitHub.Migrations, :get_status_for_authenticated_user},
url: "/user/migrations/#{migration_id}",
method: :get,
query: query,
response: [
{200, {GitHub.Migration, :t}},
{304, :null},
{401, {GitHub.BasicError, :t}},
{403, {GitHub.BasicError, :t}},
{404, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Get an organization migration status
Fetches the status of a migration.
The `state` of a migration can be one of the following values:
* `pending`, which means the migration hasn't started yet.
* `exporting`, which means the migration is in progress.
* `exported`, which means the migration finished successfully.
* `failed`, which means the migration failed.
## Options
* `exclude`: Exclude attributes from the API response to improve performance
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status)
"""
@spec get_status_for_org(String.t(), integer, keyword) ::
{:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
def get_status_for_org(org, migration_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:exclude])
client.request(%{
args: [org: org, migration_id: migration_id],
call: {GitHub.Migrations, :get_status_for_org},
url: "/orgs/#{org}/migrations/#{migration_id}",
method: :get,
query: query,
response: [{200, {GitHub.Migration, :t}}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
List user migrations
Lists all migrations a user has started.
## Options
* `per_page`: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
* `page`: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#list-user-migrations)
"""
@spec list_for_authenticated_user(keyword) ::
{:ok, [GitHub.Migration.t()]} | {:error, GitHub.Error.t()}
def list_for_authenticated_user(opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [],
call: {GitHub.Migrations, :list_for_authenticated_user},
url: "/user/migrations",
method: :get,
query: query,
response: [
{200, [{GitHub.Migration, :t}]},
{304, :null},
{401, {GitHub.BasicError, :t}},
{403, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
List organization migrations
Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
A list of `repositories` is only returned for export migrations.
## Options
* `per_page`: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
* `page`: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
* `exclude`: Exclude attributes from the API response to improve performance
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#list-organization-migrations)
"""
@spec list_for_org(String.t(), keyword) ::
{:ok, [GitHub.Migration.t()]} | {:error, GitHub.Error.t()}
def list_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:exclude, :page, :per_page])
client.request(%{
args: [org: org],
call: {GitHub.Migrations, :list_for_org},
url: "/orgs/#{org}/migrations",
method: :get,
query: query,
response: [{200, [{GitHub.Migration, :t}]}],
opts: opts
})
end
@doc """
List repositories for a user migration
Lists all the repositories for this user migration.
## Options
* `per_page`: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
* `page`: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration)
"""
@spec list_repos_for_authenticated_user(integer, keyword) ::
{:ok, [GitHub.Repository.minimal()]} | {:error, GitHub.Error.t()}
def list_repos_for_authenticated_user(migration_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [migration_id: migration_id],
call: {GitHub.Migrations, :list_repos_for_authenticated_user},
url: "/user/migrations/#{migration_id}/repositories",
method: :get,
query: query,
response: [{200, [{GitHub.Repository, :minimal}]}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
List repositories in an organization migration
List all the repositories for this organization migration.
## Options
* `per_page`: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
* `page`: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration)
"""
@spec list_repos_for_org(String.t(), integer, keyword) ::
{:ok, [GitHub.Repository.minimal()]} | {:error, GitHub.Error.t()}
def list_repos_for_org(org, migration_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org, migration_id: migration_id],
call: {GitHub.Migrations, :list_repos_for_org},
url: "/orgs/#{org}/migrations/#{migration_id}/repositories",
method: :get,
query: query,
response: [{200, [{GitHub.Repository, :minimal}]}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Map a commit author
Update an author's identity for the import. Your application can continue updating authors any time before you push
new commits to the repository.
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author)
"""
@spec map_commit_author(String.t(), String.t(), integer, map, keyword) ::
{:ok, GitHub.PorterAuthor.t()} | {:error, GitHub.Error.t()}
def map_commit_author(owner, repo, author_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, author_id: author_id, body: body],
call: {GitHub.Migrations, :map_commit_author},
url: "/repos/#{owner}/#{repo}/import/authors/#{author_id}",
body: body,
method: :patch,
request: [{"application/json", :map}],
response: [
{200, {GitHub.PorterAuthor, :t}},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :t}},
{503, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Update Git LFS preference
You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
is powered by [Git LFS](https://git-lfs.com).
You can learn more about our LFS feature and working with large files [on our help
site](https://docs.github.com/repositories/working-with-files/managing-large-files).
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference)
"""
@spec set_lfs_preference(String.t(), String.t(), map, keyword) ::
{:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
def set_lfs_preference(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Migrations, :set_lfs_preference},
url: "/repos/#{owner}/#{repo}/import/lfs",
body: body,
method: :patch,
request: [{"application/json", :map}],
response: [
{200, {GitHub.Import, :t}},
{422, {GitHub.ValidationError, :t}},
{503, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Start a user migration
Initiates the generation of a user migration archive.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#start-a-user-migration)
"""
@spec start_for_authenticated_user(map, keyword) ::
{:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
def start_for_authenticated_user(body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [body: body],
call: {GitHub.Migrations, :start_for_authenticated_user},
url: "/user/migrations",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [
{201, {GitHub.Migration, :t}},
{304, :null},
{401, {GitHub.BasicError, :t}},
{403, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :t}}
],
opts: opts
})
end
@doc """
Start an organization migration
Initiates the generation of a migration archive.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#start-an-organization-migration)
"""
@spec start_for_org(String.t(), map, keyword) ::
{:ok, GitHub.Migration.t()} | {:error, GitHub.Error.t()}
def start_for_org(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Migrations, :start_for_org},
url: "/orgs/#{org}/migrations",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [
{201, {GitHub.Migration, :t}},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :t}}
],
opts: opts
})
end
@doc """
Start an import
Start a source import to a GitHub repository using GitHub Importer.
Importing into a GitHub repository with GitHub Actions enabled is not supported and will
return a status `422 Unprocessable Entity` response.
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#start-an-import)
"""
@spec start_import(String.t(), String.t(), map, keyword) ::
{:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
def start_import(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Migrations, :start_import},
url: "/repos/#{owner}/#{repo}/import",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [
{201, {GitHub.Import, :t}},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :t}},
{503, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Unlock a user repository
Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/users#unlock-a-user-repository)
"""
@spec unlock_repo_for_authenticated_user(integer, String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def unlock_repo_for_authenticated_user(migration_id, repo_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [migration_id: migration_id, repo_name: repo_name],
call: {GitHub.Migrations, :unlock_repo_for_authenticated_user},
url: "/user/migrations/#{migration_id}/repos/#{repo_name}/lock",
method: :delete,
response: [
{204, :null},
{304, :null},
{401, {GitHub.BasicError, :t}},
{403, {GitHub.BasicError, :t}},
{404, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Unlock an organization repository
Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository)
"""
@spec unlock_repo_for_org(String.t(), integer, String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def unlock_repo_for_org(org, migration_id, repo_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, migration_id: migration_id, repo_name: repo_name],
call: {GitHub.Migrations, :unlock_repo_for_org},
url: "/orgs/#{org}/migrations/#{migration_id}/repos/#{repo_name}/lock",
method: :delete,
response: [{204, :null}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Update an import
An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
request. If no parameters are provided, the import will be restarted.
Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
You can select the project to import by providing one of the objects in the `project_choices` array in the update request.
**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
## Resources
* [API method documentation](https://docs.github.com/rest/migrations/source-imports#update-an-import)
"""
@spec update_import(String.t(), String.t(), map | nil, keyword) ::
{:ok, GitHub.Import.t()} | {:error, GitHub.Error.t()}
def update_import(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Migrations, :update_import},
url: "/repos/#{owner}/#{repo}/import",
body: body,
method: :patch,
request: [{"application/json", {:union, [:map, :null]}}],
response: [{200, {GitHub.Import, :t}}, {503, {GitHub.BasicError, :t}}],
opts: opts
})
end
end
