移行カテゴリの GraphQL スキーマの種類に関するリファレンス ドキュメント。

この記事で

Mutations

abortQueuedMigrations

Mutation

Clear all of a customer's queued migrations.

abortQueuedMigrations の入力フィールド

abortQueuedMigrations の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

abortRepositoryMigration

Mutation

Abort a repository migration queued or in progress.

abortRepositoryMigration の入力フィールド

abortRepositoryMigration の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

createAttributionInvitation

Mutation

Invites a user to claim reattributable data.

createAttributionInvitation の入力フィールド

createAttributionInvitation の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (Organization)

The owner scoping the reattributable data.

source (Claimable)

The account owning the data to reattribute.

target (Claimable)

The account which may claim the data.

createMigrationSource

Mutation

Creates a GitHub Enterprise Importer (GEI) migration source.

createMigrationSource の入力フィールド

createMigrationSource の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationSource (MigrationSource)

The created migration source.

grantMigratorRole

Mutation

Grant the migrator role to a user or a team.

grantMigratorRole の入力フィールド

grantMigratorRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

importProject

Mutation

Creates a new project by importing columns and a list of issues/PRs.

警告

importProject is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

importProject の入力フィールド

importProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.

revokeMigratorRole

Mutation

Revoke the migrator role from a user or a team.

revokeMigratorRole の入力フィールド

revokeMigratorRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

startOrganizationMigration

Mutation

Starts a GitHub Enterprise Importer organization migration.

startOrganizationMigration の入力フィールド

startOrganizationMigration の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

orgMigration (OrganizationMigration)

The new organization migration.

startRepositoryMigration

Mutation

Starts a GitHub Enterprise Importer (GEI) repository migration.

startRepositoryMigration の入力フィールド

startRepositoryMigration の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryMigration (RepositoryMigration)

The new repository migration.

Objects

Mannequin

Object

A placeholder user for attribution of imported data on GitHub.

Mannequin 実装

Mannequin のフィールド

名前説明

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

avatarUrl の引数

  • size (Int)

    The size of the resulting square image.

claimant (User)

The user that has claimed the data attributed to this mannequin.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

email (String)

The mannequin's email on the source instance.

id (ID!)

The Node ID of the Mannequin object.

login (String!)

The username of the actor.

name (String)

The display name of the imported mannequin.

resourcePath (URI!)

The HTML path to this resource.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The URL to this resource.

MannequinConnection

Object

A list of mannequins.

MannequinConnection のフィールド

名前説明

edges ([MannequinEdge])

A list of edges.

nodes ([Mannequin])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

MannequinEdge

Object

Represents a mannequin.

MannequinEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (Mannequin)

The item at the end of the edge.

MigrationSource

Object

A GitHub Enterprise Importer (GEI) migration source.

MigrationSource 実装

MigrationSource のフィールド

名前説明

id (ID!)

The Node ID of the MigrationSource object.

name (String!)

The migration source name.

type (MigrationSourceType!)

The migration source type.

url (URI!)

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

OrganizationMigration

Object

A GitHub Enterprise Importer (GEI) organization migration.

OrganizationMigration 実装

OrganizationMigration のフィールド

名前説明

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (String)

Identifies the primary key from the database.

failureReason (String)

The reason the organization migration failed.

id (ID!)

The Node ID of the OrganizationMigration object.

remainingRepositoriesCount (Int)

The remaining amount of repos to be migrated.

sourceOrgName (String!)

The name of the source organization to be migrated.

sourceOrgUrl (URI!)

The URL of the source organization to migrate.

state (OrganizationMigrationState!)

The migration state.

targetOrgName (String!)

The name of the target organization.

totalRepositoriesCount (Int)

The total amount of repositories to be migrated.

RepositoryMigration

Object

A GitHub Enterprise Importer (GEI) repository migration.

RepositoryMigration 実装

RepositoryMigration のフィールド

名前説明

continueOnError (Boolean!)

The migration flag to continue on error.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (String)

Identifies the primary key from the database.

failureReason (String)

The reason the migration failed.

id (ID!)

The Node ID of the RepositoryMigration object.

migrationLogUrl (URI)

The URL for the migration log (expires 1 day after migration completes).

migrationSource (MigrationSource!)

The migration source.

repositoryName (String!)

The target repository name.

sourceUrl (URI!)

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

state (MigrationState!)

The migration state.

warningsCount (Int!)

The number of warnings encountered for this migration. To review the warnings, check the Migration Log.

RepositoryMigrationConnection

Object

A list of migrations.

RepositoryMigrationConnection のフィールド

名前説明

edges ([RepositoryMigrationEdge])

A list of edges.

nodes ([RepositoryMigration])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

RepositoryMigrationEdge

Object

Represents a repository migration.

RepositoryMigrationEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (RepositoryMigration)

The item at the end of the edge.

Interfaces

Migration

Interface

Represents a GitHub Enterprise Importer (GEI) migration.

Migration は次で実装されています

Migration のフィールド

名前説明

continueOnError (Boolean!)

The migration flag to continue on error.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (String)

Identifies the primary key from the database.

failureReason (String)

The reason the migration failed.

id (ID!)

The Node ID of the Migration object.

migrationLogUrl (URI)

The URL for the migration log (expires 1 day after migration completes).

migrationSource (MigrationSource!)

The migration source.

repositoryName (String!)

The target repository name.

sourceUrl (URI!)

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

state (MigrationState!)

The migration state.

warningsCount (Int!)

The number of warnings encountered for this migration. To review the warnings, check the Migration Log.

Enums

MannequinOrderField

Enum

Properties by which mannequins can be ordered.

MannequinOrderField の値です。

名前説明
CREATED_AT

Order mannequins why when they were created.

LOGIN

Order mannequins alphabetically by their source login.

MigrationSourceType

Enum

Represents the different GitHub Enterprise Importer (GEI) migration sources.

MigrationSourceType の値です。

名前説明
AZURE_DEVOPS

An Azure DevOps migration source.

BITBUCKET_SERVER

A Bitbucket Server migration source.

GITHUB_ARCHIVE

A GitHub Migration API source.

MigrationState

Enum

The GitHub Enterprise Importer (GEI) migration state.

MigrationState の値です。

名前説明
FAILED

The migration has failed.

FAILED_VALIDATION

The migration has invalid credentials.

IN_PROGRESS

The migration is in progress.

NOT_STARTED

The migration has not started.

PENDING_VALIDATION

The migration needs to have its credentials validated.

QUEUED

The migration has been queued.

SUCCEEDED

The migration has succeeded.

OrganizationMigrationState

Enum

The Octoshift Organization migration state.

OrganizationMigrationState の値です。

名前説明
FAILED

The Octoshift migration has failed.

FAILED_VALIDATION

The Octoshift migration has invalid credentials.

IN_PROGRESS

The Octoshift migration is in progress.

NOT_STARTED

The Octoshift migration has not started.

PENDING_VALIDATION

The Octoshift migration needs to have its credentials validated.

POST_REPO_MIGRATION

The Octoshift migration is performing post repository migrations.

PRE_REPO_MIGRATION

The Octoshift migration is performing pre repository migrations.

QUEUED

The Octoshift migration has been queued.

REPO_MIGRATION

The Octoshift org migration is performing repository migrations.

SUCCEEDED

The Octoshift migration has succeeded.

RepositoryMigrationOrderDirection

Enum

Possible directions in which to order a list of repository migrations when provided an orderBy argument.

RepositoryMigrationOrderDirection の値です。

名前説明
ASC

Specifies an ascending order for a given orderBy argument.

DESC

Specifies a descending order for a given orderBy argument.

RepositoryMigrationOrderField

Enum

Properties by which repository migrations can be ordered.

RepositoryMigrationOrderField の値です。

名前説明
CREATED_AT

Order mannequins why when they were created.

Input objects

AbortQueuedMigrationsInput

Input object

Autogenerated input type of AbortQueuedMigrations.

AbortQueuedMigrationsInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the organization that is running the migrations.

AbortRepositoryMigrationInput

Input object

Autogenerated input type of AbortRepositoryMigration.

AbortRepositoryMigrationInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationId (ID!)

The ID of the migration to be aborted.

CreateAttributionInvitationInput

Input object

Autogenerated input type of CreateAttributionInvitation.

CreateAttributionInvitationInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The Node ID of the owner scoping the reattributable data.

sourceId (ID!)

The Node ID of the account owning the data to reattribute.

targetId (ID!)

The Node ID of the account which may claim the data.

CreateMigrationSourceInput

Input object

Autogenerated input type of CreateMigrationSource.

CreateMigrationSourceInput の入力フィールド

名前説明

accessToken (String)

The migration source access token.

clientMutationId (String)

A unique identifier for the client performing the mutation.

githubPat (String)

The GitHub personal access token of the user importing to the target repository.

name (String!)

The migration source name.

ownerId (ID!)

The ID of the organization that will own the migration source.

type (MigrationSourceType!)

The migration source type.

url (String)

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

GrantMigratorRoleInput

Input object

Autogenerated input type of GrantMigratorRole.

GrantMigratorRoleInput の入力フィールド

名前説明

actor (String!)

The user login or Team slug to grant the migrator role.

actorType (ActorType!)

Specifies the type of the actor, can be either USER or TEAM.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization that the user/team belongs to.

ImportProjectInput

Input object

Autogenerated input type of ImportProject.

ImportProjectInput の入力フィールド

名前説明

body (String)

The description of Project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

name (String!)

The name of Project.

ownerName (String!)

The name of the Organization or User to create the Project under.

public (Boolean)

Whether the Project is public or not.

MannequinOrder

Input object

Ordering options for mannequins.

MannequinOrder の入力フィールド

名前説明

direction (OrderDirection!)

The ordering direction.

field (MannequinOrderField!)

The field to order mannequins by.

RepositoryMigrationOrder

Input object

Ordering options for repository migrations.

RepositoryMigrationOrder の入力フィールド

名前説明

direction (RepositoryMigrationOrderDirection!)

The ordering direction.

field (RepositoryMigrationOrderField!)

The field to order repository migrations by.

RevokeMigratorRoleInput

Input object

Autogenerated input type of RevokeMigratorRole.

RevokeMigratorRoleInput の入力フィールド

名前説明

actor (String!)

The user login or Team slug to revoke the migrator role from.

actorType (ActorType!)

Specifies the type of the actor, can be either USER or TEAM.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization that the user/team belongs to.

StartOrganizationMigrationInput

Input object

Autogenerated input type of StartOrganizationMigration.

StartOrganizationMigrationInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

sourceAccessToken (String!)

The migration source access token.

sourceOrgUrl (URI!)

The URL of the organization to migrate.

targetEnterpriseId (ID!)

The ID of the enterprise the target organization belongs to.

targetOrgName (String!)

The name of the target organization.

StartRepositoryMigrationInput

Input object

Autogenerated input type of StartRepositoryMigration.

StartRepositoryMigrationInput の入力フィールド

名前説明

accessToken (String)

The migration source access token.

clientMutationId (String)

A unique identifier for the client performing the mutation.

continueOnError (Boolean)

Whether to continue the migration on error. Defaults to true.

gitArchiveUrl (String)

The signed URL to access the user-uploaded git archive.

githubPat (String)

The GitHub personal access token of the user importing to the target repository.

lockSource (Boolean)

Whether to lock the source repository.

metadataArchiveUrl (String)

The signed URL to access the user-uploaded metadata archive.

ownerId (ID!)

The ID of the organization that will own the imported repository.

repositoryName (String!)

The name of the imported repository.

skipReleases (Boolean)

Whether to skip migrating releases for the repository.

sourceId (ID!)

The ID of the migration source.

sourceRepositoryUrl (URI!)

The URL of the source repository.

targetRepoVisibility (String)

The visibility of the imported repository.