diff --git a/.github/workflows/close-on-invalid-label.yaml b/.github/workflows/close-on-invalid-label.yaml index 9d79f5d3bb..1d3335dd75 100644 --- a/.github/workflows/close-on-invalid-label.yaml +++ b/.github/workflows/close-on-invalid-label.yaml @@ -3,7 +3,7 @@ name: Close issue/PR on adding invalid label on: issues: types: [labeled] - pull_request: + pull_request_target: types: [labeled] permissions: diff --git a/.github/workflows/staging-deploy-pr.yml b/.github/workflows/staging-deploy-pr.yml index 704f8874d0..6e02c306dd 100644 --- a/.github/workflows/staging-deploy-pr.yml +++ b/.github/workflows/staging-deploy-pr.yml @@ -276,13 +276,35 @@ jobs: } - name: Mark the deployment as inactive if timed out - if: ${{ steps.deploy.outcome == 'cancelled' }} uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d + if: ${{ steps.deploy.outcome == 'cancelled' }} + env: + DEPLOYMENT_ID: ${{ steps.deploy.outputs.deploymentId }} + LOG_URL: ${{ steps.deploy.outputs.logUrl }} with: script: | - // TODO: Find the relevant deployment - // TODO: Create a new deployment status for it as "inactive" - return 'TODO' + const { DEPLOYMENT_ID, LOG_URL } = process.env + const { owner, repo } = context.repo + + if (!DEPLOYMENT_ID) { + throw new Error('A deployment wasn't created before a timeout occurred!') + } + + await github.repos.createDeploymentStatus({ + owner, + repo, + deployment_id: DEPLOYMENT_ID, + state: 'error', + description: 'The deployment step timed out. See workflow logs.', + log_url: LOG_URL, + // The 'ant-man' preview is required for `state` values of 'inactive', as well as + // the use of the `log_url`, `environment_url`, and `auto_inactive` parameters. + // The 'flash' preview is required for `state` values of 'in_progress' and 'queued'. + mediaType: { + previews: ['ant-man', 'flash'], + }, + }) + console.log('⏲️ Deployment status: error - The deployment timed out...') - name: Create failure status uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index 86086d0b5b..268f04faeb 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -74,6 +74,12 @@ For more information, see "[Configuring backups on your appliance](/enterprise/{ {% data variables.product.prodname_ghe_server %} runs a customized Linux operating system with only the necessary applications and services. {% data variables.product.prodname_dotcom %} manages patching of the appliance's core operating system as part of its standard product release cycle. Patches address functionality, stability, and non-critical security issues for {% data variables.product.prodname_dotcom %} applications. {% data variables.product.prodname_dotcom %} also provides critical security patches as needed outside of the regular release cycle. +{% data variables.product.prodname_ghe_server %} is provided as an appliance, and many of the operating system packages are modified compared to the usual Debian distribution. We do not support modifying the underlying operating system for this reason (including operating system upgrades), which is aligned with the [{% data variables.product.prodname_ghe_server %} license and support agreement](https://enterprise.github.com/license), under section 11.3 Exclusions. + +Currently, the base of the {% data variables.product.prodname_ghe_server %} appliance is Debian 9 (Stretch) and receives support under the Debian Long Term Support program. There are plans to move to a newer base operating system before the end of the Debian LTS period for Stretch. + +Regular patch updates are released on the {% data variables.product.prodname_ghe_server %} [releases](https://enterprise.github.com/releases) page, and the [release notes](/enterprise-server/admin/release-notes) page provides more information. These patches typically contain upstream vendor and project security patches after they've been tested and quality approved by our engineering team. There can be a slight time delay from when the upstream update is released to when it's tested and bundled in an upcoming {% data variables.product.prodname_ghe_server %} patch release. + ### Network security {% data variables.product.prodname_ghe_server %}'s internal firewall restricts network access to the appliance's services. Only services necessary for the appliance to function are available over the network. For more information, see "[Network ports](/enterprise/{{ currentVersion }}/admin/guides/installation/network-ports)." diff --git a/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index 55164f2b33..e4e9939b8e 100644 --- a/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -298,7 +298,8 @@ To build this link, you'll need your OAuth Apps `client_id` that you received fr * "[Troubleshooting authorization request errors](/apps/managing-oauth-apps/troubleshooting-authorization-request-errors)" * "[Troubleshooting OAuth App access token request errors](/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors)" -* "[Device flow errors](#errors-for-the-device-flow)" +{% ifversion fpt or ghae or ghes > 3.0 %}* "[Device flow errors](#error-codes-for-the-device-flow)"{% endif %} +* "[Token expiration and revocation](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation)" ## Further reading diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token.md index 9049313022..72c71f4eb7 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token.md @@ -77,3 +77,4 @@ Instead of manually entering your PAT for every HTTPS Git operation, you can cac ## Further reading - "[About authentication to GitHub](/github/authenticating-to-github/about-authentication-to-github)" +- "[Token expiration and revocation](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation)" diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/index.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/index.md index aa75edef20..9de4bcc41d 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/index.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/index.md @@ -22,6 +22,7 @@ children: - /reviewing-your-authorized-integrations - /connecting-with-third-party-applications - /reviewing-your-authorized-applications-oauth + - /token-expiration-and-revocation - /reviewing-your-security-log - /removing-sensitive-data-from-a-repository - /about-anonymized-urls diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md index 5510ce7c18..0f6146a4bd 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -118,12 +118,12 @@ An overview of some of the most common actions that are recorded as events in th {% endif %} -### `oauth_access` category actions +### `oauth_authorization` category actions | Action | Description |------------------|------------------- | `create` | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps). -| `destroy` | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations). +| `destroy` | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations) and when [authorizations are revoked or expire](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation). {% ifversion fpt %} diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation.md new file mode 100644 index 0000000000..7351e1f3e7 --- /dev/null +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation.md @@ -0,0 +1,62 @@ +--- +title: Token expiration and revocation +intro: Your tokens can expire and can also be revoked by you, applications you have authorized, and {% data variables.product.product_name %} itself. +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Identity + - Access management +shortTitle: Token expiration +--- + +When a token has expired or has been revoked, it can no longer be used to authenticate Git and API requests. It is not possible to restore an expired or revoked token, you or the application will need to create a new token. + +This article explains the possible reasons your {% data variables.product.product_name %} token might be revoked or expire. + +{% note %} + +**Note:** When a personal access token or OAuth token expires or is revoked, you may see an `oauth_authorization.destroy` action in your security log. For more information, see "[Reviewing your security log](/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log)." + +{% endnote %} + +{% ifversion fpt or ghae-issue-4374 or ghes > 3.1 %} +## Token revoked after reaching its expiration date + +When you create a personal access token, we recommend that you set an expiration for your token. Upon reaching your token's expiration date, the token is automatically revoked. For more information, see "[Creating a personal access token](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +{% endif %} + +{% ifversion fpt %} +## Token revoked when pushed to a public repository or public gist + +If a valid OAuth token, {% data variables.product.prodname_github_app %} token, or personal access token is pushed to a public repository or public gist, the token will be automatically revoked. + +OAuth tokens and personal access tokens pushed to public repositories and public gists will only be revoked if the token has scopes. +{% endif %} + +{% ifversion fpt %} +## Token expired due to lack of use + +{% data variables.product.product_name %} will automatically revoke an OAuth token or personal access token when the token hasn't been used in one year. +{% endif %} + +## Token revoked by the user + +You can revoke your authorization of a {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} from your account settings which will revoke any tokens associated with the app. For more information, see "[Reviewing your authorized integrations](/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-authorized-integrations)" and "[Reviewing your authorized applications (OAuth)](/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-authorized-applications-oauth)." + +Once an authorization is revoked, any tokens associated with the authorization will be revoked as well. To re-authorize an application, follow the instructions from the third-party application or website to connect your {% data variables.product.product_name %} account again. + +## Token revoked by the {% data variables.product.prodname_oauth_app %} + +The owner of an {% data variables.product.prodname_oauth_app %} can revoke an account's authorization of their app, this will also revoke any tokens associated with the authorization. For more information about revoking authorizations of your OAuth app, see "[Delete an app authorization](/rest/reference/apps#delete-an-app-authorization)." + +## Token revoked due to excess of tokens for an {% data variables.product.prodname_oauth_app %} with the same scope + +{% data reusables.apps.oauth-token-limit %} + +{% ifversion fpt or ghae or ghes > 3.1 %} +## User token revoked due to {% data variables.product.prodname_github_app %} configuration + +User-to-server tokens created by a {% data variables.product.prodname_github_app %} will expire after eight hours by default. Owners of {% data variables.product.prodname_github_apps %} can configure their apps so that user-to-server tokens do not expire. For more information about changing how your {% data variables.product.prodname_dotcom %} App's user-to-server tokens behave, see "[Activating optional features for apps](/developers/apps/getting-started-with-apps/activating-optional-features-for-apps)." +{% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md index 54f18b56a0..2199a6bc0b 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md @@ -1,6 +1,6 @@ --- title: Duplicating a repository -intro: 'To duplicate a repository without forking it, you can run a special clone command, then mirror-push to the new repository.' +intro: 'To maintain a mirror of a repository without forking it, you can run a special clone command, then mirror-push to the new repository.' redirect_from: - /articles/duplicating-a-repo/ - /articles/duplicating-a-repository @@ -12,7 +12,7 @@ versions: topics: - Repositories --- -Before you can duplicate a repository and push to your new copy, or _mirror_, of the repository, you must [create the new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. In these examples, `exampleuser/new-repository` or `exampleuser/mirrored` are the mirrors. +Before you can push the original repository to your new copy, or _mirror_, of the repository, you must [create the new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. In these examples, `exampleuser/new-repository` or `exampleuser/mirrored` are the mirrors. ## Mirroring a repository diff --git a/content/github/site-policy/github-community-forum-code-of-conduct.md b/content/github/site-policy/github-community-forum-code-of-conduct.md index 36e074d4ee..cc468cc703 100644 --- a/content/github/site-policy/github-community-forum-code-of-conduct.md +++ b/content/github/site-policy/github-community-forum-code-of-conduct.md @@ -117,7 +117,7 @@ Community Forum moderators who do not follow or enforce the Code of Conduct in g ## Contacting GitHub Staff -If, for any reason, you want to contact GitHub Staff, the Community Managers, Administrators, or Moderators of this forum privately, you can use our [Support contact form](https://support.github.com/contact?tags=community-support). Contacting any member of GitHub Staff via unsolicited mentions or pings, or via channels other than the forum itself, or the Support contact form is strongly discouraged and may be considered a violation of our prohibition against harassment. +If, for any reason, you want to contact GitHub Staff, the Community Managers, Administrators, or Moderators of this forum privately, you can use our [Support contact form](https://support.github.com/contact?tags=docs-community-support). Contacting any member of GitHub Staff via unsolicited mentions or pings, or via channels other than the forum itself, or the Support contact form is strongly discouraged and may be considered a violation of our prohibition against harassment. Let's work together to keep the forum a place where people feel safe to participate by being respectful of them and their time. diff --git a/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 2a157d36bc..fb73845730 100644 --- a/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -271,6 +271,14 @@ You can tell {% data variables.product.product_name %} to ignore (or escape) Mar For more information, see Daring Fireball's "[Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash)." +## Hiding content with comments + +You can tell {% data variables.product.product_name %} to hide content from the rendered Markdown by placing the content in an HTML comment. + +
+<!-- This content will not appear in the rendered Markdown -->
+
+ ## Further reading - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md index 91b7b377a7..3898705968 100644 --- a/content/rest/overview/troubleshooting.md +++ b/content/rest/overview/troubleshooting.md @@ -23,7 +23,7 @@ You might expect to see a `403 Forbidden` in these cases. However, since we don' want to provide _any_ information about private repositories, the API returns a `404` error instead. -To troubleshoot, ensure [you're authenticating correctly](/guides/getting-started/), [your OAuth access token has the required scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), and [third-party application restrictions][oap-guide] are not blocking access. +To troubleshoot, ensure [you're authenticating correctly](/guides/getting-started/), [your OAuth access token has the required scopes](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), [third-party application restrictions][oap-guide] are not blocking access, and that [the token has not expired or been revoked](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation). ## Not all results returned diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index e21f059e9a..3dde655576 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -1254,6 +1254,11 @@ type AutomaticBaseChangeSucceededEvent implements Node { pullRequest: PullRequest! } +""" +A (potentially binary) string encoded using base64. +""" +scalar Base64String + """ Represents a 'base_ref_changed' event on a given issue or pull request. """ @@ -4241,6 +4246,48 @@ type CommitHistoryConnection { totalCount: Int! } +""" +A message to include with a new commit +""" +input CommitMessage { + """ + The body of the message. + """ + body: String + + """ + The headline of the message. + """ + headline: String! +} + +""" +A git ref for a commit to be appended to. + +The ref must be a branch, i.e. its fully qualified name must start +with `refs/heads/` (although the input is not required to be fully +qualified). + +The Ref may be specified by its global node ID or by the +repository nameWithOwner and branch name. +""" +input CommittableBranch { + """ + The unqualified name of the branch to append the commit to. + """ + branchName: String + + """ + The Node ID of the Ref to be updated. + """ + id: ID + + """ + The nameWithOwner of the repository to commit to. + """ + repositoryNameWithOwner: String +} + """ Represents a 'connected' event on a given issue or pull request. """ @@ -5288,6 +5335,56 @@ type CreateCheckSuitePayload { clientMutationId: String } +""" +Autogenerated input type of CreateCommitOnBranch +""" +input CreateCommitOnBranchInput { + """ + The Ref to be updated. Must be a branch. + """ + branch: CommittableBranch! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The git commit oid expected at the head of the branch prior to the commit + """ + expectedHeadOid: GitObjectID! + + """ + A description of changes to files in this commit. + """ + fileChanges: FileChanges + + """ + The commit message the be included with the commit. + """ + message: CommitMessage! +} + +""" +Autogenerated return type of CreateCommitOnBranch +""" +type CreateCommitOnBranchPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The new commit. + """ + commit: Commit + + """ + The ref which has been updated to point to the new commit. + """ + ref: Ref +} + """ Autogenerated input type of CreateContentAttachment """ @@ -11629,6 +11726,159 @@ type ExternalIdentityScimAttributes { username: String } +""" +A command to add a file at the given path with the given contents as part of a +commit. Any existing file at that that path will be replaced. +""" +input FileAddition { + """ + The base64 encoded contents of the file + """ + contents: Base64String! + + """ + The path in the repository where the file will be located + """ + path: String! +} + +""" +A description of a set of changes to a file tree to be made as part of +a git commit, modeled as zero or more file `additions` and zero or more +file `deletions`. + +Both fields are optional; omitting both will produce a commit with no +file changes. + +`deletions` and `additions` describe changes to files identified +by their path in the git tree using unix-style path separators, i.e. +`/`. The root of a git tree is an empty string, so paths are not +slash-prefixed. + +`path` values must be unique across all `additions` and `deletions` +provided. Any duplication will result in a validation error. + +## Encoding + +File contents must be provided in full for each `FileAddition`. + +The `contents` of a `FileAddition` must be encoded using RFC 4648 +compliant base64, i.e. correct padding is required and no characters +outside the standard alphabet may be used. Invalid base64 +encoding will be rejected with a validation error. + +The encoded contents may be binary. + +For text files, no assumptions are made about the character encoding of +the file contents (after base64 decoding). No charset transcoding or +line-ending normalization will be performed; it is the client's +responsibility to manage the character encoding of files they provide. +However, for maximum compatibility we recommend using UTF-8 encoding +and ensuring that all files in a repository use a consistent +line-ending convention (`\n` or `\r\n`), and that all files end +with a newline. + +## Modeling file changes + +Each of the the five types of conceptual changes that can be made in a +git commit can be described using the `FileChanges` type as follows: + +1. New file addition: create file `hello world\n` at path `docs/README.txt`: + + { + "additions" [ + { + "path": "docs/README.txt", + "contents": base64encode("hello world\n") + } + ] + } + +2. Existing file modification: change existing `docs/README.txt` to have new + content `new content here\n`: + + { + "additions" [ + { + "path": "docs/README.txt", + "contents": base64encode("new content here\n") + } + ] + } + +3. Existing file deletion: remove existing file `docs/README.txt`. + Note that the path is required to exist -- specifying a + path that does not exist on the given branch will abort the + commit and return an error. + + { + "deletions" [ + { + "path": "docs/README.txt" + } + ] + } + + +4. File rename with no changes: rename `docs/README.txt` with + previous content `hello world\n` to the same content at + `newdocs/README.txt`: + + { + "deletions" [ + { + "path": "docs/README.txt", + } + ], + "additions" [ + { + "path": "newdocs/README.txt", + "contents": base64encode("hello world\n") + } + ] + } + + +5. File rename with changes: rename `docs/README.txt` with + previous content `hello world\n` to a file at path + `newdocs/README.txt` with content `new contents\n`: + + { + "deletions" [ + { + "path": "docs/README.txt", + } + ], + "additions" [ + { + "path": "newdocs/README.txt", + "contents": base64encode("new contents\n") + } + ] + } +""" +input FileChanges { + """ + File to add or change. + """ + additions: [FileAddition!] = [] + + """ + Files to delete. + """ + deletions: [FileDeletion!] = [] +} + +""" +A command to delete the file at the given path as part of a commit. +""" +input FileDeletion { + """ + The path to delete + """ + path: String! +} + """ The possible viewed states of a file . """ @@ -16280,6 +16530,57 @@ type Mutation { input: CreateCheckSuiteInput! ): CreateCheckSuitePayload + """ + Appends a commit to the given branch as the authenticated user. + + This mutation creates a commit whose parent is the HEAD of the provided + branch and also updates that branch to point to the new commit. + It can be thought of as similar to `git commit`. + + ## Locating a Branch + + Commits are appended to a `branch` of type `Ref`. + This must refer to a git branch (i.e. the fully qualified path must + begin with `refs/heads/`, although including this prefix is optional. + + Callers may specify the `branch` to commit to either by its global node + ID or by passing both of `repositoryNameWithOwner` and `refName`. For + more details see the documentation for `CommittableBranch`. + + ## Describing Changes + + `fileChanges` are specified as a `FilesChanges` object describing + `FileAdditions` and `FileDeletions`. + + Please see the documentation for `FileChanges` for more information on + how to use this argument to describe any set of file changes. + + ## Authorship + + Similar to the web commit interface, this mutation does not support + specifying the author or committer of the commit and will not add + support for this in the future. + + A commit created by a successful execution of this mutation will be + authored by the owner of the credential which authenticates the API + request. The committer will be identical to that of commits authored + using the web interface. + + If you need full control over author and committer information, please + use the Git Database REST API instead. + + ## Commit Signing + + Commits made using this mutation are automatically signed by GitHub if + supported and will be marked as verified in the user interface. + """ + createCommitOnBranch( + """ + Parameters for CreateCommitOnBranch + """ + input: CreateCommitOnBranchInput! + ): CreateCommitOnBranchPayload + """ Create a content attachment. """ diff --git a/data/graphql/ghes-3.2/graphql_previews.enterprise.yml b/data/graphql/ghes-3.2/graphql_previews.enterprise.yml index 7d84d7d5da..20e92be9aa 100644 --- a/data/graphql/ghes-3.2/graphql_previews.enterprise.yml +++ b/data/graphql/ghes-3.2/graphql_previews.enterprise.yml @@ -25,7 +25,7 @@ - CreateDeploymentInput - CreateDeploymentPayload owning_teams: - - '@github/ecosystem-api' + - '@github/c2c-actions-service' - title: >- MergeInfoPreview - More detailed information about a pull request's merge state. diff --git a/data/graphql/ghes-3.2/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-3.2/graphql_upcoming_changes.public-enterprise.yml index 99f60361db..79aa22aa5a 100644 --- a/data/graphql/ghes-3.2/graphql_upcoming_changes.public-enterprise.yml +++ b/data/graphql/ghes-3.2/graphql_upcoming_changes.public-enterprise.yml @@ -112,3 +112,17 @@ upcoming_changes: date: '2021-01-01T00:00:00+00:00' criticality: breaking owner: nplasterer + - location: PackageType.DOCKER + description: '`DOCKER` will be removed.' + reason: + DOCKER will be removed from this enum as this type will be migrated to only + be used by the Packages REST API. + date: '2021-06-21' + criticality: breaking + owner: reybard + - location: ReactionGroup.users + description: '`users` will be removed. Use the `reactors` field instead.' + reason: Reactors can now be mannequins, bots, and organizations. + date: '2021-10-01T00:00:00+00:00' + criticality: breaking + owner: synthead diff --git a/data/graphql/ghes-3.2/schema.docs-enterprise.graphql b/data/graphql/ghes-3.2/schema.docs-enterprise.graphql index 1d550d2840..1033e02ad9 100644 --- a/data/graphql/ghes-3.2/schema.docs-enterprise.graphql +++ b/data/graphql/ghes-3.2/schema.docs-enterprise.graphql @@ -163,6 +163,46 @@ type AddCommentPayload { timelineEdge: IssueTimelineItemEdge } +""" +Autogenerated input type of AddDiscussionComment +""" +input AddDiscussionCommentInput { + """ + The contents of the comment. + """ + body: String! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion to comment on. + """ + discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"]) + + """ + The Node ID of the discussion comment within this discussion to reply to. + """ + replyToId: ID @possibleTypes(concreteTypes: ["DiscussionComment"]) +} + +""" +Autogenerated return type of AddDiscussionComment +""" +type AddDiscussionCommentPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The newly created discussion comment. + """ + comment: DiscussionComment +} + """ Autogenerated input type of AddEnterpriseAdmin """ @@ -230,7 +270,7 @@ input AddLabelsToLabelableInput { """ The id of the labelable object to add labels to. """ - labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable") + labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable") } """ @@ -544,11 +584,14 @@ input AddReactionInput { @possibleTypes( concreteTypes: [ "CommitComment" + "Discussion" + "DiscussionComment" "Issue" "IssueComment" "PullRequest" "PullRequestReview" "PullRequestReviewComment" + "Release" "TeamDiscussion" "TeamDiscussionComment" ] @@ -606,6 +649,71 @@ type AddStarPayload { starrable: Starrable } +""" +Autogenerated input type of AddUpvote +""" +input AddUpvoteInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion or comment to upvote. + """ + subjectId: ID! @possibleTypes(concreteTypes: ["Discussion", "DiscussionComment"], abstractType: "Votable") +} + +""" +Autogenerated return type of AddUpvote +""" +type AddUpvotePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The votable subject. + """ + subject: Votable +} + +""" +Autogenerated input type of AddVerifiableDomain +""" +input AddVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The URL of the domain + """ + domain: URI! + + """ + The ID of the owner to add the domain to + """ + ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner") +} + +""" +Autogenerated return type of AddVerifiableDomain +""" +type AddVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was added. + """ + domain: VerifiableDomain +} + """ Represents a 'added_to_project' event on a given issue or pull request. """ @@ -662,6 +770,36 @@ type App implements Node { description: String id: ID! + """ + The IP addresses of the app. + """ + ipAllowListEntries( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for IP allow list entries returned. + """ + orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC} + ): IpAllowListEntryConnection! + """ The hex color code, without the leading '#', for the logo background. """ @@ -698,6 +836,76 @@ type App implements Node { url: URI! } +""" +Autogenerated input type of ApproveDeployments +""" +input ApproveDeploymentsInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Optional comment for approving deployments + """ + comment: String = "" + + """ + The ids of environments to reject deployments + """ + environmentIds: [ID!]! + + """ + The node ID of the workflow run containing the pending deployments. + """ + workflowRunId: ID! @possibleTypes(concreteTypes: ["WorkflowRun"]) +} + +""" +Autogenerated return type of ApproveDeployments +""" +type ApproveDeploymentsPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The affected deployments. + """ + deployments: [Deployment!] +} + +""" +Autogenerated input type of ApproveVerifiableDomain +""" +input ApproveVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to approve. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of ApproveVerifiableDomain +""" +type ApproveVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was approved. + """ + domain: VerifiableDomain +} + """ Autogenerated input type of ArchiveRepository """ @@ -1494,6 +1702,11 @@ type BranchProtectionRule implements Node { """ requiresCommitSignatures: Boolean! + """ + Are conversations required to be resolved before merging. + """ + requiresConversationResolution: Boolean! + """ Are merge commits prohibited from being pushed to this branch. """ @@ -2024,7 +2237,7 @@ enum CheckConclusionState { """ A check run. """ -type CheckRun implements Node & UniformResourceLocatable { +type CheckRun implements Node & RequirableByPullRequest & UniformResourceLocatable { """ The check run's annotations """ @@ -2070,6 +2283,11 @@ type CheckRun implements Node & UniformResourceLocatable { """ databaseId: Int + """ + The corresponding deployment for this job, if any + """ + deployment: Deployment + """ The URL from which to find full details of the check run on the integrator's site. """ @@ -2081,11 +2299,31 @@ type CheckRun implements Node & UniformResourceLocatable { externalId: String id: ID! + """ + Whether this is required to pass before merging for a specific pull request. + """ + isRequired( + """ + The id of the pull request this is required for + """ + pullRequestId: ID + + """ + The number of the pull request this is required for + """ + pullRequestNumber: Int + ): Boolean! + """ The name of the check for this check run. """ name: String! + """ + Information about a pending deployment, if any, in this check run + """ + pendingDeploymentRequest: DeploymentRequest + """ The permalink to the check run summary. """ @@ -2111,6 +2349,36 @@ type CheckRun implements Node & UniformResourceLocatable { """ status: CheckStatusState! + """ + The check run's steps + """ + steps( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Step number + """ + number: Int + ): CheckStepConnection + """ A string representing the check run's summary """ @@ -2296,6 +2564,11 @@ enum CheckStatusState { """ IN_PROGRESS + """ + The check suite or run is in pending state. + """ + PENDING + """ The check suite or run has been queued. """ @@ -2312,6 +2585,91 @@ enum CheckStatusState { WAITING } +""" +A single check step. +""" +type CheckStep { + """ + Identifies the date and time when the check step was completed. + """ + completedAt: DateTime + + """ + The conclusion of the check step. + """ + conclusion: CheckConclusionState + + """ + A reference for the check step on the integrator's system. + """ + externalId: String + + """ + The step's name. + """ + name: String! + + """ + The index of the step in the list of steps of the parent check run. + """ + number: Int! + + """ + Number of seconds to completion. + """ + secondsToCompletion: Int + + """ + Identifies the date and time when the check step was started. + """ + startedAt: DateTime + + """ + The current status of the check step. + """ + status: CheckStatusState! +} + +""" +The connection type for CheckStep. +""" +type CheckStepConnection { + """ + A list of edges. + """ + edges: [CheckStepEdge] + + """ + A list of nodes. + """ + nodes: [CheckStep] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type CheckStepEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: CheckStep +} + """ A check suite. """ @@ -2371,6 +2729,11 @@ type CheckSuite implements Node { """ createdAt: DateTime! + """ + The user who triggered the check suite. + """ + creator: User + """ Identifies the primary key from the database. """ @@ -2456,6 +2819,11 @@ type CheckSuite implements Node { The HTTP URL for this check suite """ url: URI! + + """ + The workflow run associated with this check suite. + """ + workflowRun: WorkflowRun } """ @@ -2540,7 +2908,7 @@ input ClearLabelsFromLabelableInput { """ The id of the labelable object to clear the labels from. """ - labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable") + labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable") } """ @@ -3063,7 +3431,9 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl additions: Int! """ - The pull requests associated with a commit + The merged Pull Request that introduced the commit to the repository. If the + commit is not present in the default branch, additionally returns open Pull + Requests associated with the commit """ associatedPullRequests( """ @@ -4655,6 +5025,36 @@ type ConvertProjectCardNoteToIssuePayload { projectCard: ProjectCard } +""" +Autogenerated input type of ConvertPullRequestToDraft +""" +input ConvertPullRequestToDraftInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + ID of the pull request to convert to draft + """ + pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) +} + +""" +Autogenerated return type of ConvertPullRequestToDraft +""" +type ConvertPullRequestToDraftPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The pull request that is now a draft. + """ + pullRequest: PullRequest +} + """ Represents a 'convert_to_draft' event on a given pull request. """ @@ -4791,6 +5191,11 @@ input CreateBranchProtectionRuleInput { """ requiresCommitSignatures: Boolean + """ + Are conversations required to be resolved before merging. + """ + requiresConversationResolution: Boolean + """ Are merge commits prohibited from being pushed to this branch. """ @@ -5127,6 +5532,51 @@ type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") { deploymentStatus: DeploymentStatus } +""" +Autogenerated input type of CreateDiscussion +""" +input CreateDiscussionInput { + """ + The body of the discussion. + """ + body: String! + + """ + The id of the discussion category to associate with this discussion. + """ + categoryId: ID! @possibleTypes(concreteTypes: ["DiscussionCategory"]) + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The id of the repository on which to create the discussion. + """ + repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) + + """ + The title of the discussion. + """ + title: String! +} + +""" +Autogenerated return type of CreateDiscussion +""" +type CreateDiscussionPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The discussion that was just created. + """ + discussion: Discussion +} + """ Autogenerated input type of CreateEnterpriseOrganization """ @@ -5182,6 +5632,41 @@ type CreateEnterpriseOrganizationPayload { organization: Organization } +""" +Autogenerated input type of CreateEnvironment +""" +input CreateEnvironmentInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The name of the environment. + """ + name: String! + + """ + The node ID of the repository. + """ + repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"]) +} + +""" +Autogenerated return type of CreateEnvironment +""" +type CreateEnvironmentPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The new or existing environment. + """ + environment: Environment +} + """ Autogenerated input type of CreateIpAllowListEntry """ @@ -5209,7 +5694,7 @@ input CreateIpAllowListEntryInput { """ The ID of the owner for which to create the new IP allow list entry. """ - ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "IpAllowListOwner") + ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner") } """ @@ -6205,6 +6690,91 @@ type DeleteDeploymentPayload { clientMutationId: String } +""" +Autogenerated input type of DeleteDiscussionComment +""" +input DeleteDiscussionCommentInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node id of the discussion comment to delete. + """ + id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) +} + +""" +Autogenerated return type of DeleteDiscussionComment +""" +type DeleteDiscussionCommentPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The discussion comment that was just deleted. + """ + comment: DiscussionComment +} + +""" +Autogenerated input type of DeleteDiscussion +""" +input DeleteDiscussionInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The id of the discussion to delete. + """ + id: ID! @possibleTypes(concreteTypes: ["Discussion"]) +} + +""" +Autogenerated return type of DeleteDiscussion +""" +type DeleteDiscussionPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The discussion that was just deleted. + """ + discussion: Discussion +} + +""" +Autogenerated input type of DeleteEnvironment +""" +input DeleteEnvironmentInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the environment to be deleted. + """ + id: ID! @possibleTypes(concreteTypes: ["Environment"]) +} + +""" +Autogenerated return type of DeleteEnvironment +""" +type DeleteEnvironmentPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String +} + """ Autogenerated input type of DeleteIpAllowListEntry """ @@ -6580,6 +7150,36 @@ type DeleteTeamDiscussionPayload { clientMutationId: String } +""" +Autogenerated input type of DeleteVerifiableDomain +""" +input DeleteVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to delete. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of DeleteVerifiableDomain +""" +type DeleteVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The owning account from which the domain was deleted. + """ + owner: VerifiableDomainOwner +} + """ Represents a 'demilestoned' event on a given issue or pull request. """ @@ -6915,6 +7515,348 @@ enum DeploymentOrderField { CREATED_AT } +""" +A protection rule. +""" +type DeploymentProtectionRule implements Node { + """ + Identifies the primary key from the database. + """ + databaseId: Int + id: ID! + + """ + The teams or users that can review the deployment + """ + reviewers( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DeploymentReviewerConnection! + + """ + The timeout in minutes for this protection rule. + """ + timeout: Int! + + """ + The type of protection rule. + """ + type: DeploymentProtectionRuleType! +} + +""" +The connection type for DeploymentProtectionRule. +""" +type DeploymentProtectionRuleConnection { + """ + A list of edges. + """ + edges: [DeploymentProtectionRuleEdge] + + """ + A list of nodes. + """ + nodes: [DeploymentProtectionRule] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DeploymentProtectionRuleEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DeploymentProtectionRule +} + +""" +The possible protection rule types. +""" +enum DeploymentProtectionRuleType { + """ + Required reviewers + """ + REQUIRED_REVIEWERS + + """ + Wait timer + """ + WAIT_TIMER +} + +""" +A request to deploy a workflow run to an environment. +""" +type DeploymentRequest { + """ + Whether or not the current user can approve the deployment + """ + currentUserCanApprove: Boolean! + + """ + The target environment of the deployment + """ + environment: Environment! + + """ + The teams or users that can review the deployment + """ + reviewers( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DeploymentReviewerConnection! + + """ + The wait timer in minutes configured in the environment + """ + waitTimer: Int! + + """ + The wait timer in minutes configured in the environment + """ + waitTimerStartedAt: DateTime +} + +""" +The connection type for DeploymentRequest. +""" +type DeploymentRequestConnection { + """ + A list of edges. + """ + edges: [DeploymentRequestEdge] + + """ + A list of nodes. + """ + nodes: [DeploymentRequest] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DeploymentRequestEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DeploymentRequest +} + +""" +A deployment review. +""" +type DeploymentReview implements Node { + """ + The comment the user left. + """ + comment: String! + + """ + Identifies the primary key from the database. + """ + databaseId: Int + + """ + The environments approved or rejected + """ + environments( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): EnvironmentConnection! + id: ID! + + """ + The decision of the user. + """ + state: DeploymentReviewState! + + """ + The user that reviewed the deployment. + """ + user: User! +} + +""" +The connection type for DeploymentReview. +""" +type DeploymentReviewConnection { + """ + A list of edges. + """ + edges: [DeploymentReviewEdge] + + """ + A list of nodes. + """ + nodes: [DeploymentReview] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DeploymentReviewEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DeploymentReview +} + +""" +The possible states for a deployment review. +""" +enum DeploymentReviewState { + """ + The deployment was approved. + """ + APPROVED + + """ + The deployment was rejected. + """ + REJECTED +} + +""" +Users and teams. +""" +union DeploymentReviewer = Team | User + +""" +The connection type for DeploymentReviewer. +""" +type DeploymentReviewerConnection { + """ + A list of edges. + """ + edges: [DeploymentReviewerEdge] + + """ + A list of nodes. + """ + nodes: [DeploymentReviewer] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DeploymentReviewerEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DeploymentReviewer +} + """ The possible states in which a deployment can be. """ @@ -7187,6 +8129,749 @@ type DisconnectedEvent implements Node { subject: ReferencedSubject! } +""" +A discussion in a repository. +""" +type Discussion implements Comment & Deletable & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & Updatable & Votable { + """ + Reason that the conversation was locked. + """ + activeLockReason: LockReason + + """ + The comment chosen as this discussion's answer, if any. + """ + answer: DiscussionComment + + """ + The time when a user chose this discussion's answer, if answered. + """ + answerChosenAt: DateTime + + """ + The user who chose this discussion's answer, if answered. + """ + answerChosenBy: Actor + + """ + The actor who authored the comment. + """ + author: Actor + + """ + Author's association with the subject of the comment. + """ + authorAssociation: CommentAuthorAssociation! + + """ + The main text of the discussion post. + """ + body: String! + + """ + The body rendered to HTML. + """ + bodyHTML: HTML! + + """ + The body rendered to text. + """ + bodyText: String! + + """ + The category for this discussion. + """ + category: DiscussionCategory! + + """ + The replies to the discussion. + """ + comments( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DiscussionCommentConnection! + + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + + """ + Check if this comment was created via an email reply. + """ + createdViaEmail: Boolean! + + """ + Identifies the primary key from the database. + """ + databaseId: Int + + """ + The actor who edited the comment. + """ + editor: Actor + id: ID! + + """ + Check if this comment was edited and includes an edit with the creation data + """ + includesCreatedEdit: Boolean! + + """ + A list of labels associated with the object. + """ + labels( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for labels returned from the connection. + """ + orderBy: LabelOrder = {field: CREATED_AT, direction: ASC} + ): LabelConnection + + """ + The moment the editor made the last edit + """ + lastEditedAt: DateTime + + """ + `true` if the object is locked + """ + locked: Boolean! + + """ + The number identifying this discussion within the repository. + """ + number: Int! + + """ + Identifies when the comment was published at. + """ + publishedAt: DateTime + + """ + A list of reactions grouped by content left on the subject. + """ + reactionGroups: [ReactionGroup!] + + """ + A list of Reactions left on the Issue. + """ + reactions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Allows filtering Reactions by emoji. + """ + content: ReactionContent + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Allows specifying the order in which reactions are returned. + """ + orderBy: ReactionOrder + ): ReactionConnection! + + """ + The repository associated with this node. + """ + repository: Repository! + + """ + The path for this discussion. + """ + resourcePath: URI! + + """ + The title of this discussion. + """ + title: String! + + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + + """ + Number of upvotes that this subject has received. + """ + upvoteCount: Int! + + """ + The URL for this discussion. + """ + url: URI! + + """ + A list of edits to this content. + """ + userContentEdits( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): UserContentEditConnection + + """ + Check if the current viewer can delete this object. + """ + viewerCanDelete: Boolean! + + """ + Can user react to this subject + """ + viewerCanReact: Boolean! + + """ + Check if the viewer is able to change their subscription status for the repository. + """ + viewerCanSubscribe: Boolean! + + """ + Check if the current viewer can update this object. + """ + viewerCanUpdate: Boolean! + + """ + Whether or not the current user can add or remove an upvote on this subject. + """ + viewerCanUpvote: Boolean! + + """ + Did the viewer author this comment. + """ + viewerDidAuthor: Boolean! + + """ + Whether or not the current user has already upvoted this subject. + """ + viewerHasUpvoted: Boolean! + + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + viewerSubscription: SubscriptionState +} + +""" +A category for discussions in a repository. +""" +type DiscussionCategory implements Node & RepositoryNode { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + + """ + A description of this category. + """ + description: String + + """ + An emoji representing this category. + """ + emoji: String! + + """ + This category's emoji rendered as HTML. + """ + emojiHTML: HTML! + id: ID! + + """ + Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation. + """ + isAnswerable: Boolean! + + """ + The name of this category. + """ + name: String! + + """ + The repository associated with this node. + """ + repository: Repository! + + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! +} + +""" +The connection type for DiscussionCategory. +""" +type DiscussionCategoryConnection { + """ + A list of edges. + """ + edges: [DiscussionCategoryEdge] + + """ + A list of nodes. + """ + nodes: [DiscussionCategory] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DiscussionCategoryEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DiscussionCategory +} + +""" +A comment on a discussion. +""" +type DiscussionComment implements Comment & Deletable & Minimizable & Node & Reactable & Updatable & UpdatableComment & Votable { + """ + The actor who authored the comment. + """ + author: Actor + + """ + Author's association with the subject of the comment. + """ + authorAssociation: CommentAuthorAssociation! + + """ + The body as Markdown. + """ + body: String! + + """ + The body rendered to HTML. + """ + bodyHTML: HTML! + + """ + The body rendered to text. + """ + bodyText: String! + + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + + """ + Check if this comment was created via an email reply. + """ + createdViaEmail: Boolean! + + """ + Identifies the primary key from the database. + """ + databaseId: Int + + """ + The time when this replied-to comment was deleted + """ + deletedAt: DateTime + + """ + The discussion this comment was created in + """ + discussion: Discussion + + """ + The actor who edited the comment. + """ + editor: Actor + id: ID! + + """ + Check if this comment was edited and includes an edit with the creation data + """ + includesCreatedEdit: Boolean! + + """ + Has this comment been chosen as the answer of its discussion? + """ + isAnswer: Boolean! + + """ + Returns whether or not a comment has been minimized. + """ + isMinimized: Boolean! + + """ + The moment the editor made the last edit + """ + lastEditedAt: DateTime + + """ + Returns why the comment was minimized. + """ + minimizedReason: String + + """ + Identifies when the comment was published at. + """ + publishedAt: DateTime + + """ + A list of reactions grouped by content left on the subject. + """ + reactionGroups: [ReactionGroup!] + + """ + A list of Reactions left on the Issue. + """ + reactions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Allows filtering Reactions by emoji. + """ + content: ReactionContent + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Allows specifying the order in which reactions are returned. + """ + orderBy: ReactionOrder + ): ReactionConnection! + + """ + The threaded replies to this comment. + """ + replies( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DiscussionCommentConnection! + + """ + The discussion comment this comment is a reply to + """ + replyTo: DiscussionComment + + """ + The path for this discussion comment. + """ + resourcePath: URI! + + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + + """ + Number of upvotes that this subject has received. + """ + upvoteCount: Int! + + """ + The URL for this discussion comment. + """ + url: URI! + + """ + A list of edits to this content. + """ + userContentEdits( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): UserContentEditConnection + + """ + Check if the current viewer can delete this object. + """ + viewerCanDelete: Boolean! + + """ + Can the current user mark this comment as an answer? + """ + viewerCanMarkAsAnswer: Boolean! + + """ + Check if the current viewer can minimize this object. + """ + viewerCanMinimize: Boolean! + + """ + Can user react to this subject + """ + viewerCanReact: Boolean! + + """ + Can the current user unmark this comment as an answer? + """ + viewerCanUnmarkAsAnswer: Boolean! + + """ + Check if the current viewer can update this object. + """ + viewerCanUpdate: Boolean! + + """ + Whether or not the current user can add or remove an upvote on this subject. + """ + viewerCanUpvote: Boolean! + + """ + Reasons why the current viewer can not update this comment. + """ + viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! + + """ + Did the viewer author this comment. + """ + viewerDidAuthor: Boolean! + + """ + Whether or not the current user has already upvoted this subject. + """ + viewerHasUpvoted: Boolean! +} + +""" +The connection type for DiscussionComment. +""" +type DiscussionCommentConnection { + """ + A list of edges. + """ + edges: [DiscussionCommentEdge] + + """ + A list of nodes. + """ + nodes: [DiscussionComment] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DiscussionCommentEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DiscussionComment +} + +""" +The connection type for Discussion. +""" +type DiscussionConnection { + """ + A list of edges. + """ + edges: [DiscussionEdge] + + """ + A list of nodes. + """ + nodes: [Discussion] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type DiscussionEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: Discussion +} + +""" +Ways in which lists of discussions can be ordered upon return. +""" +input DiscussionOrder { + """ + The direction in which to order discussions by the specified field. + """ + direction: OrderDirection! + + """ + The field by which to order discussions. + """ + field: DiscussionOrderField! +} + +""" +Properties by which discussion connections can be ordered. +""" +enum DiscussionOrderField { + """ + Order discussions by creation time. + """ + CREATED_AT + + """ + Order discussions by most recent modification time. + """ + UPDATED_AT +} + """ Autogenerated input type of DismissPullRequestReview """ @@ -7877,6 +9562,11 @@ type EnterpriseIdentityProvider implements Node { Returns the last _n_ elements from the list. """ last: Int + + """ + Filter to external identities with valid org membership only + """ + membersOnly: Boolean ): ExternalIdentityConnection! id: ID! @@ -8305,6 +9995,46 @@ type EnterpriseOwnerInfo { value: DefaultRepositoryPermissionField! ): OrganizationConnection! + """ + A list of domains owned by the enterprise. + """ + domains( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Filter whether or not the domain is approved. + """ + isApproved: Boolean = null + + """ + Filter whether or not the domain is verified. + """ + isVerified: Boolean = null + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for verifiable domains returned. + """ + orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC} + ): VerifiableDomainConnection! + """ The setting value for whether the enterprise has an IP allow list enabled. """ @@ -8340,6 +10070,11 @@ type EnterpriseOwnerInfo { orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC} ): IpAllowListEntryConnection! + """ + The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled. + """ + ipAllowListForInstalledAppsEnabledSetting: IpAllowListForInstalledAppsEnabledSettingValue! + """ Whether or not the default repository permission is currently being updated. """ @@ -8651,6 +10386,11 @@ type EnterpriseOwnerInfo { value: Boolean! ): OrganizationConnection! + """ + Indicates if email notification delivery for this enterprise is restricted to verified or approved domains. + """ + notificationDeliveryRestrictionEnabledSetting: NotificationRestrictionSettingValue! + """ The setting value for whether organization projects are enabled for organizations in this enterprise. """ @@ -9172,7 +10912,7 @@ type EnterpriseRepositoryInfo implements Node { id: ID! """ - Identifies if the repository is private. + Identifies if the repository is private or internal. """ isPrivate: Boolean! @@ -9847,6 +11587,87 @@ enum EnterpriseUserDeployment { SERVER } +""" +An environment. +""" +type Environment implements Node { + """ + Identifies the primary key from the database. + """ + databaseId: Int + id: ID! + + """ + The name of the environment + """ + name: String! + + """ + The protection rules defined for this environment + """ + protectionRules( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DeploymentProtectionRuleConnection! +} + +""" +The connection type for Environment. +""" +type EnvironmentConnection { + """ + A list of edges. + """ + edges: [EnvironmentEdge] + + """ + A list of nodes. + """ + nodes: [Environment] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type EnvironmentEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: Environment +} + """ An external identity provisioned by SAML SSO or SCIM. """ @@ -11217,10 +13038,25 @@ enum IpAllowListEntryOrderField { CREATED_AT } +""" +The possible values for the IP allow list configuration for installed GitHub Apps setting. +""" +enum IpAllowListForInstalledAppsEnabledSettingValue { + """ + The setting is disabled for the owner. + """ + DISABLED + + """ + The setting is enabled for the owner. + """ + ENABLED +} + """ Types that can own an IP allow list. """ -union IpAllowListOwner = Enterprise | Organization +union IpAllowListOwner = App | Enterprise | Organization """ An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. @@ -11618,6 +13454,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N """ title: String! + """ + Identifies the issue title rendered to HTML. + """ + titleHTML: String! + """ Identifies the date and time when the object was last updated. """ @@ -12501,7 +14342,7 @@ type JoinedGitHubContribution implements Contribution { } """ -A label for categorizing Issues or Milestones with a given Repository. +A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository. """ type Label implements Node { """ @@ -13014,7 +14855,7 @@ input LockLockableInput { """ ID of the item to be locked. """ - lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable") + lockableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Lockable") } """ @@ -13117,6 +14958,11 @@ type Mannequin implements Actor & Node & UniformResourceLocatable { size: Int ): URI! + """ + The user that has claimed the data attributed to this mannequin. + """ + claimant: User + """ Identifies the date and time when the object was created. """ @@ -13154,6 +15000,36 @@ type Mannequin implements Actor & Node & UniformResourceLocatable { url: URI! } +""" +Autogenerated input type of MarkDiscussionCommentAsAnswer +""" +input MarkDiscussionCommentAsAnswerInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion comment to mark as an answer. + """ + id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) +} + +""" +Autogenerated return type of MarkDiscussionCommentAsAnswer +""" +type MarkDiscussionCommentAsAnswerPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The discussion that includes the chosen comment. + """ + discussion: Discussion +} + """ Autogenerated input type of MarkFileAsViewed """ @@ -14179,7 +16055,7 @@ input MinimizeCommentInput { """ subjectId: ID! @possibleTypes( - concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"] + concreteTypes: ["CommitComment", "DiscussionComment", "GistComment", "IssueComment", "PullRequestReviewComment"] abstractType: "Minimizable" ) } @@ -14339,6 +16215,16 @@ type Mutation { input: AddCommentInput! ): AddCommentPayload + """ + Adds a comment to a Discussion, possibly as a reply to another comment. + """ + addDiscussionComment( + """ + Parameters for AddDiscussionComment + """ + input: AddDiscussionCommentInput! + ): AddDiscussionCommentPayload + """ Adds an administrator to the global enterprise account. """ @@ -14429,6 +16315,46 @@ type Mutation { input: AddStarInput! ): AddStarPayload + """ + Add an upvote to a discussion or discussion comment. + """ + addUpvote( + """ + Parameters for AddUpvote + """ + input: AddUpvoteInput! + ): AddUpvotePayload + + """ + Adds a verifiable domain to an owning account. + """ + addVerifiableDomain( + """ + Parameters for AddVerifiableDomain + """ + input: AddVerifiableDomainInput! + ): AddVerifiableDomainPayload + + """ + Approve all pending deployments under one or more environments + """ + approveDeployments( + """ + Parameters for ApproveDeployments + """ + input: ApproveDeploymentsInput! + ): ApproveDeploymentsPayload + + """ + Approve a verifiable domain for notification delivery. + """ + approveVerifiableDomain( + """ + Parameters for ApproveVerifiableDomain + """ + input: ApproveVerifiableDomainInput! + ): ApproveVerifiableDomainPayload + """ Marks a repository as archived. """ @@ -14509,6 +16435,16 @@ type Mutation { input: ConvertProjectCardNoteToIssueInput! ): ConvertProjectCardNoteToIssuePayload + """ + Converts a pull request to draft + """ + convertPullRequestToDraft( + """ + Parameters for ConvertPullRequestToDraft + """ + input: ConvertPullRequestToDraftInput! + ): ConvertPullRequestToDraftPayload + """ Create a new branch protection rule """ @@ -14569,6 +16505,16 @@ type Mutation { input: CreateDeploymentStatusInput! ): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + """ + Create a discussion. + """ + createDiscussion( + """ + Parameters for CreateDiscussion + """ + input: CreateDiscussionInput! + ): CreateDiscussionPayload + """ Creates an organization as part of an enterprise account. """ @@ -14579,6 +16525,16 @@ type Mutation { input: CreateEnterpriseOrganizationInput! ): CreateEnterpriseOrganizationPayload + """ + Creates an environment or simply returns it if already exists. + """ + createEnvironment( + """ + Parameters for CreateEnvironment + """ + input: CreateEnvironmentInput! + ): CreateEnvironmentPayload + """ Creates a new IP allow list entry. """ @@ -14689,6 +16645,36 @@ type Mutation { input: DeleteDeploymentInput! ): DeleteDeploymentPayload + """ + Delete a discussion and all of its replies. + """ + deleteDiscussion( + """ + Parameters for DeleteDiscussion + """ + input: DeleteDiscussionInput! + ): DeleteDiscussionPayload + + """ + Delete a discussion comment. If it has replies, wipe it instead. + """ + deleteDiscussionComment( + """ + Parameters for DeleteDiscussionComment + """ + input: DeleteDiscussionCommentInput! + ): DeleteDiscussionCommentPayload + + """ + Deletes an environment + """ + deleteEnvironment( + """ + Parameters for DeleteEnvironment + """ + input: DeleteEnvironmentInput! + ): DeleteEnvironmentPayload + """ Deletes an IP allow list entry. """ @@ -14819,6 +16805,16 @@ type Mutation { input: DeleteTeamDiscussionCommentInput! ): DeleteTeamDiscussionCommentPayload + """ + Deletes a verifiable domain. + """ + deleteVerifiableDomain( + """ + Parameters for DeleteVerifiableDomain + """ + input: DeleteVerifiableDomainInput! + ): DeleteVerifiableDomainPayload + """ Disable auto merge on the given pull request """ @@ -14889,6 +16885,16 @@ type Mutation { input: LockLockableInput! ): LockLockablePayload + """ + Mark a discussion comment as the chosen answer for discussions in an answerable category. + """ + markDiscussionCommentAsAnswer( + """ + Parameters for MarkDiscussionCommentAsAnswer + """ + input: MarkDiscussionCommentAsAnswerInput! + ): MarkDiscussionCommentAsAnswerPayload + """ Mark a pull request file as viewed """ @@ -14969,6 +16975,26 @@ type Mutation { input: PinIssueInput! ): PinIssuePayload + """ + Regenerates a verifiable domain's verification token. + """ + regenerateVerifiableDomainToken( + """ + Parameters for RegenerateVerifiableDomainToken + """ + input: RegenerateVerifiableDomainTokenInput! + ): RegenerateVerifiableDomainTokenPayload + + """ + Reject all pending deployments under one or more environments + """ + rejectDeployments( + """ + Parameters for RejectDeployments + """ + input: RejectDeploymentsInput! + ): RejectDeploymentsPayload + """ Removes assignees from an assignable object. """ @@ -15029,6 +17055,16 @@ type Mutation { input: RemoveStarInput! ): RemoveStarPayload + """ + Remove an upvote to a discussion or discussion comment. + """ + removeUpvote( + """ + Parameters for RemoveUpvote + """ + input: RemoveUpvoteInput! + ): RemoveUpvotePayload + """ Reopen a issue. """ @@ -15139,6 +17175,16 @@ type Mutation { input: UnlockLockableInput! ): UnlockLockablePayload + """ + Unmark a discussion comment as the chosen answer for discussions in an answerable category. + """ + unmarkDiscussionCommentAsAnswer( + """ + Parameters for UnmarkDiscussionCommentAsAnswer + """ + input: UnmarkDiscussionCommentAsAnswerInput! + ): UnmarkDiscussionCommentAsAnswerPayload + """ Unmark a pull request file as viewed """ @@ -15219,6 +17265,26 @@ type Mutation { input: UpdateCheckSuitePreferencesInput! ): UpdateCheckSuitePreferencesPayload + """ + Update a discussion + """ + updateDiscussion( + """ + Parameters for UpdateDiscussion + """ + input: UpdateDiscussionInput! + ): UpdateDiscussionPayload + + """ + Update the contents of a comment on a Discussion + """ + updateDiscussionComment( + """ + Parameters for UpdateDiscussionComment + """ + input: UpdateDiscussionCommentInput! + ): UpdateDiscussionCommentPayload + """ Sets whether private repository forks are enabled for an enterprise. """ @@ -15230,7 +17296,7 @@ type Mutation { ): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload """ - Sets the default repository permission for organizations in an enterprise. + Sets the base repository permission for organizations in an enterprise. """ updateEnterpriseDefaultRepositoryPermissionSetting( """ @@ -15369,6 +17435,16 @@ type Mutation { input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput! ): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload + """ + Updates an environment. + """ + updateEnvironment( + """ + Parameters for UpdateEnvironment + """ + input: UpdateEnvironmentInput! + ): UpdateEnvironmentPayload + """ Sets whether an IP allow list is enabled on an owner. """ @@ -15389,6 +17465,16 @@ type Mutation { input: UpdateIpAllowListEntryInput! ): UpdateIpAllowListEntryPayload + """ + Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner. + """ + updateIpAllowListForInstalledAppsEnabledSetting( + """ + Parameters for UpdateIpAllowListForInstalledAppsEnabledSetting + """ + input: UpdateIpAllowListForInstalledAppsEnabledSettingInput! + ): UpdateIpAllowListForInstalledAppsEnabledSettingPayload + """ Updates an Issue. """ @@ -15419,6 +17505,16 @@ type Mutation { input: UpdateLabelInput! ): UpdateLabelPayload @preview(toggledBy: "bane-preview") + """ + Update the setting to restrict notifications to only verified or approved domains available to an owner. + """ + updateNotificationRestrictionSetting( + """ + Parameters for UpdateNotificationRestrictionSetting + """ + input: UpdateNotificationRestrictionSettingInput! + ): UpdateNotificationRestrictionSettingPayload + """ Updates an existing project. """ @@ -15575,6 +17671,16 @@ type Mutation { """ input: UpdateTopicsInput! ): UpdateTopicsPayload + + """ + Verify that a verifiable domain has the expected DNS record. + """ + verifyVerifiableDomain( + """ + Parameters for VerifyVerifiableDomain + """ + input: VerifyVerifiableDomainInput! + ): VerifyVerifiableDomainPayload } """ @@ -15587,6 +17693,21 @@ interface Node { id: ID! } +""" +The possible values for the notification restriction setting. +""" +enum NotificationRestrictionSettingValue { + """ + The setting is disabled for the owner. + """ + DISABLED + + """ + The setting is enabled for the owner. + """ + ENABLED +} + """ Metadata for an audit entry with action oauth_application.* """ @@ -18774,7 +20895,7 @@ type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEnt """ An account on GitHub, with one or more owners, that has repositories, members and teams. """ -type Organization implements Actor & MemberStatusable & Node & PackageOwner & ProfileOwner & ProjectOwner & RepositoryOwner & Sponsorable & UniformResourceLocatable { +type Organization implements Actor & MemberStatusable & Node & PackageOwner & ProfileOwner & ProjectOwner & RepositoryDiscussionAuthor & RepositoryDiscussionCommentAuthor & RepositoryOwner & Sponsorable & UniformResourceLocatable { """ Determine if this repository owner has any items that can be pinned to their profile. """ @@ -18850,6 +20971,46 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ descriptionHTML: String + """ + A list of domains owned by the organization. + """ + domains( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Filter by if the domain is approved. + """ + isApproved: Boolean = null + + """ + Filter by if the domain is verified. + """ + isVerified: Boolean = null + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for verifiable domains returned. + """ + orderBy: VerifiableDomainOrder = {field: DOMAIN, direction: ASC} + ): VerifiableDomainConnection + """ The organization's public email. """ @@ -18892,7 +21053,12 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr ): IpAllowListEntryConnection! """ - Whether the organization has verified its profile email and website, always false on Enterprise. + The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled. + """ + ipAllowListForInstalledAppsEnabledSetting: IpAllowListForInstalledAppsEnabledSettingValue! + + """ + Whether the organization has verified its profile email and website. """ isVerified: Boolean! @@ -18982,6 +21148,11 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ newTeamUrl: URI! + """ + Indicates if email notification delivery for this organization is restricted to verified or approved domains. + """ + notificationDeliveryRestrictionEnabledSetting: NotificationRestrictionSettingValue! + """ The billing email for the organization. """ @@ -19251,6 +21422,82 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr name: String! ): Repository + """ + Discussion comments this user has authored. + """ + repositoryDiscussionComments( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Filter discussion comments to only those that were marked as the answer + """ + onlyAnswers: Boolean = false + + """ + Filter discussion comments to only those in a specific repository. + """ + repositoryId: ID + ): DiscussionCommentConnection! + + """ + Discussions this user has started. + """ + repositoryDiscussions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Filter discussions to only those that have been answered or not. Defaults to + including both answered and unanswered discussions. + """ + answered: Boolean = null + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for discussions returned from the connection. + """ + orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC} + + """ + Filter discussions to only those in a specific repository. + """ + repositoryId: ID + ): DiscussionConnection! + """ When true the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication. @@ -19665,6 +21912,11 @@ type OrganizationIdentityProvider implements Node { Returns the last _n_ elements from the list. """ last: Int + + """ + Filter to external identities with valid org membership only + """ + membersOnly: Boolean ): ExternalIdentityConnection! id: ID! @@ -20371,6 +22623,9 @@ enum PackageType { A docker image. """ DOCKER + @deprecated( + reason: "DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2021-06-21 UTC." + ) """ A maven package. @@ -20719,6 +22974,162 @@ enum PinnableItemType { USER } +""" +A Pinned Discussion is a discussion pinned to a repository's index page. +""" +type PinnedDiscussion implements Node & RepositoryNode { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + + """ + Identifies the primary key from the database. + """ + databaseId: Int + + """ + The discussion that was pinned. + """ + discussion: Discussion! + + """ + Color stops of the chosen gradient + """ + gradientStopColors: [String!]! + id: ID! + + """ + Background texture pattern + """ + pattern: PinnedDiscussionPattern! + + """ + The actor that pinned this discussion. + """ + pinnedBy: Actor! + + """ + Preconfigured background gradient option + """ + preconfiguredGradient: PinnedDiscussionGradient + + """ + The repository associated with this node. + """ + repository: Repository! + + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! +} + +""" +The connection type for PinnedDiscussion. +""" +type PinnedDiscussionConnection { + """ + A list of edges. + """ + edges: [PinnedDiscussionEdge] + + """ + A list of nodes. + """ + nodes: [PinnedDiscussion] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type PinnedDiscussionEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: PinnedDiscussion +} + +""" +Preconfigured gradients that may be used to style discussions pinned within a repository. +""" +enum PinnedDiscussionGradient { + """ + A gradient of blue to mint + """ + BLUE_MINT + + """ + A gradient of blue to purple + """ + BLUE_PURPLE + + """ + A gradient of pink to blue + """ + PINK_BLUE + + """ + A gradient of purple to coral + """ + PURPLE_CORAL + + """ + A gradient of red to orange + """ + RED_ORANGE +} + +""" +Preconfigured background patterns that may be used to style discussions pinned within a repository. +""" +enum PinnedDiscussionPattern { + """ + An upward-facing chevron pattern + """ + CHEVRON_UP + + """ + A hollow dot pattern + """ + DOT + + """ + A solid dot pattern + """ + DOT_FILL + + """ + A heart pattern + """ + HEART_FILL + + """ + A plus sign pattern + """ + PLUS + + """ + A lightning bolt pattern + """ + ZAP +} + """ Represents a 'pinned' event on a given issue or pull request. """ @@ -22744,6 +25155,11 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab """ title: String! + """ + Identifies the pull request title rendered to HTML. + """ + titleHTML: HTML! + """ Identifies the date and time when the object was last updated. """ @@ -22824,6 +25240,16 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab """ viewerDidAuthor: Boolean! + """ + The latest review given from the viewer. + """ + viewerLatestReview: PullRequestReview + + """ + The person who has requested the viewer for review on this pull request. + """ + viewerLatestReviewRequest: ReviewRequest + """ The merge body text for the viewer and method. """ @@ -24075,6 +26501,26 @@ enum PullRequestState { OPEN } +""" +A repository pull request template. +""" +type PullRequestTemplate { + """ + The body of the template + """ + body: String + + """ + The filename of the template + """ + filename: String + + """ + The repository the template belongs to + """ + repository: Repository! +} + """ The connection type for PullRequestTimelineItem. """ @@ -25253,6 +27699,31 @@ type ReactionGroup { """ createdAt: DateTime + """ + Reactors to the reaction subject with the emotion represented by this reaction group. + """ + reactors( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): ReactorConnection! + """ The subject that was reacted to. """ @@ -25282,6 +27753,9 @@ type ReactionGroup { """ last: Int ): ReactingUserConnection! + @deprecated( + reason: "Reactors can now be mannequins, bots, and organizations. Use the `reactors` field instead. Removal on 2021-10-01 UTC." + ) """ Whether or not the authenticated user has left a reaction on the subject. @@ -25314,6 +27788,56 @@ enum ReactionOrderField { CREATED_AT } +""" +Types that can be assigned to reactions. +""" +union Reactor = Bot | Mannequin | Organization | User + +""" +The connection type for Reactor. +""" +type ReactorConnection { + """ + A list of edges. + """ + edges: [ReactorEdge] + + """ + A list of nodes. + """ + nodes: [Reactor] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +Represents an author of a reaction. +""" +type ReactorEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The author of the reaction. + """ + node: Reactor! + + """ + The moment when the user made the reaction. + """ + reactedAt: DateTime! +} + """ Represents a 'ready_for_review' event on a given pull request. """ @@ -25555,6 +28079,16 @@ type RefUpdateRule { """ requiredStatusCheckContexts: [String] + """ + Are reviews from code owners required to update matching branches. + """ + requiresCodeOwnerReviews: Boolean! + + """ + Are conversations required to be resolved before merging. + """ + requiresConversationResolution: Boolean! + """ Are merge commits prohibited from being pushed to this branch. """ @@ -25565,6 +28099,11 @@ type RefUpdateRule { """ requiresSignatures: Boolean! + """ + Is the viewer allowed to dismiss reviews. + """ + viewerAllowedToDismissReviews: Boolean! + """ Can the viewer push to the branch """ @@ -25617,10 +28156,80 @@ Any referencable object """ union ReferencedSubject = Issue | PullRequest +""" +Autogenerated input type of RegenerateVerifiableDomainToken +""" +input RegenerateVerifiableDomainTokenInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to regenerate the verification token of. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of RegenerateVerifiableDomainToken +""" +type RegenerateVerifiableDomainTokenPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verification token that was generated. + """ + verificationToken: String +} + +""" +Autogenerated input type of RejectDeployments +""" +input RejectDeploymentsInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Optional comment for rejecting deployments + """ + comment: String = "" + + """ + The ids of environments to reject deployments + """ + environmentIds: [ID!]! + + """ + The node ID of the workflow run containing the pending deployments. + """ + workflowRunId: ID! @possibleTypes(concreteTypes: ["WorkflowRun"]) +} + +""" +Autogenerated return type of RejectDeployments +""" +type RejectDeploymentsPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The affected deployments. + """ + deployments: [Deployment!] +} + """ A release contains the content for a release. """ -type Release implements Node & UniformResourceLocatable { +type Release implements Node & Reactable & UniformResourceLocatable { """ The author of the release """ @@ -25631,6 +28240,11 @@ type Release implements Node & UniformResourceLocatable { """ createdAt: DateTime! + """ + Identifies the primary key from the database. + """ + databaseId: Int + """ The description of the release. """ @@ -25657,6 +28271,31 @@ type Release implements Node & UniformResourceLocatable { """ isPrerelease: Boolean! + """ + A list of users mentioned in the release description + """ + mentions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): UserConnection + """ The title of the release. """ @@ -25667,6 +28306,46 @@ type Release implements Node & UniformResourceLocatable { """ publishedAt: DateTime + """ + A list of reactions grouped by content left on the subject. + """ + reactionGroups: [ReactionGroup!] + + """ + A list of Reactions left on the Issue. + """ + reactions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Allows filtering Reactions by emoji. + """ + content: ReactionContent + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Allows specifying the order in which reactions are returned. + """ + orderBy: ReactionOrder + ): ReactionConnection! + """ List of releases assets which are dependent on this release. """ @@ -25741,6 +28420,11 @@ type Release implements Node & UniformResourceLocatable { The HTTP URL for this issue """ url: URI! + + """ + Can user react to this subject + """ + viewerCanReact: Boolean! } """ @@ -26011,7 +28695,7 @@ input RemoveLabelsFromLabelableInput { """ The id of the Labelable to remove labels from. """ - labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable") + labelableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Labelable") } """ @@ -26085,11 +28769,14 @@ input RemoveReactionInput { @possibleTypes( concreteTypes: [ "CommitComment" + "Discussion" + "DiscussionComment" "Issue" "IssueComment" "PullRequest" "PullRequestReview" "PullRequestReviewComment" + "Release" "TeamDiscussion" "TeamDiscussionComment" ] @@ -26147,6 +28834,36 @@ type RemoveStarPayload { starrable: Starrable } +""" +Autogenerated input type of RemoveUpvote +""" +input RemoveUpvoteInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion or comment to remove upvote. + """ + subjectId: ID! @possibleTypes(concreteTypes: ["Discussion", "DiscussionComment"], abstractType: "Votable") +} + +""" +Autogenerated return type of RemoveUpvote +""" +type RemoveUpvotePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The votable subject. + """ + subject: Votable +} + """ Represents a 'removed_from_project' event on a given issue or pull request. """ @@ -28858,11 +31575,116 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & """ descriptionHTML: HTML! + """ + Returns a single discussion from the current repository by number. + """ + discussion( + """ + The number for the discussion to be returned. + """ + number: Int! + ): Discussion + + """ + A list of discussion categories that are available in the repository. + """ + discussionCategories( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DiscussionCategoryConnection! + + """ + A list of discussions that have been opened in the repository. + """ + discussions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Only include discussions that belong to the category with this ID. + """ + categoryId: ID = null + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for discussions returned from the connection. + """ + orderBy: DiscussionOrder = {field: UPDATED_AT, direction: DESC} + ): DiscussionConnection! + """ The number of kilobytes this repository occupies on disk. """ diskUsage: Int + """ + Returns a single active environment from the current repository by name. + """ + environment( + """ + The name of the environment to be returned. + """ + name: String! + ): Environment + + """ + A list of environments that are in this repository. + """ + environments( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): EnvironmentConnection! + """ Returns how many forks there are of this repository in the whole network. """ @@ -28989,7 +31811,7 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & isMirror: Boolean! """ - Identifies if the repository is private. + Identifies if the repository is private or internal. """ isPrivate: Boolean! @@ -29343,6 +32165,31 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & """ parent: Repository + """ + A list of discussions that have been pinned in this repository. + """ + pinnedDiscussions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): PinnedDiscussionConnection! + """ A list of pinned issues for this repository. """ @@ -29443,6 +32290,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & number: Int! ): PullRequest + """ + Returns a list of pull request templates associated to the repository + """ + pullRequestTemplates: [PullRequestTemplate!] + """ A list of pull requests that have been opened in the repository. """ @@ -30013,6 +32865,92 @@ enum RepositoryContributionType { REPOSITORY } +""" +Represents an author of discussions in repositories. +""" +interface RepositoryDiscussionAuthor { + """ + Discussions this user has started. + """ + repositoryDiscussions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Filter discussions to only those that have been answered or not. Defaults to + including both answered and unanswered discussions. + """ + answered: Boolean = null + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for discussions returned from the connection. + """ + orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC} + + """ + Filter discussions to only those in a specific repository. + """ + repositoryId: ID + ): DiscussionConnection! +} + +""" +Represents an author of discussion comments in repositories. +""" +interface RepositoryDiscussionCommentAuthor { + """ + Discussion comments this user has authored. + """ + repositoryDiscussionComments( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Filter discussion comments to only those that were marked as the answer + """ + onlyAnswers: Boolean = false + + """ + Filter discussion comments to only those in a specific repository. + """ + repositoryId: ID + ): DiscussionCommentConnection! +} + """ An edge in a connection. """ @@ -30103,7 +33041,7 @@ interface RepositoryInfo { isMirror: Boolean! """ - Identifies if the repository is private. + Identifies if the repository is private or internal. """ isPrivate: Boolean! @@ -30813,7 +33751,7 @@ type RepositoryVisibilityChangeEnableAuditEntry implements AuditEntry & Enterpri } """ -A alert for a repository with an affected vulnerability. +A Dependabot alert for a repository with a dependency affected by a security vulnerability. """ type RepositoryVulnerabilityAlert implements Node & RepositoryNode { """ @@ -30977,6 +33915,11 @@ enum RequestableCheckStatusState { """ IN_PROGRESS + """ + The check suite or run is in pending state. + """ + PENDING + """ The check suite or run has been queued. """ @@ -30993,6 +33936,26 @@ Types that can be requested reviewers. """ union RequestedReviewer = Mannequin | Team | User +""" +Represents a type that can be required by a pull request for merging. +""" +interface RequirableByPullRequest { + """ + Whether this is required to pass before merging for a specific pull request. + """ + isRequired( + """ + The id of the pull request this is required for + """ + pullRequestId: ID + + """ + The number of the pull request this is required for + """ + pullRequestNumber: Int + ): Boolean! +} + """ Autogenerated input type of RerequestCheckSuite """ @@ -31500,7 +34463,7 @@ enum SavedReplyOrderField { """ The results of a search. """ -union SearchResultItem = App | Issue | Organization | PullRequest | Repository | User +union SearchResultItem = App | Discussion | Issue | Organization | PullRequest | Repository | User """ A list of results that matched against a search query. @@ -31511,6 +34474,11 @@ type SearchResultItemConnection { """ codeCount: Int! + """ + The number of discussions that matched the search query. + """ + discussionCount: Int! + """ A list of edges. """ @@ -31571,6 +34539,11 @@ type SearchResultItemEdge { Represents the individual results of a search. """ enum SearchType { + """ + Returns matching discussions in repositories. + """ + DISCUSSION + """ Returns results matching issues in repositories. """ @@ -31762,6 +34735,11 @@ enum SecurityAdvisoryEcosystem { """ COMPOSER + """ + Go modules + """ + GO + """ Java artifacts hosted at the Maven central repository """ @@ -31777,6 +34755,11 @@ enum SecurityAdvisoryEcosystem { """ NUGET + """ + Applications, runtimes, operating systems and other kinds of software + """ + OTHER + """ Python packages hosted at PyPI.org """ @@ -32087,6 +35070,11 @@ type Sponsorship implements Node { createdAt: DateTime! id: ID! + """ + Whether this sponsorship represents a one-time payment versus a recurring sponsorship. + """ + isOneTimePayment: Boolean! + """ The entity that is being sponsored """ @@ -32117,6 +35105,11 @@ type Sponsorship implements Node { The entity that is being sponsored """ sponsorable: Sponsorable! + + """ + Identifies the date and time when the current tier was chosen for this sponsorship. + """ + tierSelectedAt: DateTime } """ @@ -32488,7 +35481,7 @@ type StatusCheckRollupContextEdge { """ Represents an individual commit status context """ -type StatusContext implements Node { +type StatusContext implements Node & RequirableByPullRequest { """ The avatar of the OAuth application or the user that created the status """ @@ -32525,6 +35518,21 @@ type StatusContext implements Node { description: String id: ID! + """ + Whether this is required to pass before merging for a specific pull request. + """ + isRequired( + """ + The id of the pull request this is required for + """ + pullRequestId: ID + + """ + The number of the pull request this is required for + """ + pullRequestNumber: Int + ): Boolean! + """ The state of this status context. """ @@ -35306,7 +38314,7 @@ input UnlockLockableInput { """ ID of the item to be unlocked. """ - lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable") + lockableId: ID! @possibleTypes(concreteTypes: ["Discussion", "Issue", "PullRequest"], abstractType: "Lockable") } """ @@ -35350,6 +38358,36 @@ type UnlockedEvent implements Node { lockable: Lockable! } +""" +Autogenerated input type of UnmarkDiscussionCommentAsAnswer +""" +input UnmarkDiscussionCommentAsAnswerInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion comment to unmark as an answer. + """ + id: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) +} + +""" +Autogenerated return type of UnmarkDiscussionCommentAsAnswer +""" +type UnmarkDiscussionCommentAsAnswerPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The discussion that includes the comment. + """ + discussion: Discussion +} + """ Autogenerated input type of UnmarkFileAsViewed """ @@ -35465,7 +38503,7 @@ input UnminimizeCommentInput { """ subjectId: ID! @possibleTypes( - concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"] + concreteTypes: ["CommitComment", "DiscussionComment", "GistComment", "IssueComment", "PullRequestReviewComment"] abstractType: "Minimizable" ) } @@ -35676,6 +38714,11 @@ input UpdateBranchProtectionRuleInput { """ requiresCommitSignatures: Boolean + """ + Are conversations required to be resolved before merging. + """ + requiresConversationResolution: Boolean + """ Are merge commits prohibited from being pushed to this branch. """ @@ -35837,6 +38880,86 @@ type UpdateCheckSuitePreferencesPayload { repository: Repository } +""" +Autogenerated input type of UpdateDiscussionComment +""" +input UpdateDiscussionCommentInput { + """ + The new contents of the comment body. + """ + body: String! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion comment to update. + """ + commentId: ID! @possibleTypes(concreteTypes: ["DiscussionComment"]) +} + +""" +Autogenerated return type of UpdateDiscussionComment +""" +type UpdateDiscussionCommentPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The modified discussion comment. + """ + comment: DiscussionComment +} + +""" +Autogenerated input type of UpdateDiscussion +""" +input UpdateDiscussionInput { + """ + The new contents of the discussion body. + """ + body: String + + """ + The Node ID of a discussion category within the same repository to change this discussion to. + """ + categoryId: ID @possibleTypes(concreteTypes: ["DiscussionCategory"]) + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The Node ID of the discussion to update. + """ + discussionId: ID! @possibleTypes(concreteTypes: ["Discussion"]) + + """ + The new discussion title. + """ + title: String +} + +""" +Autogenerated return type of UpdateDiscussion +""" +type UpdateDiscussionPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The modified discussion. + """ + discussion: Discussion +} + """ Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting """ @@ -35887,12 +39010,12 @@ input UpdateEnterpriseDefaultRepositoryPermissionSettingInput { clientMutationId: String """ - The ID of the enterprise on which to set the default repository permission setting. + The ID of the enterprise on which to set the base repository permission setting. """ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) """ - The value for the default repository permission setting on the enterprise. + The value for the base repository permission setting on the enterprise. """ settingValue: EnterpriseDefaultRepositoryPermissionSettingValue! } @@ -35907,12 +39030,12 @@ type UpdateEnterpriseDefaultRepositoryPermissionSettingPayload { clientMutationId: String """ - The enterprise with the updated default repository permission setting. + The enterprise with the updated base repository permission setting. """ enterprise: Enterprise """ - A message confirming the result of updating the default repository permission setting. + A message confirming the result of updating the base repository permission setting. """ message: String } @@ -36468,6 +39591,46 @@ type UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload { message: String } +""" +Autogenerated input type of UpdateEnvironment +""" +input UpdateEnvironmentInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The node ID of the environment. + """ + environmentId: ID! @possibleTypes(concreteTypes: ["Environment"]) + + """ + The ids of users or teams that can approve deployments to this environment + """ + reviewers: [ID!] + + """ + The wait timer in minutes. + """ + waitTimer: Int +} + +""" +Autogenerated return type of UpdateEnvironment +""" +type UpdateEnvironmentPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The updated environment. + """ + environment: Environment +} + """ Autogenerated input type of UpdateIpAllowListEnabledSetting """ @@ -36480,7 +39643,7 @@ input UpdateIpAllowListEnabledSettingInput { """ The ID of the owner on which to set the IP allow list enabled setting. """ - ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "IpAllowListOwner") + ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner") """ The value for the IP allow list enabled setting. @@ -36548,6 +39711,41 @@ type UpdateIpAllowListEntryPayload { ipAllowListEntry: IpAllowListEntry } +""" +Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting +""" +input UpdateIpAllowListForInstalledAppsEnabledSettingInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the owner. + """ + ownerId: ID! @possibleTypes(concreteTypes: ["App", "Enterprise", "Organization"], abstractType: "IpAllowListOwner") + + """ + The value for the IP allow list configuration for installed GitHub Apps setting. + """ + settingValue: IpAllowListForInstalledAppsEnabledSettingValue! +} + +""" +Autogenerated return type of UpdateIpAllowListForInstalledAppsEnabledSetting +""" +type UpdateIpAllowListForInstalledAppsEnabledSettingPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The IP allow list owner on which the setting was updated. + """ + owner: IpAllowListOwner +} + """ Autogenerated input type of UpdateIssueComment """ @@ -36698,6 +39896,41 @@ type UpdateLabelPayload @preview(toggledBy: "bane-preview") { label: Label } +""" +Autogenerated input type of UpdateNotificationRestrictionSetting +""" +input UpdateNotificationRestrictionSettingInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the owner on which to set the restrict notifications setting. + """ + ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "VerifiableDomainOwner") + + """ + The value for the restrict notifications setting. + """ + settingValue: NotificationRestrictionSettingValue! +} + +""" +Autogenerated return type of UpdateNotificationRestrictionSetting +""" +type UpdateNotificationRestrictionSettingPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The owner on which the setting was updated. + """ + owner: VerifiableDomainOwner +} + """ Autogenerated input type of UpdateProjectCard """ @@ -37129,7 +40362,7 @@ input UpdateSubscriptionInput { """ subscribableId: ID! @possibleTypes( - concreteTypes: ["Commit", "Issue", "PullRequest", "Repository", "Team", "TeamDiscussion"] + concreteTypes: ["Commit", "Discussion", "Issue", "PullRequest", "Repository", "Team", "TeamDiscussion"] abstractType: "Subscribable" ) } @@ -37338,7 +40571,7 @@ type UpdateTopicsPayload { """ A user is an individual's account on GitHub that owns repositories and can make new content. """ -type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & RepositoryOwner & Sponsorable & UniformResourceLocatable { +type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & RepositoryDiscussionAuthor & RepositoryDiscussionCommentAuthor & RepositoryOwner & Sponsorable & UniformResourceLocatable { """ Determine if this repository owner has any items that can be pinned to their profile. """ @@ -37369,6 +40602,16 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ bioHTML: HTML! + """ + Could this user receive email notifications, if the organization had notification restrictions enabled? + """ + canReceiveOrganizationEmailsWhenNotificationsRestricted( + """ + The login of the organization to check. + """ + login: String! + ): Boolean! + """ A list of commit comments made by this user. """ @@ -37419,8 +40662,9 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & organizationID: ID """ - Only contributions made before and up to and including this time will be - counted. If omitted, defaults to the current time. + Only contributions made before and up to (including) this time will be + counted. If omitted, defaults to the current time or one year from the + provided from argument. """ to: DateTime ): ContributionsCollection! @@ -38117,6 +41361,82 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & name: String! ): Repository + """ + Discussion comments this user has authored. + """ + repositoryDiscussionComments( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Filter discussion comments to only those that were marked as the answer + """ + onlyAnswers: Boolean = false + + """ + Filter discussion comments to only those in a specific repository. + """ + repositoryId: ID + ): DiscussionCommentConnection! + + """ + Discussions this user has started. + """ + repositoryDiscussions( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Filter discussions to only those that have been answered or not. Defaults to + including both answered and unanswered discussions. + """ + answered: Boolean = null + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for discussions returned from the connection. + """ + orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC} + + """ + Filter discussions to only those in a specific repository. + """ + repositoryId: ID + ): DiscussionConnection! + """ The HTTP path for this user """ @@ -38614,10 +41934,6 @@ type UserStatus implements Node { If set, the status will not be shown after this date. """ expiresAt: DateTime - - """ - ID of the object. - """ id: ID! """ @@ -38712,7 +42028,7 @@ enum UserStatusOrderField { } """ -A domain that can be verified for an organization or an enterprise. +A domain that can be verified or approved for an organization or an enterprise. """ type VerifiableDomain implements Node { """ @@ -38746,6 +42062,11 @@ type VerifiableDomain implements Node { hasFoundVerificationToken: Boolean! id: ID! + """ + Whether or not the domain is approved. + """ + isApproved: Boolean! + """ Whether this domain is required to exist for an organization or enterprise policy to be enforced. """ @@ -38782,11 +42103,111 @@ type VerifiableDomain implements Node { verificationToken: String } +""" +The connection type for VerifiableDomain. +""" +type VerifiableDomainConnection { + """ + A list of edges. + """ + edges: [VerifiableDomainEdge] + + """ + A list of nodes. + """ + nodes: [VerifiableDomain] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! + + """ + Identifies the total count of items in the connection. + """ + totalCount: Int! +} + +""" +An edge in a connection. +""" +type VerifiableDomainEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: VerifiableDomain +} + +""" +Ordering options for verifiable domain connections. +""" +input VerifiableDomainOrder { + """ + The ordering direction. + """ + direction: OrderDirection! + + """ + The field to order verifiable domains by. + """ + field: VerifiableDomainOrderField! +} + +""" +Properties by which verifiable domain connections can be ordered. +""" +enum VerifiableDomainOrderField { + """ + Order verifiable domains by their creation date. + """ + CREATED_AT + + """ + Order verifiable domains by the domain name. + """ + DOMAIN +} + """ Types that can own a verifiable domain. """ union VerifiableDomainOwner = Enterprise | Organization +""" +Autogenerated input type of VerifyVerifiableDomain +""" +input VerifyVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to verify. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of VerifyVerifiableDomain +""" +type VerifyVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was verified. + """ + domain: VerifiableDomain +} + """ A hovercard context with a message describing how the viewer is related. """ @@ -38807,6 +42228,148 @@ type ViewerHovercardContext implements HovercardContext { viewer: User! } +""" +A subject that may be upvoted. +""" +interface Votable { + """ + Number of upvotes that this subject has received. + """ + upvoteCount: Int! + + """ + Whether or not the current user can add or remove an upvote on this subject. + """ + viewerCanUpvote: Boolean! + + """ + Whether or not the current user has already upvoted this subject. + """ + viewerHasUpvoted: Boolean! +} + +""" +A workflow contains meta information about an Actions workflow file. +""" +type Workflow implements Node { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + + """ + Identifies the primary key from the database. + """ + databaseId: Int + id: ID! + + """ + The name of the workflow. + """ + name: String! + + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! +} + +""" +A workflow run. +""" +type WorkflowRun implements Node { + """ + The check suite this workflow run belongs to. + """ + checkSuite: CheckSuite! + + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + + """ + Identifies the primary key from the database. + """ + databaseId: Int + + """ + The log of deployment reviews + """ + deploymentReviews( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DeploymentReviewConnection! + id: ID! + + """ + The pending deployment requests of all check runs in this workflow run + """ + pendingDeploymentRequests( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DeploymentRequestConnection! + + """ + The HTTP path for this workflow run + """ + resourcePath: URI! + + """ + A number that uniquely identifies this workflow run in its parent workflow. + """ + runNumber: Int! + + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + + """ + The HTTP URL for this workflow run + """ + url: URI! + + """ + The workflow executed in this workflow run. + """ + workflow: Workflow! +} + """ A valid x509 certificate string """ diff --git a/data/graphql/graphql_upcoming_changes.public.yml b/data/graphql/graphql_upcoming_changes.public.yml index 434193c12d..79aa22aa5a 100644 --- a/data/graphql/graphql_upcoming_changes.public.yml +++ b/data/graphql/graphql_upcoming_changes.public.yml @@ -38,14 +38,6 @@ upcoming_changes: date: '2020-01-01T00:00:00+00:00' criticality: breaking owner: tambling - - location: Query.sponsorsListing - description: - '`sponsorsListing` will be removed. Use `Sponsorable.sponsorsListing` - instead.' - reason: '`Query.sponsorsListing` will be removed.' - date: '2020-04-01T00:00:00+00:00' - criticality: breaking - owner: antn - location: Sponsorship.maintainer description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.' reason: '`Sponsorship.maintainer` will be removed.' diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index 2a22a16d6c..bd000bc184 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -1374,6 +1374,11 @@ type AutomaticBaseChangeSucceededEvent implements Node { pullRequest: PullRequest! } +""" +A (potentially binary) string encoded using base64. +""" +scalar Base64String + """ Represents a 'base_ref_changed' event on a given issue or pull request. """ @@ -2024,6 +2029,53 @@ type CancelEnterpriseAdminInvitationPayload { message: String } +""" +Autogenerated input type of CancelSponsorship +""" +input CancelSponsorshipInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the user or organization who is acting as the sponsor, paying for + the sponsorship. Required if sponsorLogin is not given. + """ + sponsorId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "Sponsor") + + """ + The username of the user or organization who is acting as the sponsor, paying + for the sponsorship. Required if sponsorId is not given. + """ + sponsorLogin: String + + """ + The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. + """ + sponsorableId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "Sponsorable") + + """ + The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. + """ + sponsorableLogin: String +} + +""" +Autogenerated return type of CancelSponsorship +""" +type CancelSponsorshipPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The tier that was being used at the time of cancellation. + """ + sponsorsTier: SponsorsTier +} + """ Autogenerated input type of ChangeUserStatus """ @@ -4396,6 +4448,48 @@ type CommitHistoryConnection { totalCount: Int! } +""" +A message to include with a new commit +""" +input CommitMessage { + """ + The body of the message. + """ + body: String + + """ + The headline of the message. + """ + headline: String! +} + +""" +A git ref for a commit to be appended to. + +The ref must be a branch, i.e. its fully qualified name must start +with `refs/heads/` (although the input is not required to be fully +qualified). + +The Ref may be specified by its global node ID or by the +repository nameWithOwner and branch name. +""" +input CommittableBranch { + """ + The unqualified name of the branch to append the commit to. + """ + branchName: String + + """ + The Node ID of the Ref to be updated. + """ + id: ID + + """ + The nameWithOwner of the repository to commit to. + """ + repositoryNameWithOwner: String +} + """ Represents a 'connected' event on a given issue or pull request. """ @@ -5443,6 +5537,56 @@ type CreateCheckSuitePayload { clientMutationId: String } +""" +Autogenerated input type of CreateCommitOnBranch +""" +input CreateCommitOnBranchInput { + """ + The Ref to be updated. Must be a branch. + """ + branch: CommittableBranch! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The git commit oid expected at the head of the branch prior to the commit + """ + expectedHeadOid: GitObjectID! + + """ + A description of changes to files in this commit. + """ + fileChanges: FileChanges + + """ + The commit message the be included with the commit. + """ + message: CommitMessage! +} + +""" +Autogenerated return type of CreateCommitOnBranch +""" +type CreateCommitOnBranchPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The new commit. + """ + commit: Commit + + """ + The ref which has been updated to point to the new commit. + """ + ref: Ref +} + """ Autogenerated input type of CreateContentAttachment """ @@ -12320,6 +12464,159 @@ type ExternalIdentityScimAttributes { username: String } +""" +A command to add a file at the given path with the given contents as part of a +commit. Any existing file at that that path will be replaced. +""" +input FileAddition { + """ + The base64 encoded contents of the file + """ + contents: Base64String! + + """ + The path in the repository where the file will be located + """ + path: String! +} + +""" +A description of a set of changes to a file tree to be made as part of +a git commit, modeled as zero or more file `additions` and zero or more +file `deletions`. + +Both fields are optional; omitting both will produce a commit with no +file changes. + +`deletions` and `additions` describe changes to files identified +by their path in the git tree using unix-style path separators, i.e. +`/`. The root of a git tree is an empty string, so paths are not +slash-prefixed. + +`path` values must be unique across all `additions` and `deletions` +provided. Any duplication will result in a validation error. + +## Encoding + +File contents must be provided in full for each `FileAddition`. + +The `contents` of a `FileAddition` must be encoded using RFC 4648 +compliant base64, i.e. correct padding is required and no characters +outside the standard alphabet may be used. Invalid base64 +encoding will be rejected with a validation error. + +The encoded contents may be binary. + +For text files, no assumptions are made about the character encoding of +the file contents (after base64 decoding). No charset transcoding or +line-ending normalization will be performed; it is the client's +responsibility to manage the character encoding of files they provide. +However, for maximum compatibility we recommend using UTF-8 encoding +and ensuring that all files in a repository use a consistent +line-ending convention (`\n` or `\r\n`), and that all files end +with a newline. + +## Modeling file changes + +Each of the the five types of conceptual changes that can be made in a +git commit can be described using the `FileChanges` type as follows: + +1. New file addition: create file `hello world\n` at path `docs/README.txt`: + + { + "additions" [ + { + "path": "docs/README.txt", + "contents": base64encode("hello world\n") + } + ] + } + +2. Existing file modification: change existing `docs/README.txt` to have new + content `new content here\n`: + + { + "additions" [ + { + "path": "docs/README.txt", + "contents": base64encode("new content here\n") + } + ] + } + +3. Existing file deletion: remove existing file `docs/README.txt`. + Note that the path is required to exist -- specifying a + path that does not exist on the given branch will abort the + commit and return an error. + + { + "deletions" [ + { + "path": "docs/README.txt" + } + ] + } + + +4. File rename with no changes: rename `docs/README.txt` with + previous content `hello world\n` to the same content at + `newdocs/README.txt`: + + { + "deletions" [ + { + "path": "docs/README.txt", + } + ], + "additions" [ + { + "path": "newdocs/README.txt", + "contents": base64encode("hello world\n") + } + ] + } + + +5. File rename with changes: rename `docs/README.txt` with + previous content `hello world\n` to a file at path + `newdocs/README.txt` with content `new contents\n`: + + { + "deletions" [ + { + "path": "docs/README.txt", + } + ], + "additions" [ + { + "path": "newdocs/README.txt", + "contents": base64encode("new contents\n") + } + ] + } +""" +input FileChanges { + """ + File to add or change. + """ + additions: [FileAddition!] = [] + + """ + Files to delete. + """ + deletions: [FileDeletion!] = [] +} + +""" +A command to delete the file at the given path as part of a commit. +""" +input FileDeletion { + """ + The path to delete + """ + path: String! +} + """ The possible viewed states of a file . """ @@ -17430,6 +17727,16 @@ type Mutation { input: CancelEnterpriseAdminInvitationInput! ): CancelEnterpriseAdminInvitationPayload + """ + Cancel an active sponsorship. + """ + cancelSponsorship( + """ + Parameters for CancelSponsorship + """ + input: CancelSponsorshipInput! + ): CancelSponsorshipPayload + """ Update your status on GitHub. """ @@ -17540,6 +17847,57 @@ type Mutation { input: CreateCheckSuiteInput! ): CreateCheckSuitePayload + """ + Appends a commit to the given branch as the authenticated user. + + This mutation creates a commit whose parent is the HEAD of the provided + branch and also updates that branch to point to the new commit. + It can be thought of as similar to `git commit`. + + ## Locating a Branch + + Commits are appended to a `branch` of type `Ref`. + This must refer to a git branch (i.e. the fully qualified path must + begin with `refs/heads/`, although including this prefix is optional. + + Callers may specify the `branch` to commit to either by its global node + ID or by passing both of `repositoryNameWithOwner` and `refName`. For + more details see the documentation for `CommittableBranch`. + + ## Describing Changes + + `fileChanges` are specified as a `FilesChanges` object describing + `FileAdditions` and `FileDeletions`. + + Please see the documentation for `FileChanges` for more information on + how to use this argument to describe any set of file changes. + + ## Authorship + + Similar to the web commit interface, this mutation does not support + specifying the author or committer of the commit and will not add + support for this in the future. + + A commit created by a successful execution of this mutation will be + authored by the owner of the credential which authenticates the API + request. The committer will be identical to that of commits authored + using the web interface. + + If you need full control over author and committer information, please + use the Git Database REST API instead. + + ## Commit Signing + + Commits made using this mutation are automatically signed by GitHub if + supported and will be marked as verified in the user interface. + """ + createCommitOnBranch( + """ + Parameters for CreateCommitOnBranch + """ + input: CreateCommitOnBranchInput! + ): CreateCommitOnBranchPayload + """ Create a content attachment. """ @@ -28954,19 +29312,6 @@ type Query { orgLoginForDependencies: String ): SponsorableItemConnection! - """ - Look up a single Sponsors Listing - """ - sponsorsListing( - """ - Select the Sponsors listing which matches this slug - """ - slug: String! - ): SponsorsListing - @deprecated( - reason: "`Query.sponsorsListing` will be removed. Use `Sponsorable.sponsorsListing` instead. Removal on 2020-04-01 UTC." - ) - """ Look up a topic by name. """ diff --git a/data/reusables/apps/oauth-token-limit.md b/data/reusables/apps/oauth-token-limit.md index c38d2156a6..ee6f47c536 100644 --- a/data/reusables/apps/oauth-token-limit.md +++ b/data/reusables/apps/oauth-token-limit.md @@ -1 +1 @@ -There is a limit of ten tokens that are issued per user/application/scope combination. If the application requests enough tokens to go over one of the limits, older tokens _with the same scope being requested_ will stop working. +There is a limit of ten tokens that are issued per user/application/scope combination. If an application creates more than 10 tokens for the same user and the same scopes, the oldest tokens with the same user/application/scope combination will be revoked. \ No newline at end of file diff --git a/data/variables/desktop.yml b/data/variables/desktop.yml index 229d171b48..272ca197af 100644 --- a/data/variables/desktop.yml +++ b/data/variables/desktop.yml @@ -1,5 +1,5 @@ # Supported platforms -mac-osx-versions: macOS 10.10 or later +mac-osx-versions: macOS 10.12 or later windows-versions: Windows 7 64-bit or later diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index 6d5092157e..440ea22616 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,4 +1,29 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Type 'Base64String' was added", + "Type `CancelSponsorshipInput` was added", + "Type `CancelSponsorshipPayload` was added", + "Type `CommitMessage` was added", + "Type `CommittableBranch` was added", + "Type `CreateCommitOnBranchInput` was added", + "Type `CreateCommitOnBranchPayload` was added", + "Type `FileAddition` was added", + "Type `FileChanges` was added", + "Type `FileDeletion` was added", + "Field `cancelSponsorship` was added to object type `Mutation`", + "Field `createCommitOnBranch` was added to object type `Mutation`", + "Field `sponsorsListing` (deprecated) was removed from object type `Query`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-09-09" + }, { "schemaChanges": [ { diff --git a/lib/graphql/static/prerendered-input-objects.json b/lib/graphql/static/prerendered-input-objects.json index afacec54f0..7b2340574b 100644 --- a/lib/graphql/static/prerendered-input-objects.json +++ b/lib/graphql/static/prerendered-input-objects.json @@ -1,6 +1,6 @@ { "dotcom": { - "html": "
\n
\n

\n AcceptEnterpriseAdministratorInvitationInput\n

\n

Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The id of the invitation being accepted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AcceptTopicSuggestionInput\n

\n

Autogenerated input type of AcceptTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of AddEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will receive the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddVerifiableDomainInput\n

\n

Autogenerated input type of AddVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The URL of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner to add the domain to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveVerifiableDomainInput\n

\n

Autogenerated input type of ApproveVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to approve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelEnterpriseAdminInvitationInput\n

\n

Autogenerated input type of CancelEnterpriseAdminInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The Node ID of the pending enterprise administrator invitation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateSponsorshipInput\n

\n

Autogenerated input type of CreateSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

amount (Int)

The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isRecurring (Boolean)

Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy)

Specify whether others should be able to see that the sponsor is sponsoring\nthe sponsorable. Public visibility still does not reveal which tier is used.

\n\n\n\n\n\n\n\n\n\n\n\n

receiveEmails (Boolean)

Whether the sponsor should receive email updates from the sponsorable.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

tierId (ID)

The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeclineTopicSuggestionInput\n

\n

Autogenerated input type of DeclineTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (TopicSuggestionDeclineReason!)

The reason why the suggested topic is declined.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteVerifiableDomainInput\n

\n

Autogenerated input type of DeleteVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationOrder\n

\n

Ordering options for Enterprise Server installation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerInstallationOrderField!)

The field to order Enterprise Server installations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n InviteEnterpriseAdminInput\n

\n

Autogenerated input type of InviteEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise to which you want to invite an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (String)

The login of a user to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateEnterpriseIdentityProviderRecoveryCodesInput\n

\n

Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateVerifiableDomainTokenInput\n

\n

Autogenerated input type of RegenerateVerifiableDomainToken.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of RemoveEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which to remove the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseOrganizationInput\n

\n

Autogenerated input type of RemoveEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which the organization should be removed.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove from the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of RemoveEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will lose the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifierFilter\n

\n

An advisory identifier to filter results on.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (SecurityAdvisoryIdentifierType!)

The identifier type.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier string. Supports exact or partial matching.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryOrder\n

\n

Ordering options for security advisory connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityAdvisoryOrderField!)

The field to order security advisories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityOrder\n

\n

Ordering options for security vulnerability connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityVulnerabilityOrderField!)

The field to order security vulnerabilities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of SetEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethod (SamlDigestAlgorithm!)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

idpCertificate (String!)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm!)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI!)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetOrganizationInteractionLimitInput\n

\n

Autogenerated input type of SetOrganizationInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetRepositoryInteractionLimitInput\n

\n

Autogenerated input type of SetRepositoryInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetUserInteractionLimitInput\n

\n

Autogenerated input type of SetUserInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the user to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorOrder\n

\n

Ordering options for connections to get sponsor entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorOrderField!)

The field to order sponsor entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorableOrder\n

\n

Ordering options for connections to get sponsorable entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorableOrderField!)

The field to order sponsorable entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsActivityOrder\n

\n

Ordering options for GitHub Sponsors activity connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsActivityOrderField!)

The field to order activity by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsTierOrder\n

\n

Ordering options for Sponsors tiers connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsTierOrderField!)

The field to order tiers by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipNewsletterOrder\n

\n

Ordering options for sponsorship newsletter connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipNewsletterOrderField!)

The field to order sponsorship newsletters by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipOrderField!)

The field to order sponsorship by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAdministratorRoleInput\n

\n

Autogenerated input type of UpdateEnterpriseAdministratorRole.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a administrator whose role is being changed.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The new role for the Enterprise administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateNotificationRestrictionSettingInput\n

\n

Autogenerated input type of UpdateNotificationRestrictionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifiableDomainOrder\n

\n

Ordering options for verifiable domain connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifyVerifiableDomainInput\n

\n

Autogenerated input type of VerifyVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to verify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", + "html": "
\n
\n

\n AcceptEnterpriseAdministratorInvitationInput\n

\n

Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The id of the invitation being accepted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AcceptTopicSuggestionInput\n

\n

Autogenerated input type of AcceptTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of AddEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will receive the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddVerifiableDomainInput\n

\n

Autogenerated input type of AddVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The URL of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner to add the domain to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveVerifiableDomainInput\n

\n

Autogenerated input type of ApproveVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to approve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelEnterpriseAdminInvitationInput\n

\n

Autogenerated input type of CancelEnterpriseAdminInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The Node ID of the pending enterprise administrator invitation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelSponsorshipInput\n

\n

Autogenerated input type of CancelSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitMessage\n

\n

A message to include with a new commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the message.

\n\n\n\n\n\n\n\n\n\n\n\n

headline (String!)

The headline of the message.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommittableBranch\n

\n

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchName (String)

The unqualified name of the branch to append the commit to.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCommitOnBranchInput\n

\n

Autogenerated input type of CreateCommitOnBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

fileChanges (FileChanges)

A description of changes to files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

message (CommitMessage!)

The commit message the be included with the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateSponsorshipInput\n

\n

Autogenerated input type of CreateSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

amount (Int)

The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isRecurring (Boolean)

Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy)

Specify whether others should be able to see that the sponsor is sponsoring\nthe sponsorable. Public visibility still does not reveal which tier is used.

\n\n\n\n\n\n\n\n\n\n\n\n

receiveEmails (Boolean)

Whether the sponsor should receive email updates from the sponsorable.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

tierId (ID)

The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeclineTopicSuggestionInput\n

\n

Autogenerated input type of DeclineTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (TopicSuggestionDeclineReason!)

The reason why the suggested topic is declined.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteVerifiableDomainInput\n

\n

Autogenerated input type of DeleteVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationOrder\n

\n

Ordering options for Enterprise Server installation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerInstallationOrderField!)

The field to order Enterprise Server installations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileAddition\n

\n

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contents (Base64String!)

The base64 encoded contents of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the repository where the file will be located.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileChanges\n

\n

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n"additions" [\n{\n"path": "docs/README.txt",\n"contents": base64encode("hello world\\n")\n}\n]\n}

    \n
  2. \n
  3. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  "additions" [\n    {\n      "path": "docs/README.txt",\n      "contents": base64encode("new content here\\n")\n    }\n  ]\n}\n
    \n
  4. \n
  5. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt"\n    }\n  ]\n}\n
    \n
  6. \n
  7. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("hello world\\n")\n    }\n  ]\n}\n
    \n
  8. \n
  9. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("new contents\\n")\n    }\n  ]\n}.\n
    \n
  10. \n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions ([FileAddition!])

File to add or change.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions ([FileDeletion!])

Files to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileDeletion\n

\n

A command to delete the file at the given path as part of a commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

path (String!)

The path to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n InviteEnterpriseAdminInput\n

\n

Autogenerated input type of InviteEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise to which you want to invite an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (String)

The login of a user to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateEnterpriseIdentityProviderRecoveryCodesInput\n

\n

Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateVerifiableDomainTokenInput\n

\n

Autogenerated input type of RegenerateVerifiableDomainToken.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of RemoveEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which to remove the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseOrganizationInput\n

\n

Autogenerated input type of RemoveEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which the organization should be removed.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove from the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of RemoveEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will lose the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifierFilter\n

\n

An advisory identifier to filter results on.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (SecurityAdvisoryIdentifierType!)

The identifier type.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier string. Supports exact or partial matching.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryOrder\n

\n

Ordering options for security advisory connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityAdvisoryOrderField!)

The field to order security advisories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityOrder\n

\n

Ordering options for security vulnerability connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityVulnerabilityOrderField!)

The field to order security vulnerabilities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of SetEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethod (SamlDigestAlgorithm!)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

idpCertificate (String!)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm!)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI!)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetOrganizationInteractionLimitInput\n

\n

Autogenerated input type of SetOrganizationInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetRepositoryInteractionLimitInput\n

\n

Autogenerated input type of SetRepositoryInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetUserInteractionLimitInput\n

\n

Autogenerated input type of SetUserInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the user to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorOrder\n

\n

Ordering options for connections to get sponsor entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorOrderField!)

The field to order sponsor entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorableOrder\n

\n

Ordering options for connections to get sponsorable entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorableOrderField!)

The field to order sponsorable entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsActivityOrder\n

\n

Ordering options for GitHub Sponsors activity connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsActivityOrderField!)

The field to order activity by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsTierOrder\n

\n

Ordering options for Sponsors tiers connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsTierOrderField!)

The field to order tiers by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipNewsletterOrder\n

\n

Ordering options for sponsorship newsletter connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipNewsletterOrderField!)

The field to order sponsorship newsletters by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipOrderField!)

The field to order sponsorship by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAdministratorRoleInput\n

\n

Autogenerated input type of UpdateEnterpriseAdministratorRole.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a administrator whose role is being changed.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The new role for the Enterprise administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateNotificationRestrictionSettingInput\n

\n

Autogenerated input type of UpdateNotificationRestrictionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifiableDomainOrder\n

\n

Ordering options for verifiable domain connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifyVerifiableDomainInput\n

\n

Autogenerated input type of VerifyVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to verify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", "miniToc": [ { "contents": "\n AcceptEnterpriseAdministratorInvitationInput\n ", @@ -107,6 +107,11 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n CancelSponsorshipInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n ChangeUserStatusInput\n ", "headingLevel": 2, @@ -187,6 +192,16 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n CommitMessage\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommittableBranch\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n ContributionOrder\n ", "headingLevel": 2, @@ -217,6 +232,11 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n CreateCommitOnBranchInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n CreateContentAttachmentInput\n ", "headingLevel": 2, @@ -462,6 +482,31 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n FileAddition\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FileChanges\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "Encoding", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "Modeling file changes", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FileDeletion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n FollowUserInput\n ", "headingLevel": 2, @@ -1124,6 +1169,1011 @@ } ] }, + "ghes-3.2": { + "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddVerifiableDomainInput\n

\n

Autogenerated input type of AddVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The URL of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner to add the domain to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveVerifiableDomainInput\n

\n

Autogenerated input type of ApproveVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to approve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteVerifiableDomainInput\n

\n

Autogenerated input type of DeleteVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateVerifiableDomainTokenInput\n

\n

Autogenerated input type of RegenerateVerifiableDomainToken.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateNotificationRestrictionSettingInput\n

\n

Autogenerated input type of UpdateNotificationRestrictionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifiableDomainOrder\n

\n

Ordering options for verifiable domain connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifyVerifiableDomainInput\n

\n

Autogenerated input type of VerifyVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to verify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", + "miniToc": [ + { + "contents": "\n AddAssigneesToAssignableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddDiscussionCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddEnterpriseAdminInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddLabelsToLabelableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddProjectCardInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddProjectColumnInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddPullRequestReviewCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddPullRequestReviewInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddPullRequestReviewThreadInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddReactionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddStarInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddUpvoteInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddVerifiableDomainInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ApproveDeploymentsInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ApproveVerifiableDomainInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ArchiveRepositoryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AuditLogOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ChangeUserStatusInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotationData\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotationRange\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRunAction\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRunFilter\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRunOutput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRunOutputImage\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckSuiteAutoTriggerPreference\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckSuiteFilter\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ClearLabelsFromLabelableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CloneProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CloneTemplateRepositoryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CloseIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ClosePullRequestInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitAuthor\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitContributionOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContributionOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ConvertProjectCardNoteToIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ConvertPullRequestToDraftInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateBranchProtectionRuleInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateCheckRunInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateCheckSuiteInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateContentAttachmentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateDeploymentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateDeploymentStatusInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateDiscussionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateEnterpriseOrganizationInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateEnvironmentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateIpAllowListEntryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateLabelInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatePullRequestInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateRefInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateRepositoryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateTeamDiscussionCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreateTeamDiscussionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteBranchProtectionRuleInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteDeploymentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteDiscussionCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteDiscussionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteEnvironmentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteIpAllowListEntryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteIssueCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteLabelInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeletePackageVersionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteProjectCardInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteProjectColumnInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeletePullRequestReviewCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeletePullRequestReviewInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteRefInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteTeamDiscussionCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteTeamDiscussionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeleteVerifiableDomainInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DisablePullRequestAutoMergeInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DismissPullRequestReviewInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DraftPullRequestReviewComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DraftPullRequestReviewThread\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnablePullRequestAutoMergeInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseAdministratorInvitationOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseMemberOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountEmailOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountsUploadOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FollowUserInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ImportProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IpAllowListEntryOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueCommentOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueFilters\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LabelOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LanguageOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LinkRepositoryToProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LockLockableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MarkDiscussionCommentAsAnswerInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MarkFileAsViewedInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MarkPullRequestReadyForReviewInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MergeBranchInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MergePullRequestInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MilestoneOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MinimizeCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MoveProjectCardInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MoveProjectColumnInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageFileOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageVersionOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectCardImport\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectColumnImport\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactionOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RefOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RefUpdate\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RegenerateVerifiableDomainTokenInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RejectDeploymentsInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReleaseOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveAssigneesFromAssignableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveEnterpriseAdminInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveLabelsFromLabelableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveOutsideCollaboratorInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveReactionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveStarInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemoveUpvoteInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReopenIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReopenPullRequestInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryInvitationOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RequestReviewsInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RerequestCheckSuiteInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ResolveReviewThreadInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SavedReplyOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SponsorshipOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StarOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SubmitPullRequestReviewInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionCommentOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamMemberOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamRepositoryOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TransferIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnarchiveRepositoryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnfollowUserInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnlinkRepositoryFromProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnlockLockableInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnmarkDiscussionCommentAsAnswerInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnmarkFileAsViewedInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnmarkIssueAsDuplicateInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnminimizeCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnpinIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnresolveReviewThreadInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateBranchProtectionRuleInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateCheckRunInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateCheckSuitePreferencesInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateDiscussionCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateDiscussionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseOrganizationProjectsSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseProfileInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseRepositoryProjectsSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseTeamDiscussionsSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateEnvironmentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateIpAllowListEnabledSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateIpAllowListEntryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateIssueCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateIssueInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateLabelInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateNotificationRestrictionSettingInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateProjectCardInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateProjectColumnInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateProjectInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdatePullRequestInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdatePullRequestReviewCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdatePullRequestReviewInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateRefInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateRefsInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateRepositoryInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateSubscriptionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateTeamDiscussionCommentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateTeamDiscussionInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateTeamReviewAssignmentInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UpdateTopicsInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserStatusOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n VerifiableDomainOrder\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n VerifyVerifiableDomainInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + } + ] + }, "ghes-3.1": { "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the default repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the default repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", "miniToc": [ @@ -3720,7 +4770,7 @@ ] }, "ghae": { - "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", + "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitMessage\n

\n

A message to include with a new commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the message.

\n\n\n\n\n\n\n\n\n\n\n\n

headline (String!)

The headline of the message.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommittableBranch\n

\n

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchName (String)

The unqualified name of the branch to append the commit to.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCommitOnBranchInput\n

\n

Autogenerated input type of CreateCommitOnBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

fileChanges (FileChanges)

A description of changes to files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

message (CommitMessage!)

The commit message the be included with the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileAddition\n

\n

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contents (Base64String!)

The base64 encoded contents of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the repository where the file will be located.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileChanges\n

\n

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n"additions" [\n{\n"path": "docs/README.txt",\n"contents": base64encode("hello world\\n")\n}\n]\n}

    \n
  2. \n
  3. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  "additions" [\n    {\n      "path": "docs/README.txt",\n      "contents": base64encode("new content here\\n")\n    }\n  ]\n}\n
    \n
  4. \n
  5. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt"\n    }\n  ]\n}\n
    \n
  6. \n
  7. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("hello world\\n")\n    }\n  ]\n}\n
    \n
  8. \n
  9. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("new contents\\n")\n    }\n  ]\n}.\n
    \n
  10. \n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions ([FileAddition!])

File to add or change.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions ([FileDeletion!])

Files to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileDeletion\n

\n

A command to delete the file at the given path as part of a commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

path (String!)

The path to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", "miniToc": [ { "contents": "\n AddAssigneesToAssignableInput\n ", @@ -3882,6 +4932,16 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n CommitMessage\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommittableBranch\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n ContributionOrder\n ", "headingLevel": 2, @@ -3912,6 +4972,11 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n CreateCommitOnBranchInput\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n CreateContentAttachmentInput\n ", "headingLevel": 2, @@ -4132,6 +5197,31 @@ "headingLevel": 2, "indentationLevel": 0 }, + { + "contents": "\n FileAddition\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FileChanges\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "Encoding", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "Modeling file changes", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FileDeletion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, { "contents": "\n FollowUserInput\n ", "headingLevel": 2, @@ -4663,885 +5753,5 @@ "indentationLevel": 0 } ] - }, - "ghes-3.2": { - "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the default repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the default repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", - "miniToc": [ - { - "contents": "\n AddAssigneesToAssignableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddEnterpriseAdminInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddLabelsToLabelableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddProjectCardInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddProjectColumnInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddPullRequestReviewCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddPullRequestReviewInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddPullRequestReviewThreadInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddReactionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddStarInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ArchiveRepositoryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AuditLogOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ChangeUserStatusInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotationData\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotationRange\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRunAction\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRunFilter\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRunOutput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRunOutputImage\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckSuiteAutoTriggerPreference\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckSuiteFilter\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ClearLabelsFromLabelableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CloneProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CloneTemplateRepositoryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CloseIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ClosePullRequestInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitAuthor\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitContributionOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContributionOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ConvertProjectCardNoteToIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateBranchProtectionRuleInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateCheckRunInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateCheckSuiteInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateContentAttachmentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateDeploymentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateDeploymentStatusInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateEnterpriseOrganizationInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateIpAllowListEntryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateLabelInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatePullRequestInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateRefInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateRepositoryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateTeamDiscussionCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreateTeamDiscussionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteBranchProtectionRuleInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteDeploymentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteIpAllowListEntryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteIssueCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteLabelInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeletePackageVersionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteProjectCardInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteProjectColumnInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeletePullRequestReviewCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeletePullRequestReviewInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteRefInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteTeamDiscussionCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeleteTeamDiscussionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DisablePullRequestAutoMergeInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DismissPullRequestReviewInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DraftPullRequestReviewComment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DraftPullRequestReviewThread\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnablePullRequestAutoMergeInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseAdministratorInvitationOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseMemberOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountEmailOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountsUploadOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n FollowUserInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ImportProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IpAllowListEntryOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueCommentOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueFilters\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LabelOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LanguageOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LinkRepositoryToProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LockLockableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MarkFileAsViewedInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MarkPullRequestReadyForReviewInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MergeBranchInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MergePullRequestInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MilestoneOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MinimizeCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MoveProjectCardInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MoveProjectColumnInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageFileOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageVersionOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectCardImport\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectColumnImport\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReactionOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RefOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RefUpdate\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReleaseOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemoveAssigneesFromAssignableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemoveEnterpriseAdminInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemoveLabelsFromLabelableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemoveOutsideCollaboratorInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemoveReactionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemoveStarInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReopenIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReopenPullRequestInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryInvitationOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RequestReviewsInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RerequestCheckSuiteInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ResolveReviewThreadInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SavedReplyOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SponsorshipOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StarOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SubmitPullRequestReviewInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionCommentOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamMemberOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamRepositoryOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TransferIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnarchiveRepositoryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnfollowUserInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnlinkRepositoryFromProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnlockLockableInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnmarkFileAsViewedInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnmarkIssueAsDuplicateInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnminimizeCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnpinIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnresolveReviewThreadInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateBranchProtectionRuleInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateCheckRunInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateCheckSuitePreferencesInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseOrganizationProjectsSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseProfileInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseRepositoryProjectsSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseTeamDiscussionsSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateIpAllowListEnabledSettingInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateIpAllowListEntryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateIssueCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateIssueInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateLabelInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateProjectCardInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateProjectColumnInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateProjectInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdatePullRequestInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdatePullRequestReviewCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdatePullRequestReviewInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateRefInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateRefsInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateRepositoryInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateSubscriptionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateTeamDiscussionCommentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateTeamDiscussionInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateTeamReviewAssignmentInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UpdateTopicsInput\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserStatusOrder\n ", - "headingLevel": 2, - "indentationLevel": 0 - } - ] } } \ No newline at end of file diff --git a/lib/graphql/static/prerendered-objects.json b/lib/graphql/static/prerendered-objects.json index c02ce6d613..46f21c3739 100644 --- a/lib/graphql/static/prerendered-objects.json +++ b/lib/graphql/static/prerendered-objects.json @@ -2549,6 +2549,2406 @@ } ] }, + "ghes-3.2": { + "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

city (String)

City.

\n\n\n\n\n\n\n\n\n\n\n\n

country (String)

Country name.

\n\n\n\n\n\n\n\n\n\n\n\n

countryCode (String)

Country code.

\n\n\n\n\n\n\n\n\n\n\n\n

region (String)

Region name.

\n\n\n\n\n\n\n\n\n\n\n\n

regionCode (String)

Region or state code.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n App\n

\n

A GitHub App.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses of the app.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI!)

A URL pointing to the app's logo.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

\n\n
\n\n
\n\n\n

name (String!)

The name of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

A slug based on the name of the app for use in URLs.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to the app's homepage.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was assigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who was assigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

disabler (User)

The user who disabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (String)

The reason auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

The commit message of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

The commit title of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledAt (DateTime)

When was this auto-merge request was enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledBy (Actor)

The actor who created the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blame\n

\n

Represents a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BlameRange\n

\n

Represents a range of information from a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit!)

Identifies the line author.

\n\n\n\n\n\n\n\n\n\n\n\n

endingLine (Int!)

The ending line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startingLine (Int!)

The starting line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blob\n

\n

Represents a Git blob.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

byteSize (Int!)

Byte size of Blob object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Indicates whether the contents is truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the Blob is binary.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

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

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRule\n

\n

A branch protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

creator (Actor)

The actor who created this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

repository (Repository)

The repository associated with this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean!)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the branch ref that has conflicting rules.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRuleConflict])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRuleConflict)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CVSS\n

\n

The Common Vulnerability Scoring System.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

score (Float!)

The CVSS score associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

vectorString (String)

The CVSS vector string associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWE\n

\n

A common weakness enumeration.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cweId (String!)

The id of the CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

A detailed description of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEConnection\n

\n

The connection type for CWE.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CWEEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CWE])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CWE)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotation\n

\n

A single check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

\n\n\n\n\n\n\n\n\n\n\n\n

blobUrl (URI!)

The path to the file that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationSpan!)

The position of this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The annotation's message.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Additional information about the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The annotation's title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckAnnotation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckAnnotation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (Int)

Column number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

Line number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n

start (CheckAnnotationPosition!)

Start position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRun\n

\n

A check run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

checkSuite (CheckSuite!)

The check suite that this run is a part of.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

Identifies the date and time when the check run was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment)

The corresponding deployment for this job, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

pullRequestId (ID)

\n

The id of the pull request this is required for.

\n\n
\n\n
\n

pullRequestNumber (Int)

\n

The number of the pull request this is required for.

\n\n
\n\n
\n\n\n

name (String!)

The name of the check for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingDeploymentRequest (DeploymentRequest)

Information about a pending deployment, if any, in this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink to the check run summary.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check run was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

steps (CheckStepConnection)

The check run's steps.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

number (Int)

\n

Step number.

\n\n
\n\n
\n\n\n

summary (String)

A string representing the check run's summary.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

A string representing the check run's text.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

A string representing the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunConnection\n

\n

The connection type for CheckRun.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckRunEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckRun])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckRun)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckStep\n

\n

A single check step.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

completedAt (DateTime)

Identifies the date and time when the check step was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check step.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check step on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The step's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The index of the step in the list of steps of the parent check run.

\n\n\n\n\n\n\n\n\n\n\n\n

secondsToCompletion (Int)

Number of seconds to completion.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check step was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check step.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckStepConnection\n

\n

The connection type for CheckStep.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckStepEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckStep])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckStepEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckStep)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuite\n

\n

A check suite.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App which created this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

branch (Ref)

The name of the branch for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (User)

The user who triggered the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

push (Push)

The push that triggered this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The status of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRun (WorkflowRun)

The workflow run associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckSuiteEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckSuite])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckSuite)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closer (Closer)

Object which triggered the creation of this event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The key for the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The formal name of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI)

The HTTP path for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

The HTTP URL for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Commit\n

\n

Represents a Git commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

associatedPullRequests (PullRequestConnection)

The merged Pull Request that introduced the commit to the repository. If the\ncommit is not present in the default branch, additionally returns open Pull\nRequests associated with the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

\n\n
\n\n
\n\n\n

author (GitActor)

Authorship details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredByCommitter (Boolean!)

Check if the committer and the author match.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredDate (DateTime!)

The datetime when this commit was authored.

\n\n\n\n\n\n\n\n\n\n\n\n

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

blame (Blame!)

Fetches git blame information.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

\n\n
\n\n
\n\n\n

changedFiles (Int!)

The number of changed files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

comments (CommitCommentConnection!)

Comments made on the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

committedDate (DateTime!)

The datetime when this commit was committed.

\n\n\n\n\n\n\n\n\n\n\n\n

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

\n\n\n\n\n\n\n\n\n\n\n\n

committer (GitActor)

Committer details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deployments (DeploymentConnection)

The deployments associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

file (TreeEntry)

The tree entry representing the file located at the given path.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

\n\n
\n\n
\n\n\n

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

\n\n
\n\n
\n\n\n

message (String!)

The Git commit message.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBody (String!)

The Git commit message body.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadline (String!)

The Git commit message headline.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (Organization)

The organization this commit was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n\n

parents (CommitConnection!)

The parents of a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pushedDate (DateTime)

The datetime when this commit was pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (GitSignature)

Commit signing information, if present.

\n\n\n\n\n\n\n\n\n\n\n\n

status (Status)

Status information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n

tree (Tree!)

Commit's root Tree.

\n\n\n\n\n\n\n\n\n\n\n\n

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

treeUrl (URI!)

The HTTP URL for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitComment\n

\n

Represents a comment on a given Commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

Identifies the file path associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

Identifies the line position associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CommitComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CommitComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentThread\n

\n

A thread of comments on a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the commits were made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Commit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitHistoryConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was connected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentAttachment\n

\n

A content attachment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body text of the content attachment. This parameter supports markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentReference\n

\n

A content reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reference (String!)

The reference of the content reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

\n\n\n\n\n\n\n\n\n\n\n\n

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

\n\n\n\n\n\n\n\n\n\n\n\n

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

totalContributions (Int!)

The count of total contributions in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionCount (Int!)

How many contributions were made by the user on this day.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

date (Date!)

The day this square represents.

\n\n\n\n\n\n\n\n\n\n\n\n

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

firstDay (Date!)

The date of the first day of this month.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the month.

\n\n\n\n\n\n\n\n\n\n\n\n

totalWeeks (Int!)

How many weeks started in this month.

\n\n\n\n\n\n\n\n\n\n\n\n

year (Int!)

The year the month occurred in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

\n\n\n\n\n\n\n\n\n\n\n\n

firstDay (Date!)

The date of the earliest square in this week.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

\n\n\n\n\n\n\n\n\n\n\n\n

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

\n\n\n\n\n\n\n\n\n\n\n\n

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

endedAt (DateTime!)

The ending date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

\n\n\n\n\n\n\n\n\n\n\n\n

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

\n\n\n\n\n\n\n\n\n\n\n\n

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

\n\n\n\n\n\n\n\n\n\n\n\n

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

\n\n\n\n\n\n\n\n\n\n\n\n

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

\n\n\n\n\n\n\n\n\n\n\n\n

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime!)

The beginning date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

\n\n\n\n\n\n\n\n\n\n\n\n

totalIssueContributions (Int!)

How many issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestContributions (Int!)

How many pull requests the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoryContributions (Int!)

How many repositories the user created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

user (User!)

The user who made the contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the user made a commit in.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedCommitContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedCommitContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedIssueContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedIssueContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the pull request that the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedRepositoryContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedRepositoryContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

referencedAt (DateTime!)

Identifies when the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKey\n

\n

A repository deploy key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The deploy key.

\n\n\n\n\n\n\n\n\n\n\n\n

readOnly (Boolean!)

Whether or not the deploy key is read only.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The deploy key title.

\n\n\n\n\n\n\n\n\n\n\n\n

verified (Boolean!)

Whether or not the deploy key has been verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeployKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeployKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeployKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

The deployment associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

The ref associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Deployment\n

\n

Represents triggered deployment instance.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The deployment description.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestEnvironment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestStatus (DeploymentStatus)

The latest status of this deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalEnvironment (String)

The original environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

Extra information that a deployment system might need.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentState)

The current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

task (String)

The deployment task.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentConnection\n

\n

The connection type for Deployment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Deployment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Deployment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentProtectionRule\n

\n

A protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers (DeploymentReviewerConnection!)

The teams or users that can review the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

timeout (Int!)

The timeout in minutes for this protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (DeploymentProtectionRuleType!)

The type of protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentProtectionRuleConnection\n

\n

The connection type for DeploymentProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentRequest\n

\n

A request to deploy a workflow run to an environment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

currentUserCanApprove (Boolean!)

Whether or not the current user can approve the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (Environment!)

The target environment of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers (DeploymentReviewerConnection!)

The teams or users that can review the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

waitTimer (Int!)

The wait timer in minutes configured in the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimerStartedAt (DateTime)

The wait timer in minutes configured in the environment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentRequestConnection\n

\n

The connection type for DeploymentRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentReview\n

\n

A deployment review.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comment (String!)

The comment the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

environments (EnvironmentConnection!)

The environments approved or rejected.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (DeploymentReviewState!)

The decision of the user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user that reviewed the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentReviewConnection\n

\n

The connection type for DeploymentReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentReviewerConnection\n

\n

The connection type for DeploymentReviewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentReviewerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentReviewer])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentReviewerEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentReviewer)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

Identifies the deployment associated with status.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

\n\n\n\n\n
\n

Preview notice

\n

environment is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

environmentUrl (URI)

Identifies the environment URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (URI)

Identifies the log URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

Identifies the current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Discussion\n

\n

A discussion in a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

answer (DiscussionComment)

The comment chosen as this discussion's answer, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

answerChosenAt (DateTime)

The time when a user chose this discussion's answer, if answered.

\n\n\n\n\n\n\n\n\n\n\n\n

answerChosenBy (Actor)

The user who chose this discussion's answer, if answered.

\n\n\n\n\n\n\n\n\n\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The main text of the discussion post.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

category (DiscussionCategory!)

The category for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (DiscussionCommentConnection!)

The replies to the discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The number identifying this discussion within the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

upvoteCount (Int!)

Number of upvotes that this subject has received.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpvote (Boolean!)

Whether or not the current user can add or remove an upvote on this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasUpvoted (Boolean!)

Whether or not the current user has already upvoted this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionCategory\n

\n

A category for discussions in a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A description of this category.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String!)

An emoji representing this category.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML!)

This category's emoji rendered as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isAnswerable (Boolean!)

Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this category.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionCategoryConnection\n

\n

The connection type for DiscussionCategory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DiscussionCategoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DiscussionCategory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionCategoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DiscussionCategory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionComment\n

\n

A comment on a discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

The time when this replied-to comment was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (Discussion)

The discussion this comment was created in.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isAnswer (Boolean!)

Has this comment been chosen as the answer of its discussion?.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replies (DiscussionCommentConnection!)

The threaded replies to this comment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

replyTo (DiscussionComment)

The discussion comment this comment is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The path for this discussion comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

upvoteCount (Int!)

Number of upvotes that this subject has received.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL for this discussion comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMarkAsAnswer (Boolean!)

Can the current user mark this comment as an answer?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnmarkAsAnswer (Boolean!)

Can the current user unmark this comment as an answer?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpvote (Boolean!)

Whether or not the current user can add or remove an upvote on this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasUpvoted (Boolean!)

Whether or not the current user has already upvoted this subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionCommentConnection\n

\n

The connection type for DiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionConnection\n

\n

The connection type for Discussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Discussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Discussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membersOnly (Boolean)

\n

Filter to external identities with valid org membership only.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

domains (VerifiableDomainConnection!)

A list of domains owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isApproved (Boolean)

\n

Filter whether or not the domain is approved.

\n\n
\n\n
\n

isVerified (Boolean)

\n

Filter whether or not the domain is verified.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (VerifiableDomainOrder)

\n

Ordering options for verifiable domains returned.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

ipAllowListForInstalledAppsEnabledSetting (IpAllowListForInstalledAppsEnabledSettingValue!)

The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this enterprise is restricted to verified or approved domains.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private or internal.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Environment\n

\n

An environment.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

protectionRules (DeploymentProtectionRuleConnection!)

The protection rules defined for this environment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnvironmentConnection\n

\n

The connection type for Environment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnvironmentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Environment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnvironmentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Environment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean)

Indicates whether or not this issue is currently pinned to the repository issues list.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

titleHTML (String!)

Identifies the issue title rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

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

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

claimant (User)

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

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

domains (VerifiableDomainConnection)

A list of domains owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isApproved (Boolean)

\n

Filter by if the domain is approved.

\n\n
\n\n
\n

isVerified (Boolean)

\n

Filter by if the domain is verified.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (VerifiableDomainOrder)

\n

Ordering options for verifiable domains returned.

\n\n
\n\n
\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

ipAllowListForInstalledAppsEnabledSetting (IpAllowListForInstalledAppsEnabledSettingValue!)

The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this organization is restricted to verified or approved domains.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

repositoryDiscussionComments (DiscussionCommentConnection!)

Discussion comments this user has authored.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

onlyAnswers (Boolean)

\n

Filter discussion comments to only those that were marked as the answer.

\n

The default value is false.

\n
\n\n
\n

repositoryId (ID)

\n

Filter discussion comments to only those in a specific repository.

\n\n
\n\n
\n\n\n

repositoryDiscussions (DiscussionConnection!)

Discussions this user has started.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

answered (Boolean)

\n

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DiscussionOrder)

\n

Ordering options for discussions returned from the connection.

\n\n
\n\n
\n

repositoryId (ID)

\n

Filter discussions to only those in a specific repository.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membersOnly (Boolean)

\n

Filter to external identities with valid org membership only.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Package\n

\n

Information for an uploaded package.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

latestVersion (PackageVersion)

Find the latest version for the package.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the name of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

packageType (PackageType!)

Identifies the type of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository this package belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Find package version by version string.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

version (String!)

\n

The package version.

\n\n
\n\n
\n\n\n

versions (PackageVersionConnection!)

list of versions for this package.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageVersionOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageConnection\n

\n

The connection type for Package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Package])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Package)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFile\n

\n

A file in a package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

md5 (String)

MD5 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Name of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersion (PackageVersion)

The package version this file belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

sha1 (String)

SHA1 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

sha256 (String)

SHA256 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

Size of the file in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to download the asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileConnection\n

\n

The connection type for PackageFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageStatistics\n

\n

Represents a object that contains package activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageTag\n

\n

A version tag contains the mapping between a tag name and a version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

Identifies the tag name of the version.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Version that the tag is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersion\n

\n

Information about a specific package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

files (PackageFileConnection!)

List of files associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageFileOrder)

\n

Ordering of the returned package files.

\n\n
\n\n
\n\n\n

package (Package)

The package associated with this version.

\n\n\n\n\n\n\n\n\n\n\n\n

platform (String)

The platform this version was built for.

\n\n\n\n\n\n\n\n\n\n\n\n

preRelease (Boolean!)

Whether or not this version is a pre-release.

\n\n\n\n\n\n\n\n\n\n\n\n

readme (String)

The README of this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

The release associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageVersionStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

The package version summary.

\n\n\n\n\n\n\n\n\n\n\n\n

version (String!)

The version string.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionConnection\n

\n

The connection type for PackageVersion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageVersionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageVersion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageVersion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionStatistics\n

\n

Represents a object that contains package version activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedDiscussion\n

\n

A Pinned Discussion is a discussion pinned to a repository's index page.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (Discussion!)

The discussion that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

gradientStopColors ([String!]!)

Color stops of the chosen gradient.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (PinnedDiscussionPattern!)

Background texture pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

preconfiguredGradient (PinnedDiscussionGradient)

Preconfigured background gradient option.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedDiscussionConnection\n

\n

The connection type for PinnedDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closingIssuesReferences (IssueConnection)

List of issues that were may be closed by this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

titleHTML (HTML!)

Identifies the pull request title rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerLatestReview (PullRequestReview)

The latest review given from the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerLatestReviewRequest (ReviewRequest)

The person who has requested the viewer for review on this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTemplate\n

\n

A repository pull request template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

filename (String)

The filename of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the template belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

reactors (ReactorConnection!)

Reactors to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

users is deprecated.

Reactors can now be mannequins, bots, and organizations. Use the reactors field instead. Removal on 2021-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactorConnection\n

\n

The connection type for Reactor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reactor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactorEdge\n

\n

Represents an author of a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reactor!)

The author of the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean!)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerAllowedToDismissReviews (Boolean!)

Is the viewer allowed to dismiss reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

mentions (UserConnection)

A list of users mentioned in the release description.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagCommit (Commit)

The tag commit for this release.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (Discussion)

Returns a single discussion from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the discussion to be returned.

\n\n
\n\n
\n\n\n

discussionCategories (DiscussionCategoryConnection!)

A list of discussion categories that are available in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

discussions (DiscussionConnection!)

A list of discussions that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

categoryId (ID)

\n

Only include discussions that belong to the category with this ID.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DiscussionOrder)

\n

Ordering options for discussions returned from the connection.

\n\n
\n\n
\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (Environment)

Returns a single active environment from the current repository by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The name of the environment to be returned.

\n\n
\n\n
\n\n\n

environments (EnvironmentConnection!)

A list of environments that are in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private or internal.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedDiscussions (PinnedDiscussionConnection!)

A list of discussions that have been pinned in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequestTemplates ([PullRequestTemplate!])

Returns a list of pull request templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A Dependabot alert for a repository with a dependency affected by a security vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionCount (Int!)

The number of discussions that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
  • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
  • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
  • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
  • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
  • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isOneTimePayment (Boolean!)

Whether this sponsorship represents a one-time payment versus a recurring sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n

tierSelectedAt (DateTime)

Identifies the date and time when the current tier was chosen for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

pullRequestId (ID)

\n

The id of the pull request this is required for.

\n\n
\n\n
\n

pullRequestNumber (Int)

\n

The number of the pull request this is required for.

\n\n
\n\n
\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

canReceiveOrganizationEmailsWhenNotificationsRestricted (Boolean!)

Could this user receive email notifications, if the organization had notification restrictions enabled?.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to check.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to (including) this time will be\ncounted. If omitted, defaults to the current time or one year from the\nprovided from argument.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isGitHubStar (Boolean!)

Whether or not this user is a member of the GitHub Stars Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

repositoryDiscussionComments (DiscussionCommentConnection!)

Discussion comments this user has authored.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

onlyAnswers (Boolean)

\n

Filter discussion comments to only those that were marked as the answer.

\n

The default value is false.

\n
\n\n
\n

repositoryId (ID)

\n

Filter discussion comments to only those in a specific repository.

\n\n
\n\n
\n\n\n

repositoryDiscussions (DiscussionConnection!)

Discussions this user has started.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

answered (Boolean)

\n

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DiscussionOrder)

\n

Ordering options for discussions returned from the connection.

\n\n
\n\n
\n

repositoryId (ID)

\n

Filter discussions to only those in a specific repository.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

suspendedAt (DateTime)

Identifies the date and time when the user was suspended.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified or approved for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isApproved (Boolean!)

Whether or not the domain is approved.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomainConnection\n

\n

The connection type for VerifiableDomain.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([VerifiableDomainEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([VerifiableDomain])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomainEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (VerifiableDomain)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Workflow\n

\n

A workflow contains meta information about an Actions workflow file.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the workflow.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n WorkflowRun\n

\n

A workflow run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuite (CheckSuite!)

The check suite this workflow run belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentReviews (DeploymentReviewConnection!)

The log of deployment reviews.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pendingDeploymentRequests (DeploymentRequestConnection!)

The pending deployment requests of all check runs in this workflow run.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this workflow run.

\n\n\n\n\n\n\n\n\n\n\n\n

runNumber (Int!)

A number that uniquely identifies this workflow run in its parent workflow.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this workflow run.

\n\n\n\n\n\n\n\n\n\n\n\n

workflow (Workflow!)

The workflow executed in this workflow run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", + "miniToc": [ + { + "contents": "\n ActorLocation\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AddedToProjectEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n App\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AssignedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutoMergeDisabledEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutoMergeEnabledEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutoMergeRequest\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutoRebaseEnabledEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutoSquashEnabledEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutomaticBaseChangeFailedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n AutomaticBaseChangeSucceededEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BaseRefChangedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BaseRefDeletedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BaseRefForcePushedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Blame\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BlameRange\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Blob\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Bot\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BranchProtectionRule\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BranchProtectionRuleConflict\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BranchProtectionRuleConflictConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BranchProtectionRuleConflictEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BranchProtectionRuleConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n BranchProtectionRuleEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CVSS\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CWE\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CWEConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CWEEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotation\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotationConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotationEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotationPosition\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckAnnotationSpan\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRun\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRunConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckRunEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckStep\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckStepConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckStepEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckSuite\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckSuiteConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CheckSuiteEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ClosedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CodeOfConduct\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommentDeletedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Commit\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitCommentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitCommentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitCommentThread\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitContributionsByRepository\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CommitHistoryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ConnectedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContentAttachment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContentReference\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContributionCalendar\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContributionCalendarDay\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContributionCalendarMonth\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContributionCalendarWeek\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ContributionsCollection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ConvertToDraftEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ConvertedNoteToIssueEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedCommitContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedCommitContributionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedCommitContributionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedIssueContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedIssueContributionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedIssueContributionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedPullRequestContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedPullRequestContributionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedPullRequestContributionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedPullRequestReviewContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedPullRequestReviewContributionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedPullRequestReviewContributionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedRepositoryContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedRepositoryContributionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CreatedRepositoryContributionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n CrossReferencedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DemilestonedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeployKey\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeployKeyConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeployKeyEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeployedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Deployment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentEnvironmentChangedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentProtectionRule\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentProtectionRuleConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentProtectionRuleEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentRequest\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentRequestConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentRequestEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentReview\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentReviewConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentReviewEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentReviewerConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentReviewerEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentStatus\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentStatusConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DeploymentStatusEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DisconnectedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Discussion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionCategory\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionCategoryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionCategoryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionCommentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionCommentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n DiscussionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Enterprise\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseAdministratorConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseAdministratorEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseAdministratorInvitation\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseAdministratorInvitationConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseAdministratorInvitationEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseBillingInfo\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseIdentityProvider\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseMemberConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseMemberEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseOrganizationMembershipConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseOrganizationMembershipEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseOutsideCollaboratorConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseOutsideCollaboratorEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseOwnerInfo\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterprisePendingCollaboratorConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterprisePendingCollaboratorEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterprisePendingMemberInvitationConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterprisePendingMemberInvitationEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseRepositoryInfo\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseRepositoryInfoConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseRepositoryInfoEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerInstallation\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccount\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountEmail\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountEmailConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountEmailEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountsUpload\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountsUploadConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseServerUserAccountsUploadEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseUserAccount\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseUserAccountConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnterpriseUserAccountEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Environment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnvironmentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n EnvironmentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ExternalIdentity\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ExternalIdentityConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ExternalIdentityEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ExternalIdentitySamlAttributes\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ExternalIdentityScimAttributes\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FollowerConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n FollowingConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GenericHovercardContext\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Gist\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistCommentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistCommentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GistFile\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GitActor\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GitActorConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GitActorEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GitHubMetadata\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n GpgSignature\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n HeadRefDeletedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n HeadRefForcePushedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n HeadRefRestoredEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Hovercard\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IpAllowListEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IpAllowListEntryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IpAllowListEntryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Issue\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueCommentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueCommentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueContributionsByRepository\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueTemplate\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueTimelineConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueTimelineItemEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueTimelineItemsConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n IssueTimelineItemsEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n JoinedGitHubContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Label\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LabelConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LabelEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LabeledEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Language\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LanguageConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LanguageEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n License\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LicenseRule\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n LockedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Mannequin\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MarkedAsDuplicateEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MembersCanDeleteReposClearAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MembersCanDeleteReposDisableAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MembersCanDeleteReposEnableAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MentionedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MergedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Milestone\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MilestoneConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MilestoneEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MilestonedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n MovedColumnsInProjectEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OauthApplicationCreateAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgAddBillingManagerAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgAddMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgBlockUserAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgCreateAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgDisableOauthAppRestrictionsAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgDisableSamlAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgDisableTwoFactorRequirementAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgEnableOauthAppRestrictionsAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgEnableSamlAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgEnableTwoFactorRequirementAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgInviteMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgInviteToBusinessAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgOauthAppAccessApprovedAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgOauthAppAccessDeniedAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgOauthAppAccessRequestedAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRemoveBillingManagerAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRemoveMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRemoveOutsideCollaboratorAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRestoreMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgRestoreMemberMembershipTeamAuditEntryData\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgUnblockUserAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgUpdateMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Organization\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationAuditEntryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationAuditEntryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationIdentityProvider\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationInvitation\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationInvitationConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationInvitationEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationMemberConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationMemberEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationTeamsHovercardContext\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n OrganizationsHovercardContext\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Package\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageFile\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageFileConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageFileEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageStatistics\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageTag\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageVersion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageVersionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageVersionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PackageVersionStatistics\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PageInfo\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PermissionSource\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnableItemConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnableItemEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedDiscussion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedDiscussionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedDiscussionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedIssue\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedIssueConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PinnedIssueEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PrivateRepositoryForkingDisableAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PrivateRepositoryForkingEnableAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProfileItemShowcase\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Project\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectCard\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectCardConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectCardEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectColumn\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectColumnConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectColumnEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ProjectProgress\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PublicKey\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PublicKeyConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PublicKeyEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequest\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestChangedFile\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestChangedFileConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestChangedFileEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestCommit\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestCommitCommentThread\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestCommitConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestCommitEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestContributionsByRepository\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReview\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewCommentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewCommentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewContributionsByRepository\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewThread\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewThreadConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestReviewThreadEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestRevisionMarker\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestTemplate\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestTimelineConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestTimelineItemEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestTimelineItemsConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PullRequestTimelineItemsEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Push\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PushAllowance\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PushAllowanceConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n PushAllowanceEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RateLimit\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactingUserConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactingUserEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Reaction\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactionGroup\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactorConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReactorEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReadyForReviewEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Ref\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RefConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RefEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RefUpdateRule\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReferencedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Release\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReleaseAsset\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReleaseAssetConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReleaseAssetEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReleaseConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReleaseEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RemovedFromProjectEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RenamedTitleEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReopenedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoAccessAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoAddMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoAddTopicAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoArchivedAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoChangeMergeSettingAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigDisableAnonymousGitAccessAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigDisableContributorsOnlyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigEnableAnonymousGitAccessAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigEnableContributorsOnlyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigLockAnonymousGitAccessAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoCreateAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoDestroyAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoRemoveMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepoRemoveTopicAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Repository\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryCollaboratorConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryCollaboratorEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryContactLink\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryInvitation\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryInvitationConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryInvitationEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryTopic\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryTopicConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryTopicEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryVisibilityChangeDisableAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryVisibilityChangeEnableAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryVulnerabilityAlert\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryVulnerabilityAlertConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RepositoryVulnerabilityAlertEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n RestrictedContribution\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewDismissalAllowance\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewDismissalAllowanceConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewDismissalAllowanceEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewDismissedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewRequest\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewRequestConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewRequestEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewRequestRemovedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewRequestedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ReviewStatusHovercardContext\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SavedReply\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SavedReplyConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SavedReplyEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SearchResultItemConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SearchResultItemEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisory\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisoryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisoryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisoryIdentifier\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisoryPackage\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisoryPackageVersion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityAdvisoryReference\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityVulnerability\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityVulnerabilityConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SecurityVulnerabilityEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SmimeSignature\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Sponsorship\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SponsorshipConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SponsorshipEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StargazerConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StargazerEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StarredRepositoryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StarredRepositoryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Status\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StatusCheckRollup\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StatusCheckRollupContextConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StatusCheckRollupContextEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n StatusContext\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Submodule\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SubmoduleConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SubmoduleEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SubscribedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n SuggestedReviewer\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Tag\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Team\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamAddMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamAddRepositoryAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamChangeParentTeamAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussion\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionComment\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionCommentConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionCommentEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamDiscussionEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamMemberConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamMemberEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamRemoveMemberAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamRemoveRepositoryAuditEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamRepositoryConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TeamRepositoryEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TextMatch\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TextMatchHighlight\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Topic\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TransferredEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Tree\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n TreeEntry\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnassignedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnknownSignature\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnlabeledEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnlockedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnmarkedAsDuplicateEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnpinnedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UnsubscribedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n User\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserBlockedEvent\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserContentEdit\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserContentEditConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserContentEditEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserEmailMetadata\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserStatus\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserStatusConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n UserStatusEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n VerifiableDomain\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n VerifiableDomainConnection\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n VerifiableDomainEdge\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n ViewerHovercardContext\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n Workflow\n ", + "headingLevel": 2, + "indentationLevel": 0 + }, + { + "contents": "\n WorkflowRun\n ", + "headingLevel": 2, + "indentationLevel": 0 + } + ] + }, "ghes-3.1": { "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

city (String)

City.

\n\n\n\n\n\n\n\n\n\n\n\n

country (String)

Country name.

\n\n\n\n\n\n\n\n\n\n\n\n

countryCode (String)

Country code.

\n\n\n\n\n\n\n\n\n\n\n\n

region (String)

Region name.

\n\n\n\n\n\n\n\n\n\n\n\n

regionCode (String)

Region or state code.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n App\n

\n

A GitHub App.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI!)

A URL pointing to the app's logo.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

\n\n
\n\n
\n\n\n

name (String!)

The name of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

A slug based on the name of the app for use in URLs.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to the app's homepage.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was assigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who was assigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

disabler (User)

The user who disabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (String)

The reason auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

The commit message of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

The commit title of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledAt (DateTime)

When was this auto-merge request was enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledBy (Actor)

The actor who created the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blame\n

\n

Represents a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BlameRange\n

\n

Represents a range of information from a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit!)

Identifies the line author.

\n\n\n\n\n\n\n\n\n\n\n\n

endingLine (Int!)

The ending line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startingLine (Int!)

The starting line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blob\n

\n

Represents a Git blob.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

byteSize (Int!)

Byte size of Blob object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Indicates whether the contents is truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the Blob is binary.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

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

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRule\n

\n

A branch protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

creator (Actor)

The actor who created this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

repository (Repository)

The repository associated with this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the branch ref that has conflicting rules.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRuleConflict])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRuleConflict)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CVSS\n

\n

The Common Vulnerability Scoring System.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

score (Float!)

The CVSS score associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

vectorString (String)

The CVSS vector string associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWE\n

\n

A common weakness enumeration.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cweId (String!)

The id of the CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

A detailed description of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEConnection\n

\n

The connection type for CWE.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CWEEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CWE])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CWE)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotation\n

\n

A single check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

\n\n\n\n\n\n\n\n\n\n\n\n

blobUrl (URI!)

The path to the file that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationSpan!)

The position of this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The annotation's message.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Additional information about the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The annotation's title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckAnnotation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckAnnotation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (Int)

Column number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

Line number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n

start (CheckAnnotationPosition!)

Start position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRun\n

\n

A check run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

checkSuite (CheckSuite!)

The check suite that this run is a part of.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

Identifies the date and time when the check run was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink to the check run summary.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check run was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

A string representing the check run's summary.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

A string representing the check run's text.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

A string representing the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunConnection\n

\n

The connection type for CheckRun.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckRunEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckRun])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckRun)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuite\n

\n

A check suite.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App which created this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

branch (Ref)

The name of the branch for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

push (Push)

The push that triggered this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The status of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckSuiteEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckSuite])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckSuite)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closer (Closer)

Object which triggered the creation of this event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The key for the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The formal name of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI)

The HTTP path for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

The HTTP URL for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Commit\n

\n

Represents a Git commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

\n\n
\n\n
\n\n\n

author (GitActor)

Authorship details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredByCommitter (Boolean!)

Check if the committer and the author match.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredDate (DateTime!)

The datetime when this commit was authored.

\n\n\n\n\n\n\n\n\n\n\n\n

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

blame (Blame!)

Fetches git blame information.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

\n\n
\n\n
\n\n\n

changedFiles (Int!)

The number of changed files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

comments (CommitCommentConnection!)

Comments made on the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

committedDate (DateTime!)

The datetime when this commit was committed.

\n\n\n\n\n\n\n\n\n\n\n\n

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

\n\n\n\n\n\n\n\n\n\n\n\n

committer (GitActor)

Committer details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deployments (DeploymentConnection)

The deployments associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

file (TreeEntry)

The tree entry representing the file located at the given path.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

\n\n
\n\n
\n\n\n

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

\n\n
\n\n
\n\n\n

message (String!)

The Git commit message.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBody (String!)

The Git commit message body.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadline (String!)

The Git commit message headline.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (Organization)

The organization this commit was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n\n

parents (CommitConnection!)

The parents of a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pushedDate (DateTime)

The datetime when this commit was pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (GitSignature)

Commit signing information, if present.

\n\n\n\n\n\n\n\n\n\n\n\n

status (Status)

Status information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n

tree (Tree!)

Commit's root Tree.

\n\n\n\n\n\n\n\n\n\n\n\n

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

treeUrl (URI!)

The HTTP URL for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitComment\n

\n

Represents a comment on a given Commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

Identifies the file path associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

Identifies the line position associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CommitComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CommitComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentThread\n

\n

A thread of comments on a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the commits were made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Commit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitHistoryConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was connected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentAttachment\n

\n

A content attachment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body text of the content attachment. This parameter supports markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentReference\n

\n

A content reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reference (String!)

The reference of the content reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

\n\n\n\n\n\n\n\n\n\n\n\n

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

\n\n\n\n\n\n\n\n\n\n\n\n

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

totalContributions (Int!)

The count of total contributions in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionCount (Int!)

How many contributions were made by the user on this day.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

date (Date!)

The day this square represents.

\n\n\n\n\n\n\n\n\n\n\n\n

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

firstDay (Date!)

The date of the first day of this month.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the month.

\n\n\n\n\n\n\n\n\n\n\n\n

totalWeeks (Int!)

How many weeks started in this month.

\n\n\n\n\n\n\n\n\n\n\n\n

year (Int!)

The year the month occurred in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

\n\n\n\n\n\n\n\n\n\n\n\n

firstDay (Date!)

The date of the earliest square in this week.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

\n\n\n\n\n\n\n\n\n\n\n\n

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

\n\n\n\n\n\n\n\n\n\n\n\n

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

endedAt (DateTime!)

The ending date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

\n\n\n\n\n\n\n\n\n\n\n\n

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

\n\n\n\n\n\n\n\n\n\n\n\n

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

\n\n\n\n\n\n\n\n\n\n\n\n

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

\n\n\n\n\n\n\n\n\n\n\n\n

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

\n\n\n\n\n\n\n\n\n\n\n\n

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime!)

The beginning date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

\n\n\n\n\n\n\n\n\n\n\n\n

totalIssueContributions (Int!)

How many issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestContributions (Int!)

How many pull requests the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoryContributions (Int!)

How many repositories the user created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

user (User!)

The user who made the contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the user made a commit in.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedCommitContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedCommitContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedIssueContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedIssueContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the pull request that the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedRepositoryContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedRepositoryContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

referencedAt (DateTime!)

Identifies when the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKey\n

\n

A repository deploy key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The deploy key.

\n\n\n\n\n\n\n\n\n\n\n\n

readOnly (Boolean!)

Whether or not the deploy key is read only.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The deploy key title.

\n\n\n\n\n\n\n\n\n\n\n\n

verified (Boolean!)

Whether or not the deploy key has been verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeployKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeployKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeployKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

The deployment associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

The ref associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Deployment\n

\n

Represents triggered deployment instance.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The deployment description.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestEnvironment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestStatus (DeploymentStatus)

The latest status of this deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalEnvironment (String)

The original environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

Extra information that a deployment system might need.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentState)

The current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

task (String)

The deployment task.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentConnection\n

\n

The connection type for Deployment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Deployment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Deployment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

Identifies the deployment associated with status.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

\n\n\n\n\n
\n

Preview notice

\n

environment is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

environmentUrl (URI)

Identifies the environment URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (URI)

Identifies the log URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

Identifies the current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean)

Indicates whether or not this issue is currently pinned to the repository issues list.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues or Milestones with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

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

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website, always false on Enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Package\n

\n

Information for an uploaded package.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

latestVersion (PackageVersion)

Find the latest version for the package.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the name of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

packageType (PackageType!)

Identifies the type of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository this package belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Find package version by version string.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

version (String!)

\n

The package version.

\n\n
\n\n
\n\n\n

versions (PackageVersionConnection!)

list of versions for this package.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageVersionOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageConnection\n

\n

The connection type for Package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Package])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Package)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFile\n

\n

A file in a package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

md5 (String)

MD5 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Name of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersion (PackageVersion)

The package version this file belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

sha1 (String)

SHA1 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

sha256 (String)

SHA256 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

Size of the file in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to download the asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileConnection\n

\n

The connection type for PackageFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageStatistics\n

\n

Represents a object that contains package activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageTag\n

\n

A version tag contains the mapping between a tag name and a version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

Identifies the tag name of the version.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Version that the tag is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersion\n

\n

Information about a specific package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

files (PackageFileConnection!)

List of files associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageFileOrder)

\n

Ordering of the returned package files.

\n\n
\n\n
\n\n\n

package (Package)

The package associated with this version.

\n\n\n\n\n\n\n\n\n\n\n\n

platform (String)

The platform this version was built for.

\n\n\n\n\n\n\n\n\n\n\n\n

preRelease (Boolean!)

Whether or not this version is a pre-release.

\n\n\n\n\n\n\n\n\n\n\n\n

readme (String)

The README of this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

The release associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageVersionStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

The package version summary.

\n\n\n\n\n\n\n\n\n\n\n\n

version (String!)

The version string.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionConnection\n

\n

The connection type for PackageVersion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageVersionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageVersion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageVersion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionStatistics\n

\n

Represents a object that contains package version activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closingIssuesReferences (IssueConnection)

List of issues that were may be closed by this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagCommit (Commit)

The tag commit for this release.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A alert for a repository with an affected vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
  • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
  • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
  • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
  • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
  • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isGitHubStar (Boolean!)

Whether or not this user is a member of the GitHub Stars Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

suspendedAt (DateTime)

Identifies the date and time when the user was suspended.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", "miniToc": [ @@ -11368,2225 +13768,5 @@ "indentationLevel": 0 } ] - }, - "ghes-3.2": { - "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

city (String)

City.

\n\n\n\n\n\n\n\n\n\n\n\n

country (String)

Country name.

\n\n\n\n\n\n\n\n\n\n\n\n

countryCode (String)

Country code.

\n\n\n\n\n\n\n\n\n\n\n\n

region (String)

Region name.

\n\n\n\n\n\n\n\n\n\n\n\n

regionCode (String)

Region or state code.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n App\n

\n

A GitHub App.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI!)

A URL pointing to the app's logo.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

\n\n
\n\n
\n\n\n

name (String!)

The name of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

A slug based on the name of the app for use in URLs.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to the app's homepage.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was assigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who was assigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

disabler (User)

The user who disabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (String)

The reason auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

The commit message of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

The commit title of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledAt (DateTime)

When was this auto-merge request was enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledBy (Actor)

The actor who created the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blame\n

\n

Represents a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BlameRange\n

\n

Represents a range of information from a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit!)

Identifies the line author.

\n\n\n\n\n\n\n\n\n\n\n\n

endingLine (Int!)

The ending line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startingLine (Int!)

The starting line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blob\n

\n

Represents a Git blob.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

byteSize (Int!)

Byte size of Blob object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Indicates whether the contents is truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the Blob is binary.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

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

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRule\n

\n

A branch protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

creator (Actor)

The actor who created this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

repository (Repository)

The repository associated with this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the branch ref that has conflicting rules.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRuleConflict])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRuleConflict)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CVSS\n

\n

The Common Vulnerability Scoring System.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

score (Float!)

The CVSS score associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

vectorString (String)

The CVSS vector string associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWE\n

\n

A common weakness enumeration.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cweId (String!)

The id of the CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

A detailed description of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEConnection\n

\n

The connection type for CWE.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CWEEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CWE])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CWE)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotation\n

\n

A single check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

\n\n\n\n\n\n\n\n\n\n\n\n

blobUrl (URI!)

The path to the file that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationSpan!)

The position of this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The annotation's message.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Additional information about the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The annotation's title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckAnnotation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckAnnotation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (Int)

Column number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

Line number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n

start (CheckAnnotationPosition!)

Start position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRun\n

\n

A check run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

checkSuite (CheckSuite!)

The check suite that this run is a part of.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

Identifies the date and time when the check run was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink to the check run summary.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check run was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

A string representing the check run's summary.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

A string representing the check run's text.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

A string representing the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunConnection\n

\n

The connection type for CheckRun.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckRunEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckRun])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckRun)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuite\n

\n

A check suite.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App which created this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

branch (Ref)

The name of the branch for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

push (Push)

The push that triggered this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The status of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckSuiteEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckSuite])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckSuite)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closer (Closer)

Object which triggered the creation of this event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The key for the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The formal name of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI)

The HTTP path for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

The HTTP URL for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Commit\n

\n

Represents a Git commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

\n\n
\n\n
\n\n\n

author (GitActor)

Authorship details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredByCommitter (Boolean!)

Check if the committer and the author match.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredDate (DateTime!)

The datetime when this commit was authored.

\n\n\n\n\n\n\n\n\n\n\n\n

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

blame (Blame!)

Fetches git blame information.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

\n\n
\n\n
\n\n\n

changedFiles (Int!)

The number of changed files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

comments (CommitCommentConnection!)

Comments made on the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

committedDate (DateTime!)

The datetime when this commit was committed.

\n\n\n\n\n\n\n\n\n\n\n\n

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

\n\n\n\n\n\n\n\n\n\n\n\n

committer (GitActor)

Committer details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deployments (DeploymentConnection)

The deployments associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

file (TreeEntry)

The tree entry representing the file located at the given path.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

\n\n
\n\n
\n\n\n

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

\n\n
\n\n
\n\n\n

message (String!)

The Git commit message.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBody (String!)

The Git commit message body.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadline (String!)

The Git commit message headline.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (Organization)

The organization this commit was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n\n

parents (CommitConnection!)

The parents of a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pushedDate (DateTime)

The datetime when this commit was pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (GitSignature)

Commit signing information, if present.

\n\n\n\n\n\n\n\n\n\n\n\n

status (Status)

Status information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n

tree (Tree!)

Commit's root Tree.

\n\n\n\n\n\n\n\n\n\n\n\n

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

treeUrl (URI!)

The HTTP URL for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitComment\n

\n

Represents a comment on a given Commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

Identifies the file path associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

Identifies the line position associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CommitComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CommitComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentThread\n

\n

A thread of comments on a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the commits were made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Commit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitHistoryConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was connected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentAttachment\n

\n

A content attachment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body text of the content attachment. This parameter supports markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentReference\n

\n

A content reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reference (String!)

The reference of the content reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

\n\n\n\n\n\n\n\n\n\n\n\n

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

\n\n\n\n\n\n\n\n\n\n\n\n

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

totalContributions (Int!)

The count of total contributions in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionCount (Int!)

How many contributions were made by the user on this day.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

date (Date!)

The day this square represents.

\n\n\n\n\n\n\n\n\n\n\n\n

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

firstDay (Date!)

The date of the first day of this month.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the month.

\n\n\n\n\n\n\n\n\n\n\n\n

totalWeeks (Int!)

How many weeks started in this month.

\n\n\n\n\n\n\n\n\n\n\n\n

year (Int!)

The year the month occurred in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

\n\n\n\n\n\n\n\n\n\n\n\n

firstDay (Date!)

The date of the earliest square in this week.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

\n\n\n\n\n\n\n\n\n\n\n\n

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

\n\n\n\n\n\n\n\n\n\n\n\n

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

endedAt (DateTime!)

The ending date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

\n\n\n\n\n\n\n\n\n\n\n\n

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

\n\n\n\n\n\n\n\n\n\n\n\n

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

\n\n\n\n\n\n\n\n\n\n\n\n

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

\n\n\n\n\n\n\n\n\n\n\n\n

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

\n\n\n\n\n\n\n\n\n\n\n\n

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime!)

The beginning date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

\n\n\n\n\n\n\n\n\n\n\n\n

totalIssueContributions (Int!)

How many issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestContributions (Int!)

How many pull requests the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoryContributions (Int!)

How many repositories the user created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

user (User!)

The user who made the contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the user made a commit in.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedCommitContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedCommitContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedIssueContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedIssueContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the pull request that the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedRepositoryContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedRepositoryContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

referencedAt (DateTime!)

Identifies when the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKey\n

\n

A repository deploy key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The deploy key.

\n\n\n\n\n\n\n\n\n\n\n\n

readOnly (Boolean!)

Whether or not the deploy key is read only.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The deploy key title.

\n\n\n\n\n\n\n\n\n\n\n\n

verified (Boolean!)

Whether or not the deploy key has been verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeployKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeployKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeployKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

The deployment associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

The ref associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Deployment\n

\n

Represents triggered deployment instance.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The deployment description.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestEnvironment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestStatus (DeploymentStatus)

The latest status of this deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalEnvironment (String)

The original environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

Extra information that a deployment system might need.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentState)

The current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

task (String)

The deployment task.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentConnection\n

\n

The connection type for Deployment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Deployment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Deployment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

Identifies the deployment associated with status.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

\n\n\n\n\n
\n

Preview notice

\n

environment is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

environmentUrl (URI)

Identifies the environment URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (URI)

Identifies the log URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

Identifies the current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean)

Indicates whether or not this issue is currently pinned to the repository issues list.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues or Milestones with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

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

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website, always false on Enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Package\n

\n

Information for an uploaded package.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

latestVersion (PackageVersion)

Find the latest version for the package.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the name of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

packageType (PackageType!)

Identifies the type of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository this package belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Find package version by version string.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

version (String!)

\n

The package version.

\n\n
\n\n
\n\n\n

versions (PackageVersionConnection!)

list of versions for this package.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageVersionOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageConnection\n

\n

The connection type for Package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Package])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Package)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFile\n

\n

A file in a package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

md5 (String)

MD5 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Name of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersion (PackageVersion)

The package version this file belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

sha1 (String)

SHA1 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

sha256 (String)

SHA256 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

Size of the file in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to download the asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileConnection\n

\n

The connection type for PackageFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageStatistics\n

\n

Represents a object that contains package activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageTag\n

\n

A version tag contains the mapping between a tag name and a version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

Identifies the tag name of the version.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Version that the tag is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersion\n

\n

Information about a specific package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

files (PackageFileConnection!)

List of files associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageFileOrder)

\n

Ordering of the returned package files.

\n\n
\n\n
\n\n\n

package (Package)

The package associated with this version.

\n\n\n\n\n\n\n\n\n\n\n\n

platform (String)

The platform this version was built for.

\n\n\n\n\n\n\n\n\n\n\n\n

preRelease (Boolean!)

Whether or not this version is a pre-release.

\n\n\n\n\n\n\n\n\n\n\n\n

readme (String)

The README of this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

The release associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageVersionStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

The package version summary.

\n\n\n\n\n\n\n\n\n\n\n\n

version (String!)

The version string.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionConnection\n

\n

The connection type for PackageVersion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageVersionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageVersion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageVersion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionStatistics\n

\n

Represents a object that contains package version activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closingIssuesReferences (IssueConnection)

List of issues that were may be closed by this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagCommit (Commit)

The tag commit for this release.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A alert for a repository with an affected vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
  • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
  • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
  • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
  • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
  • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isGitHubStar (Boolean!)

Whether or not this user is a member of the GitHub Stars Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

suspendedAt (DateTime)

Identifies the date and time when the user was suspended.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

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

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", - "miniToc": [ - { - "contents": "\n ActorLocation\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AddedToProjectEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n App\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AssignedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutoMergeDisabledEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutoMergeEnabledEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutoMergeRequest\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutoRebaseEnabledEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutoSquashEnabledEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutomaticBaseChangeFailedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n AutomaticBaseChangeSucceededEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BaseRefChangedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BaseRefDeletedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BaseRefForcePushedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Blame\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BlameRange\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Blob\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Bot\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BranchProtectionRule\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BranchProtectionRuleConflict\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BranchProtectionRuleConflictConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BranchProtectionRuleConflictEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BranchProtectionRuleConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n BranchProtectionRuleEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CVSS\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CWE\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CWEConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CWEEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotation\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotationConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotationEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotationPosition\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckAnnotationSpan\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRun\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRunConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckRunEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckSuite\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckSuiteConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CheckSuiteEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ClosedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CodeOfConduct\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommentDeletedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Commit\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitComment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitCommentConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitCommentEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitCommentThread\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitContributionsByRepository\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CommitHistoryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ConnectedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContentAttachment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContentReference\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContributionCalendar\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContributionCalendarDay\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContributionCalendarMonth\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContributionCalendarWeek\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ContributionsCollection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ConvertToDraftEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ConvertedNoteToIssueEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedCommitContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedCommitContributionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedCommitContributionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedIssueContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedIssueContributionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedIssueContributionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedPullRequestContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedPullRequestContributionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedPullRequestContributionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedPullRequestReviewContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedPullRequestReviewContributionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedPullRequestReviewContributionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedRepositoryContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedRepositoryContributionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CreatedRepositoryContributionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n CrossReferencedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DemilestonedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeployKey\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeployKeyConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeployKeyEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeployedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Deployment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentEnvironmentChangedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentStatus\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentStatusConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DeploymentStatusEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n DisconnectedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Enterprise\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseAdministratorConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseAdministratorEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseAdministratorInvitation\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseAdministratorInvitationConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseAdministratorInvitationEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseBillingInfo\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseIdentityProvider\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseMemberConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseMemberEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseOrganizationMembershipConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseOrganizationMembershipEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseOutsideCollaboratorConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseOutsideCollaboratorEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseOwnerInfo\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterprisePendingCollaboratorConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterprisePendingCollaboratorEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterprisePendingMemberInvitationConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterprisePendingMemberInvitationEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseRepositoryInfo\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseRepositoryInfoConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseRepositoryInfoEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerInstallation\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccount\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountEmail\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountEmailConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountEmailEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountsUpload\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountsUploadConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseServerUserAccountsUploadEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseUserAccount\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseUserAccountConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n EnterpriseUserAccountEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ExternalIdentity\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ExternalIdentityConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ExternalIdentityEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ExternalIdentitySamlAttributes\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ExternalIdentityScimAttributes\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n FollowerConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n FollowingConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GenericHovercardContext\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Gist\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistComment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistCommentConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistCommentEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GistFile\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GitActor\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GitActorConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GitActorEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GitHubMetadata\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n GpgSignature\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n HeadRefDeletedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n HeadRefForcePushedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n HeadRefRestoredEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Hovercard\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IpAllowListEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IpAllowListEntryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IpAllowListEntryEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Issue\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueComment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueCommentConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueCommentEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueContributionsByRepository\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueTemplate\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueTimelineConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueTimelineItemEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueTimelineItemsConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n IssueTimelineItemsEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n JoinedGitHubContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Label\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LabelConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LabelEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LabeledEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Language\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LanguageConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LanguageEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n License\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LicenseRule\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n LockedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Mannequin\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MarkedAsDuplicateEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MembersCanDeleteReposClearAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MembersCanDeleteReposDisableAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MembersCanDeleteReposEnableAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MentionedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MergedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Milestone\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MilestoneConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MilestoneEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MilestonedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n MovedColumnsInProjectEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OauthApplicationCreateAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgAddBillingManagerAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgAddMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgBlockUserAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgCreateAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgDisableOauthAppRestrictionsAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgDisableSamlAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgDisableTwoFactorRequirementAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgEnableOauthAppRestrictionsAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgEnableSamlAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgEnableTwoFactorRequirementAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgInviteMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgInviteToBusinessAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgOauthAppAccessApprovedAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgOauthAppAccessDeniedAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgOauthAppAccessRequestedAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRemoveBillingManagerAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRemoveMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRemoveOutsideCollaboratorAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRestoreMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgRestoreMemberMembershipTeamAuditEntryData\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgUnblockUserAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgUpdateMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Organization\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationAuditEntryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationAuditEntryEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationIdentityProvider\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationInvitation\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationInvitationConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationInvitationEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationMemberConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationMemberEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationTeamsHovercardContext\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n OrganizationsHovercardContext\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Package\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageFile\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageFileConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageFileEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageStatistics\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageTag\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageVersion\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageVersionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageVersionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PackageVersionStatistics\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PageInfo\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PermissionSource\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinnableItemConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinnableItemEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinnedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinnedIssue\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinnedIssueConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PinnedIssueEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PrivateRepositoryForkingDisableAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PrivateRepositoryForkingEnableAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProfileItemShowcase\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Project\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectCard\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectCardConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectCardEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectColumn\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectColumnConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectColumnEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ProjectProgress\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PublicKey\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PublicKeyConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PublicKeyEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequest\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestChangedFile\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestChangedFileConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestChangedFileEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestCommit\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestCommitCommentThread\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestCommitConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestCommitEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestContributionsByRepository\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReview\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewComment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewCommentConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewCommentEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewContributionsByRepository\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewThread\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewThreadConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestReviewThreadEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestRevisionMarker\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestTimelineConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestTimelineItemEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestTimelineItemsConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PullRequestTimelineItemsEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Push\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PushAllowance\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PushAllowanceConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n PushAllowanceEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RateLimit\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReactingUserConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReactingUserEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Reaction\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReactionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReactionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReactionGroup\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReadyForReviewEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Ref\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RefConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RefEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RefUpdateRule\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReferencedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Release\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReleaseAsset\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReleaseAssetConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReleaseAssetEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReleaseConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReleaseEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RemovedFromProjectEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RenamedTitleEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReopenedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoAccessAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoAddMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoAddTopicAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoArchivedAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoChangeMergeSettingAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigDisableAnonymousGitAccessAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigDisableContributorsOnlyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigEnableAnonymousGitAccessAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigEnableContributorsOnlyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigLockAnonymousGitAccessAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoCreateAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoDestroyAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoRemoveMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepoRemoveTopicAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Repository\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryCollaboratorConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryCollaboratorEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryContactLink\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryInvitation\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryInvitationConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryInvitationEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryTopic\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryTopicConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryTopicEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryVisibilityChangeDisableAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryVisibilityChangeEnableAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryVulnerabilityAlert\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryVulnerabilityAlertConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RepositoryVulnerabilityAlertEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n RestrictedContribution\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewDismissalAllowance\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewDismissalAllowanceConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewDismissalAllowanceEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewDismissedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewRequest\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewRequestConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewRequestEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewRequestRemovedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewRequestedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ReviewStatusHovercardContext\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SavedReply\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SavedReplyConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SavedReplyEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SearchResultItemConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SearchResultItemEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisory\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisoryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisoryEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisoryIdentifier\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisoryPackage\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisoryPackageVersion\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityAdvisoryReference\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityVulnerability\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityVulnerabilityConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SecurityVulnerabilityEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SmimeSignature\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Sponsorship\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SponsorshipConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SponsorshipEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StargazerConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StargazerEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StarredRepositoryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StarredRepositoryEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Status\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StatusCheckRollup\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StatusCheckRollupContextConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StatusCheckRollupContextEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n StatusContext\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Submodule\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SubmoduleConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SubmoduleEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SubscribedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n SuggestedReviewer\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Tag\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Team\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamAddMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamAddRepositoryAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamChangeParentTeamAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussion\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionComment\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionCommentConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionCommentEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamDiscussionEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamMemberConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamMemberEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamRemoveMemberAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamRemoveRepositoryAuditEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamRepositoryConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TeamRepositoryEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TextMatch\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TextMatchHighlight\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Topic\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TransferredEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n Tree\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n TreeEntry\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnassignedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnknownSignature\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnlabeledEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnlockedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnmarkedAsDuplicateEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnpinnedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UnsubscribedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n User\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserBlockedEvent\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserContentEdit\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserContentEditConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserContentEditEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserEmailMetadata\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserStatus\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserStatusConnection\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n UserStatusEdge\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n VerifiableDomain\n ", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "\n ViewerHovercardContext\n ", - "headingLevel": 2, - "indentationLevel": 0 - } - ] } } \ No newline at end of file diff --git a/lib/graphql/static/previews.json b/lib/graphql/static/previews.json index 59693bbe47..8505a9ba63 100644 --- a/lib/graphql/static/previews.json +++ b/lib/graphql/static/previews.json @@ -161,6 +161,148 @@ "href": "/graphql/overview/schema-previews#team-review-assignments-preview" } ], + "ghes-3.2": [ + { + "title": "Access to package version deletion preview", + "description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.", + "toggled_by": "package-deletes-preview", + "toggled_on": [ + "Mutation.deletePackageVersion" + ], + "owning_teams": [ + "@github/pe-package-registry" + ], + "accept_header": "application/vnd.github.package-deletes-preview+json", + "href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview" + }, + { + "title": "Deployments preview", + "description": "This preview adds support for deployments mutations and new deployments features.", + "toggled_by": "flash-preview", + "toggled_on": [ + "DeploymentStatus.environment", + "Mutation.createDeploymentStatus", + "Mutation.createDeployment" + ], + "owning_teams": [ + "@github/c2c-actions-service" + ], + "accept_header": "application/vnd.github.flash-preview+json", + "href": "/graphql/overview/schema-previews#deployments-preview" + }, + { + "title": "Merge info preview", + "description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.", + "toggled_by": "merge-info-preview", + "toggled_on": [ + "PullRequest.canBeRebased", + "PullRequest.mergeStateStatus" + ], + "owning_teams": [ + "@github/pe-pull-requests" + ], + "accept_header": "application/vnd.github.merge-info-preview+json", + "href": "/graphql/overview/schema-previews#merge-info-preview" + }, + { + "title": "Update refs preview", + "description": "This preview adds support for updating multiple refs in a single operation.", + "toggled_by": "update-refs-preview", + "toggled_on": [ + "Mutation.updateRefs", + "GitRefname", + "RefUpdate" + ], + "owning_teams": [ + "@github/reponauts" + ], + "accept_header": "application/vnd.github.update-refs-preview+json", + "href": "/graphql/overview/schema-previews#update-refs-preview" + }, + { + "title": "Project event details preview", + "description": "This preview adds project, project card, and project column details to project-related issue events.", + "toggled_by": "starfox-preview", + "toggled_on": [ + "AddedToProjectEvent.project", + "AddedToProjectEvent.projectCard", + "AddedToProjectEvent.projectColumnName", + "ConvertedNoteToIssueEvent.project", + "ConvertedNoteToIssueEvent.projectCard", + "ConvertedNoteToIssueEvent.projectColumnName", + "MovedColumnsInProjectEvent.project", + "MovedColumnsInProjectEvent.projectCard", + "MovedColumnsInProjectEvent.projectColumnName", + "MovedColumnsInProjectEvent.previousProjectColumnName", + "RemovedFromProjectEvent.project", + "RemovedFromProjectEvent.projectColumnName" + ], + "owning_teams": [ + "@github/github-projects" + ], + "accept_header": "application/vnd.github.starfox-preview+json", + "href": "/graphql/overview/schema-previews#project-event-details-preview" + }, + { + "title": "Create content attachments preview", + "description": "This preview adds support for creating content attachments.", + "toggled_by": "corsair-preview", + "toggled_on": [ + "Mutation.createContentAttachment" + ], + "owning_teams": [ + "@github/feature-lifecycle" + ], + "accept_header": "application/vnd.github.corsair-preview+json", + "href": "/graphql/overview/schema-previews#create-content-attachments-preview" + }, + { + "title": "Labels preview", + "description": "This preview adds support for adding, updating, creating and deleting labels.", + "toggled_by": "bane-preview", + "toggled_on": [ + "Mutation.createLabel", + "Mutation.deleteLabel", + "Mutation.updateLabel" + ], + "owning_teams": [ + "@github/pe-pull-requests" + ], + "accept_header": "application/vnd.github.bane-preview+json", + "href": "/graphql/overview/schema-previews#labels-preview" + }, + { + "title": "Import project preview", + "description": "This preview adds support for importing projects.", + "toggled_by": "slothette-preview", + "toggled_on": [ + "Mutation.importProject" + ], + "owning_teams": [ + "@github/pe-issues-projects" + ], + "accept_header": "application/vnd.github.slothette-preview+json", + "href": "/graphql/overview/schema-previews#import-project-preview" + }, + { + "title": "Team review assignments preview", + "description": "This preview adds support for updating the settings for team review assignment.", + "toggled_by": "stone-crop-preview", + "toggled_on": [ + "Mutation.updateTeamReviewAssignment", + "TeamReviewAssignmentAlgorithm", + "Team.reviewRequestDelegationEnabled", + "Team.reviewRequestDelegationAlgorithm", + "Team.reviewRequestDelegationMemberCount", + "Team.reviewRequestDelegationNotifyTeam" + ], + "owning_teams": [ + "@github/pe-pull-requests" + ], + "accept_header": "application/vnd.github.stone-crop-preview+json", + "href": "/graphql/overview/schema-previews#team-review-assignments-preview" + } + ], "ghes-3.1": [ { "title": "Access to package version deletion preview", @@ -808,147 +950,5 @@ "accept_header": "application/vnd.github.stone-crop-preview+json", "href": "/graphql/overview/schema-previews#team-review-assignments-preview" } - ], - "ghes-3.2": [ - { - "title": "Access to package version deletion preview", - "description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.", - "toggled_by": "package-deletes-preview", - "toggled_on": [ - "Mutation.deletePackageVersion" - ], - "owning_teams": [ - "@github/pe-package-registry" - ], - "accept_header": "application/vnd.github.package-deletes-preview+json", - "href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview" - }, - { - "title": "Deployments preview", - "description": "This preview adds support for deployments mutations and new deployments features.", - "toggled_by": "flash-preview", - "toggled_on": [ - "DeploymentStatus.environment", - "Mutation.createDeploymentStatus", - "Mutation.createDeployment" - ], - "owning_teams": [ - "@github/ecosystem-api" - ], - "accept_header": "application/vnd.github.flash-preview+json", - "href": "/graphql/overview/schema-previews#deployments-preview" - }, - { - "title": "Merge info preview", - "description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.", - "toggled_by": "merge-info-preview", - "toggled_on": [ - "PullRequest.canBeRebased", - "PullRequest.mergeStateStatus" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.merge-info-preview+json", - "href": "/graphql/overview/schema-previews#merge-info-preview" - }, - { - "title": "Update refs preview", - "description": "This preview adds support for updating multiple refs in a single operation.", - "toggled_by": "update-refs-preview", - "toggled_on": [ - "Mutation.updateRefs", - "GitRefname", - "RefUpdate" - ], - "owning_teams": [ - "@github/reponauts" - ], - "accept_header": "application/vnd.github.update-refs-preview+json", - "href": "/graphql/overview/schema-previews#update-refs-preview" - }, - { - "title": "Project event details preview", - "description": "This preview adds project, project card, and project column details to project-related issue events.", - "toggled_by": "starfox-preview", - "toggled_on": [ - "AddedToProjectEvent.project", - "AddedToProjectEvent.projectCard", - "AddedToProjectEvent.projectColumnName", - "ConvertedNoteToIssueEvent.project", - "ConvertedNoteToIssueEvent.projectCard", - "ConvertedNoteToIssueEvent.projectColumnName", - "MovedColumnsInProjectEvent.project", - "MovedColumnsInProjectEvent.projectCard", - "MovedColumnsInProjectEvent.projectColumnName", - "MovedColumnsInProjectEvent.previousProjectColumnName", - "RemovedFromProjectEvent.project", - "RemovedFromProjectEvent.projectColumnName" - ], - "owning_teams": [ - "@github/github-projects" - ], - "accept_header": "application/vnd.github.starfox-preview+json", - "href": "/graphql/overview/schema-previews#project-event-details-preview" - }, - { - "title": "Create content attachments preview", - "description": "This preview adds support for creating content attachments.", - "toggled_by": "corsair-preview", - "toggled_on": [ - "Mutation.createContentAttachment" - ], - "owning_teams": [ - "@github/feature-lifecycle" - ], - "accept_header": "application/vnd.github.corsair-preview+json", - "href": "/graphql/overview/schema-previews#create-content-attachments-preview" - }, - { - "title": "Labels preview", - "description": "This preview adds support for adding, updating, creating and deleting labels.", - "toggled_by": "bane-preview", - "toggled_on": [ - "Mutation.createLabel", - "Mutation.deleteLabel", - "Mutation.updateLabel" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.bane-preview+json", - "href": "/graphql/overview/schema-previews#labels-preview" - }, - { - "title": "Import project preview", - "description": "This preview adds support for importing projects.", - "toggled_by": "slothette-preview", - "toggled_on": [ - "Mutation.importProject" - ], - "owning_teams": [ - "@github/pe-issues-projects" - ], - "accept_header": "application/vnd.github.slothette-preview+json", - "href": "/graphql/overview/schema-previews#import-project-preview" - }, - { - "title": "Team review assignments preview", - "description": "This preview adds support for updating the settings for team review assignment.", - "toggled_by": "stone-crop-preview", - "toggled_on": [ - "Mutation.updateTeamReviewAssignment", - "TeamReviewAssignmentAlgorithm", - "Team.reviewRequestDelegationEnabled", - "Team.reviewRequestDelegationAlgorithm", - "Team.reviewRequestDelegationMemberCount", - "Team.reviewRequestDelegationNotifyTeam" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.stone-crop-preview+json", - "href": "/graphql/overview/schema-previews#team-review-assignments-preview" - } ] } \ No newline at end of file diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 1b684b7167..c2ef9b1183 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -781,26 +781,6 @@ } ] }, - { - "name": "sponsorsListing", - "type": "SponsorsListing", - "kind": "objects", - "id": "sponsorslisting", - "href": "/graphql/reference/objects#sponsorslisting", - "description": "

Look up a single Sponsors Listing.

", - "isDeprecated": true, - "deprecationReason": "

Query.sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead. Removal on 2020-04-01 UTC.

", - "args": [ - { - "name": "slug", - "type": "String!", - "id": "string", - "kind": "scalars", - "href": "/graphql/reference/scalars#string", - "description": "

Select the Sponsors listing which matches this slug.

" - } - ] - }, { "name": "topic", "type": "Topic", @@ -1601,6 +1581,40 @@ } ] }, + { + "name": "cancelSponsorship", + "kind": "mutations", + "id": "cancelsponsorship", + "href": "/graphql/reference/mutations#cancelsponsorship", + "description": "

Cancel an active sponsorship.

", + "inputFields": [ + { + "name": "input", + "type": "CancelSponsorshipInput!", + "id": "cancelsponsorshipinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#cancelsponsorshipinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "sponsorsTier", + "type": "SponsorsTier", + "id": "sponsorstier", + "kind": "objects", + "href": "/graphql/reference/objects#sponsorstier", + "description": "

The tier that was being used at the time of cancellation.

" + } + ] + }, { "name": "changeUserStatus", "kind": "mutations", @@ -1983,6 +1997,48 @@ } ] }, + { + "name": "createCommitOnBranch", + "kind": "mutations", + "id": "createcommitonbranch", + "href": "/graphql/reference/mutations#createcommitonbranch", + "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", + "inputFields": [ + { + "name": "input", + "type": "CreateCommitOnBranchInput!", + "id": "createcommitonbranchinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#createcommitonbranchinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "commit", + "type": "Commit", + "id": "commit", + "kind": "objects", + "href": "/graphql/reference/objects#commit", + "description": "

The new commit.

" + }, + { + "name": "ref", + "type": "Ref", + "id": "ref", + "kind": "objects", + "href": "/graphql/reference/objects#ref", + "description": "

The ref which has been updated to point to the new commit.

" + } + ] + }, { "name": "createContentAttachment", "kind": "mutations", @@ -70706,6 +70762,57 @@ } ] }, + { + "name": "CancelSponsorshipInput", + "kind": "inputObjects", + "id": "cancelsponsorshipinput", + "href": "/graphql/reference/input-objects#cancelsponsorshipinput", + "description": "

Autogenerated input type of CancelSponsorship.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "sponsorId", + "description": "

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "sponsorLogin", + "description": "

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "sponsorableId", + "description": "

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "sponsorableLogin", + "description": "

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "ChangeUserStatusInput", "kind": "inputObjects", @@ -71330,6 +71437,64 @@ } ] }, + { + "name": "CommitMessage", + "kind": "inputObjects", + "id": "commitmessage", + "href": "/graphql/reference/input-objects#commitmessage", + "description": "

A message to include with a new commit.

", + "inputFields": [ + { + "name": "body", + "description": "

The body of the message.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "headline", + "description": "

The headline of the message.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, + { + "name": "CommittableBranch", + "kind": "inputObjects", + "id": "committablebranch", + "href": "/graphql/reference/input-objects#committablebranch", + "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

", + "inputFields": [ + { + "name": "branchName", + "description": "

The unqualified name of the branch to append the commit to.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The Node ID of the Ref to be updated.

", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + }, + { + "name": "repositoryNameWithOwner", + "description": "

The nameWithOwner of the repository to commit to.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "ContributionOrder", "kind": "inputObjects", @@ -71734,6 +71899,55 @@ } ] }, + { + "name": "CreateCommitOnBranchInput", + "kind": "inputObjects", + "id": "createcommitonbranchinput", + "href": "/graphql/reference/input-objects#createcommitonbranchinput", + "description": "

Autogenerated input type of CreateCommitOnBranch.

", + "inputFields": [ + { + "name": "branch", + "description": "

The Ref to be updated. Must be a branch.

", + "type": "CommittableBranch!", + "id": "committablebranch", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#committablebranch" + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "expectedHeadOid", + "description": "

The git commit oid expected at the head of the branch prior to the commit.

", + "type": "GitObjectID!", + "id": "gitobjectid", + "kind": "scalars", + "href": "/graphql/reference/scalars#gitobjectid" + }, + { + "name": "fileChanges", + "description": "

A description of changes to files in this commit.

", + "type": "FileChanges", + "id": "filechanges", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#filechanges" + }, + { + "name": "message", + "description": "

The commit message the be included with the commit.

", + "type": "CommitMessage!", + "id": "commitmessage", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#commitmessage" + } + ] + }, { "name": "CreateContentAttachmentInput", "kind": "inputObjects", @@ -73712,6 +73926,73 @@ } ] }, + { + "name": "FileAddition", + "kind": "inputObjects", + "id": "fileaddition", + "href": "/graphql/reference/input-objects#fileaddition", + "description": "

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

", + "inputFields": [ + { + "name": "contents", + "description": "

The base64 encoded contents of the file.

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, + { + "name": "path", + "description": "

The path in the repository where the file will be located.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, + { + "name": "FileChanges", + "kind": "inputObjects", + "id": "filechanges", + "href": "/graphql/reference/input-objects#filechanges", + "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}

    \n
  2. \n
  3. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
  4. \n
  5. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
  6. \n
  7. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
  8. \n
  9. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
  10. \n
", + "inputFields": [ + { + "name": "additions", + "description": "

File to add or change.

", + "type": "[FileAddition!]", + "id": "fileaddition", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#fileaddition" + }, + { + "name": "deletions", + "description": "

Files to delete.

", + "type": "[FileDeletion!]", + "id": "filedeletion", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#filedeletion" + } + ] + }, + { + "name": "FileDeletion", + "kind": "inputObjects", + "id": "filedeletion", + "href": "/graphql/reference/input-objects#filedeletion", + "description": "

A command to delete the file at the given path as part of a commit.

", + "inputFields": [ + { + "name": "path", + "description": "

The path to delete.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "FollowUserInput", "kind": "inputObjects", @@ -78636,6 +78917,13 @@ } ], "scalars": [ + { + "name": "Base64String", + "kind": "scalars", + "id": "base64string", + "href": "/graphql/reference/scalars#base64string", + "description": "

A (potentially binary) string encoded using base64.

" + }, { "name": "Boolean", "description": "Represents `true` or `false` values.", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 6cabc299dd..5ce9ea40cc 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -1540,6 +1540,48 @@ } ] }, + { + "name": "createCommitOnBranch", + "kind": "mutations", + "id": "createcommitonbranch", + "href": "/graphql/reference/mutations#createcommitonbranch", + "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", + "inputFields": [ + { + "name": "input", + "type": "CreateCommitOnBranchInput!", + "id": "createcommitonbranchinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#createcommitonbranchinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "commit", + "type": "Commit", + "id": "commit", + "kind": "objects", + "href": "/graphql/reference/objects#commit", + "description": "

The new commit.

" + }, + { + "name": "ref", + "type": "Ref", + "id": "ref", + "kind": "objects", + "href": "/graphql/reference/objects#ref", + "description": "

The ref which has been updated to point to the new commit.

" + } + ] + }, { "name": "createContentAttachment", "kind": "mutations", @@ -64218,6 +64260,64 @@ } ] }, + { + "name": "CommitMessage", + "kind": "inputObjects", + "id": "commitmessage", + "href": "/graphql/reference/input-objects#commitmessage", + "description": "

A message to include with a new commit.

", + "inputFields": [ + { + "name": "body", + "description": "

The body of the message.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "headline", + "description": "

The headline of the message.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, + { + "name": "CommittableBranch", + "kind": "inputObjects", + "id": "committablebranch", + "href": "/graphql/reference/input-objects#committablebranch", + "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

", + "inputFields": [ + { + "name": "branchName", + "description": "

The unqualified name of the branch to append the commit to.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The Node ID of the Ref to be updated.

", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + }, + { + "name": "repositoryNameWithOwner", + "description": "

The nameWithOwner of the repository to commit to.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "ContributionOrder", "kind": "inputObjects", @@ -64622,6 +64722,55 @@ } ] }, + { + "name": "CreateCommitOnBranchInput", + "kind": "inputObjects", + "id": "createcommitonbranchinput", + "href": "/graphql/reference/input-objects#createcommitonbranchinput", + "description": "

Autogenerated input type of CreateCommitOnBranch.

", + "inputFields": [ + { + "name": "branch", + "description": "

The Ref to be updated. Must be a branch.

", + "type": "CommittableBranch!", + "id": "committablebranch", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#committablebranch" + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "expectedHeadOid", + "description": "

The git commit oid expected at the head of the branch prior to the commit.

", + "type": "GitObjectID!", + "id": "gitobjectid", + "kind": "scalars", + "href": "/graphql/reference/scalars#gitobjectid" + }, + { + "name": "fileChanges", + "description": "

A description of changes to files in this commit.

", + "type": "FileChanges", + "id": "filechanges", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#filechanges" + }, + { + "name": "message", + "description": "

The commit message the be included with the commit.

", + "type": "CommitMessage!", + "id": "commitmessage", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#commitmessage" + } + ] + }, { "name": "CreateContentAttachmentInput", "kind": "inputObjects", @@ -66389,6 +66538,73 @@ } ] }, + { + "name": "FileAddition", + "kind": "inputObjects", + "id": "fileaddition", + "href": "/graphql/reference/input-objects#fileaddition", + "description": "

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

", + "inputFields": [ + { + "name": "contents", + "description": "

The base64 encoded contents of the file.

", + "type": "Base64String!", + "id": "base64string", + "kind": "scalars", + "href": "/graphql/reference/scalars#base64string" + }, + { + "name": "path", + "description": "

The path in the repository where the file will be located.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, + { + "name": "FileChanges", + "kind": "inputObjects", + "id": "filechanges", + "href": "/graphql/reference/input-objects#filechanges", + "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}

    \n
  2. \n
  3. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
  4. \n
  5. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
  6. \n
  7. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
  8. \n
  9. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
  10. \n
", + "inputFields": [ + { + "name": "additions", + "description": "

File to add or change.

", + "type": "[FileAddition!]", + "id": "fileaddition", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#fileaddition" + }, + { + "name": "deletions", + "description": "

Files to delete.

", + "type": "[FileDeletion!]", + "id": "filedeletion", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#filedeletion" + } + ] + }, + { + "name": "FileDeletion", + "kind": "inputObjects", + "id": "filedeletion", + "href": "/graphql/reference/input-objects#filedeletion", + "description": "

A command to delete the file at the given path as part of a commit.

", + "inputFields": [ + { + "name": "path", + "description": "

The path to delete.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "FollowUserInput", "kind": "inputObjects", @@ -70489,6 +70705,13 @@ } ], "scalars": [ + { + "name": "Base64String", + "kind": "scalars", + "id": "base64string", + "href": "/graphql/reference/scalars#base64string", + "description": "

A (potentially binary) string encoded using base64.

" + }, { "name": "Boolean", "description": "Represents `true` or `false` values.", diff --git a/lib/graphql/static/schema-ghes-3.2.json b/lib/graphql/static/schema-ghes-3.2.json index 31932de78c..ef70ef250d 100644 --- a/lib/graphql/static/schema-ghes-3.2.json +++ b/lib/graphql/static/schema-ghes-3.2.json @@ -652,6 +652,40 @@ } ] }, + { + "name": "addDiscussionComment", + "kind": "mutations", + "id": "adddiscussioncomment", + "href": "/graphql/reference/mutations#adddiscussioncomment", + "description": "

Adds a comment to a Discussion, possibly as a reply to another comment.

", + "inputFields": [ + { + "name": "input", + "type": "AddDiscussionCommentInput!", + "id": "adddiscussioncommentinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#adddiscussioncommentinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "comment", + "type": "DiscussionComment", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment", + "description": "

The newly created discussion comment.

" + } + ] + }, { "name": "addEnterpriseAdmin", "kind": "mutations", @@ -1022,6 +1056,142 @@ } ] }, + { + "name": "addUpvote", + "kind": "mutations", + "id": "addupvote", + "href": "/graphql/reference/mutations#addupvote", + "description": "

Add an upvote to a discussion or discussion comment.

", + "inputFields": [ + { + "name": "input", + "type": "AddUpvoteInput!", + "id": "addupvoteinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#addupvoteinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "subject", + "type": "Votable", + "id": "votable", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#votable", + "description": "

The votable subject.

" + } + ] + }, + { + "name": "addVerifiableDomain", + "kind": "mutations", + "id": "addverifiabledomain", + "href": "/graphql/reference/mutations#addverifiabledomain", + "description": "

Adds a verifiable domain to an owning account.

", + "inputFields": [ + { + "name": "input", + "type": "AddVerifiableDomainInput!", + "id": "addverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#addverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

The verifiable domain that was added.

" + } + ] + }, + { + "name": "approveDeployments", + "kind": "mutations", + "id": "approvedeployments", + "href": "/graphql/reference/mutations#approvedeployments", + "description": "

Approve all pending deployments under one or more environments.

", + "inputFields": [ + { + "name": "input", + "type": "ApproveDeploymentsInput!", + "id": "approvedeploymentsinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#approvedeploymentsinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "deployments", + "type": "[Deployment!]", + "id": "deployment", + "kind": "objects", + "href": "/graphql/reference/objects#deployment", + "description": "

The affected deployments.

" + } + ] + }, + { + "name": "approveVerifiableDomain", + "kind": "mutations", + "id": "approveverifiabledomain", + "href": "/graphql/reference/mutations#approveverifiabledomain", + "description": "

Approve a verifiable domain for notification delivery.

", + "inputFields": [ + { + "name": "input", + "type": "ApproveVerifiableDomainInput!", + "id": "approveverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

The verifiable domain that was approved.

" + } + ] + }, { "name": "archiveRepository", "kind": "mutations", @@ -1302,6 +1472,40 @@ } ] }, + { + "name": "convertPullRequestToDraft", + "kind": "mutations", + "id": "convertpullrequesttodraft", + "href": "/graphql/reference/mutations#convertpullrequesttodraft", + "description": "

Converts a pull request to draft.

", + "inputFields": [ + { + "name": "input", + "type": "ConvertPullRequestToDraftInput!", + "id": "convertpullrequesttodraftinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "pullRequest", + "type": "PullRequest", + "id": "pullrequest", + "kind": "objects", + "href": "/graphql/reference/objects#pullrequest", + "description": "

The pull request that is now a draft.

" + } + ] + }, { "name": "createBranchProtectionRule", "kind": "mutations", @@ -1469,7 +1673,7 @@ "Mutation.createDeployment" ], "owning_teams": [ - "@github/ecosystem-api" + "@github/c2c-actions-service" ], "accept_header": "application/vnd.github.flash-preview+json", "href": "/graphql/overview/schema-previews#deployments-preview" @@ -1527,7 +1731,7 @@ "Mutation.createDeployment" ], "owning_teams": [ - "@github/ecosystem-api" + "@github/c2c-actions-service" ], "accept_header": "application/vnd.github.flash-preview+json", "href": "/graphql/overview/schema-previews#deployments-preview" @@ -1560,6 +1764,40 @@ } ] }, + { + "name": "createDiscussion", + "kind": "mutations", + "id": "creatediscussion", + "href": "/graphql/reference/mutations#creatediscussion", + "description": "

Create a discussion.

", + "inputFields": [ + { + "name": "input", + "type": "CreateDiscussionInput!", + "id": "creatediscussioninput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#creatediscussioninput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "discussion", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion", + "description": "

The discussion that was just created.

" + } + ] + }, { "name": "createEnterpriseOrganization", "kind": "mutations", @@ -1602,6 +1840,40 @@ } ] }, + { + "name": "createEnvironment", + "kind": "mutations", + "id": "createenvironment", + "href": "/graphql/reference/mutations#createenvironment", + "description": "

Creates an environment or simply returns it if already exists.

", + "inputFields": [ + { + "name": "input", + "type": "CreateEnvironmentInput!", + "id": "createenvironmentinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#createenvironmentinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "environment", + "type": "Environment", + "id": "environment", + "kind": "objects", + "href": "/graphql/reference/objects#environment", + "description": "

The new or existing environment.

" + } + ] + }, { "name": "createIpAllowListEntry", "kind": "mutations", @@ -1976,6 +2248,100 @@ } ] }, + { + "name": "deleteDiscussion", + "kind": "mutations", + "id": "deletediscussion", + "href": "/graphql/reference/mutations#deletediscussion", + "description": "

Delete a discussion and all of its replies.

", + "inputFields": [ + { + "name": "input", + "type": "DeleteDiscussionInput!", + "id": "deletediscussioninput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#deletediscussioninput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "discussion", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion", + "description": "

The discussion that was just deleted.

" + } + ] + }, + { + "name": "deleteDiscussionComment", + "kind": "mutations", + "id": "deletediscussioncomment", + "href": "/graphql/reference/mutations#deletediscussioncomment", + "description": "

Delete a discussion comment. If it has replies, wipe it instead.

", + "inputFields": [ + { + "name": "input", + "type": "DeleteDiscussionCommentInput!", + "id": "deletediscussioncommentinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#deletediscussioncommentinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "comment", + "type": "DiscussionComment", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment", + "description": "

The discussion comment that was just deleted.

" + } + ] + }, + { + "name": "deleteEnvironment", + "kind": "mutations", + "id": "deleteenvironment", + "href": "/graphql/reference/mutations#deleteenvironment", + "description": "

Deletes an environment.

", + "inputFields": [ + { + "name": "input", + "type": "DeleteEnvironmentInput!", + "id": "deleteenvironmentinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#deleteenvironmentinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + } + ] + }, { "name": "deleteIpAllowListEntry", "kind": "mutations", @@ -2424,6 +2790,40 @@ } ] }, + { + "name": "deleteVerifiableDomain", + "kind": "mutations", + "id": "deleteverifiabledomain", + "href": "/graphql/reference/mutations#deleteverifiabledomain", + "description": "

Deletes a verifiable domain.

", + "inputFields": [ + { + "name": "input", + "type": "DeleteVerifiableDomainInput!", + "id": "deleteverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#deleteverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "owner", + "type": "VerifiableDomainOwner", + "id": "verifiabledomainowner", + "kind": "unions", + "href": "/graphql/reference/unions#verifiabledomainowner", + "description": "

The owning account from which the domain was deleted.

" + } + ] + }, { "name": "disablePullRequestAutoMerge", "kind": "mutations", @@ -2708,6 +3108,40 @@ } ] }, + { + "name": "markDiscussionCommentAsAnswer", + "kind": "mutations", + "id": "markdiscussioncommentasanswer", + "href": "/graphql/reference/mutations#markdiscussioncommentasanswer", + "description": "

Mark a discussion comment as the chosen answer for discussions in an answerable category.

", + "inputFields": [ + { + "name": "input", + "type": "MarkDiscussionCommentAsAnswerInput!", + "id": "markdiscussioncommentasanswerinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#markdiscussioncommentasanswerinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "discussion", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion", + "description": "

The discussion that includes the chosen comment.

" + } + ] + }, { "name": "markFileAsViewed", "kind": "mutations", @@ -2988,6 +3422,74 @@ } ] }, + { + "name": "regenerateVerifiableDomainToken", + "kind": "mutations", + "id": "regenerateverifiabledomaintoken", + "href": "/graphql/reference/mutations#regenerateverifiabledomaintoken", + "description": "

Regenerates a verifiable domain's verification token.

", + "inputFields": [ + { + "name": "input", + "type": "RegenerateVerifiableDomainTokenInput!", + "id": "regenerateverifiabledomaintokeninput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#regenerateverifiabledomaintokeninput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "verificationToken", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

The verification token that was generated.

" + } + ] + }, + { + "name": "rejectDeployments", + "kind": "mutations", + "id": "rejectdeployments", + "href": "/graphql/reference/mutations#rejectdeployments", + "description": "

Reject all pending deployments under one or more environments.

", + "inputFields": [ + { + "name": "input", + "type": "RejectDeploymentsInput!", + "id": "rejectdeploymentsinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#rejectdeploymentsinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "deployments", + "type": "[Deployment!]", + "id": "deployment", + "kind": "objects", + "href": "/graphql/reference/objects#deployment", + "description": "

The affected deployments.

" + } + ] + }, { "name": "removeAssigneesFromAssignable", "kind": "mutations", @@ -3224,6 +3726,40 @@ } ] }, + { + "name": "removeUpvote", + "kind": "mutations", + "id": "removeupvote", + "href": "/graphql/reference/mutations#removeupvote", + "description": "

Remove an upvote to a discussion or discussion comment.

", + "inputFields": [ + { + "name": "input", + "type": "RemoveUpvoteInput!", + "id": "removeupvoteinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#removeupvoteinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "subject", + "type": "Votable", + "id": "votable", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#votable", + "description": "

The votable subject.

" + } + ] + }, { "name": "reopenIssue", "kind": "mutations", @@ -3630,6 +4166,40 @@ } ] }, + { + "name": "unmarkDiscussionCommentAsAnswer", + "kind": "mutations", + "id": "unmarkdiscussioncommentasanswer", + "href": "/graphql/reference/mutations#unmarkdiscussioncommentasanswer", + "description": "

Unmark a discussion comment as the chosen answer for discussions in an answerable category.

", + "inputFields": [ + { + "name": "input", + "type": "UnmarkDiscussionCommentAsAnswerInput!", + "id": "unmarkdiscussioncommentasanswerinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#unmarkdiscussioncommentasanswerinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "discussion", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion", + "description": "

The discussion that includes the comment.

" + } + ] + }, { "name": "unmarkFileAsViewed", "kind": "mutations", @@ -3902,6 +4472,74 @@ } ] }, + { + "name": "updateDiscussion", + "kind": "mutations", + "id": "updatediscussion", + "href": "/graphql/reference/mutations#updatediscussion", + "description": "

Update a discussion.

", + "inputFields": [ + { + "name": "input", + "type": "UpdateDiscussionInput!", + "id": "updatediscussioninput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updatediscussioninput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "discussion", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion", + "description": "

The modified discussion.

" + } + ] + }, + { + "name": "updateDiscussionComment", + "kind": "mutations", + "id": "updatediscussioncomment", + "href": "/graphql/reference/mutations#updatediscussioncomment", + "description": "

Update the contents of a comment on a Discussion.

", + "inputFields": [ + { + "name": "input", + "type": "UpdateDiscussionCommentInput!", + "id": "updatediscussioncommentinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updatediscussioncommentinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "comment", + "type": "DiscussionComment", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment", + "description": "

The modified discussion comment.

" + } + ] + }, { "name": "updateEnterpriseAllowPrivateRepositoryForkingSetting", "kind": "mutations", @@ -3949,7 +4587,7 @@ "kind": "mutations", "id": "updateenterprisedefaultrepositorypermissionsetting", "href": "/graphql/reference/mutations#updateenterprisedefaultrepositorypermissionsetting", - "description": "

Sets the default repository permission for organizations in an enterprise.

", + "description": "

Sets the base repository permission for organizations in an enterprise.

", "inputFields": [ { "name": "input", @@ -3974,7 +4612,7 @@ "id": "enterprise", "kind": "objects", "href": "/graphql/reference/objects#enterprise", - "description": "

The enterprise with the updated default repository permission setting.

" + "description": "

The enterprise with the updated base repository permission setting.

" }, { "name": "message", @@ -3982,7 +4620,7 @@ "id": "string", "kind": "scalars", "href": "/graphql/reference/scalars#string", - "description": "

A message confirming the result of updating the default repository permission setting.

" + "description": "

A message confirming the result of updating the base repository permission setting.

" } ] }, @@ -4524,6 +5162,40 @@ } ] }, + { + "name": "updateEnvironment", + "kind": "mutations", + "id": "updateenvironment", + "href": "/graphql/reference/mutations#updateenvironment", + "description": "

Updates an environment.

", + "inputFields": [ + { + "name": "input", + "type": "UpdateEnvironmentInput!", + "id": "updateenvironmentinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updateenvironmentinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "environment", + "type": "Environment", + "id": "environment", + "kind": "objects", + "href": "/graphql/reference/objects#environment", + "description": "

The updated environment.

" + } + ] + }, { "name": "updateIpAllowListEnabledSetting", "kind": "mutations", @@ -4592,6 +5264,40 @@ } ] }, + { + "name": "updateIpAllowListForInstalledAppsEnabledSetting", + "kind": "mutations", + "id": "updateipallowlistforinstalledappsenabledsetting", + "href": "/graphql/reference/mutations#updateipallowlistforinstalledappsenabledsetting", + "description": "

Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.

", + "inputFields": [ + { + "name": "input", + "type": "UpdateIpAllowListForInstalledAppsEnabledSettingInput!", + "id": "updateipallowlistforinstalledappsenabledsettinginput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updateipallowlistforinstalledappsenabledsettinginput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "owner", + "type": "IpAllowListOwner", + "id": "ipallowlistowner", + "kind": "unions", + "href": "/graphql/reference/unions#ipallowlistowner", + "description": "

The IP allow list owner on which the setting was updated.

" + } + ] + }, { "name": "updateIssue", "kind": "mutations", @@ -4718,6 +5424,40 @@ } ] }, + { + "name": "updateNotificationRestrictionSetting", + "kind": "mutations", + "id": "updatenotificationrestrictionsetting", + "href": "/graphql/reference/mutations#updatenotificationrestrictionsetting", + "description": "

Update the setting to restrict notifications to only verified or approved domains available to an owner.

", + "inputFields": [ + { + "name": "input", + "type": "UpdateNotificationRestrictionSettingInput!", + "id": "updatenotificationrestrictionsettinginput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updatenotificationrestrictionsettinginput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "owner", + "type": "VerifiableDomainOwner", + "id": "verifiabledomainowner", + "kind": "unions", + "href": "/graphql/reference/unions#verifiabledomainowner", + "description": "

The owner on which the setting was updated.

" + } + ] + }, { "name": "updateProject", "kind": "mutations", @@ -5236,6 +5976,40 @@ "description": "

The updated repository.

" } ] + }, + { + "name": "verifyVerifiableDomain", + "kind": "mutations", + "id": "verifyverifiabledomain", + "href": "/graphql/reference/mutations#verifyverifiabledomain", + "description": "

Verify that a verifiable domain has the expected DNS record.

", + "inputFields": [ + { + "name": "input", + "type": "VerifyVerifiableDomainInput!", + "id": "verifyverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#verifyverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

The verifiable domain that was verified.

" + } + ] } ], "objects": [ @@ -5465,6 +6239,66 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "ipAllowListEntries", + "description": "

The IP addresses of the app.

", + "type": "IpAllowListEntryConnection!", + "id": "ipallowlistentryconnection", + "kind": "objects", + "href": "/graphql/reference/objects#ipallowlistentryconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for IP allow list entries returned.

", + "type": { + "name": "IpAllowListEntryOrder", + "id": "ipallowlistentryorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#ipallowlistentryorder" + } + } + ] + }, { "name": "logoBackgroundColor", "description": "

The hex color code, without the leading '#', for the logo background.

", @@ -6669,6 +7503,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "requiresConversationResolution", + "description": "

Are conversations required to be resolved before merging.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "requiresLinearHistory", "description": "

Are merge commits prohibited from being pushed to this branch.

", @@ -7266,6 +8108,11 @@ "id": "node", "href": "/graphql/reference/interfaces#node" }, + { + "name": "RequirableByPullRequest", + "id": "requirablebypullrequest", + "href": "/graphql/reference/interfaces#requirablebypullrequest" + }, { "name": "UniformResourceLocatable", "id": "uniformresourcelocatable", @@ -7355,6 +8202,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" }, + { + "name": "deployment", + "description": "

The corresponding deployment for this job, if any.

", + "type": "Deployment", + "id": "deployment", + "kind": "objects", + "href": "/graphql/reference/objects#deployment" + }, { "name": "detailsUrl", "description": "

The URL from which to find full details of the check run on the integrator's site.

", @@ -7371,6 +8226,36 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "isRequired", + "description": "

Whether this is required to pass before merging for a specific pull request.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

The id of the pull request this is required for.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + }, + { + "name": "pullRequestNumber", + "description": "

The number of the pull request this is required for.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "name", "description": "

The name of the check for this check run.

", @@ -7379,6 +8264,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "pendingDeploymentRequest", + "description": "

Information about a pending deployment, if any, in this check run.

", + "type": "DeploymentRequest", + "id": "deploymentrequest", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentrequest" + }, { "name": "permalink", "description": "

The permalink to the check run summary.

", @@ -7419,6 +8312,66 @@ "kind": "enums", "href": "/graphql/reference/enums#checkstatusstate" }, + { + "name": "steps", + "description": "

The check run's steps.

", + "type": "CheckStepConnection", + "id": "checkstepconnection", + "kind": "objects", + "href": "/graphql/reference/objects#checkstepconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "number", + "description": "

Step number.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "summary", "description": "

A string representing the check run's summary.

", @@ -7519,6 +8472,145 @@ } ] }, + { + "name": "CheckStep", + "kind": "objects", + "id": "checkstep", + "href": "/graphql/reference/objects#checkstep", + "description": "

A single check step.

", + "fields": [ + { + "name": "completedAt", + "description": "

Identifies the date and time when the check step was completed.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "conclusion", + "description": "

The conclusion of the check step.

", + "type": "CheckConclusionState", + "id": "checkconclusionstate", + "kind": "enums", + "href": "/graphql/reference/enums#checkconclusionstate" + }, + { + "name": "externalId", + "description": "

A reference for the check step on the integrator's system.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "name", + "description": "

The step's name.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "number", + "description": "

The index of the step in the list of steps of the parent check run.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "secondsToCompletion", + "description": "

Number of seconds to completion.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "startedAt", + "description": "

Identifies the date and time when the check step was started.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "status", + "description": "

The current status of the check step.

", + "type": "CheckStatusState!", + "id": "checkstatusstate", + "kind": "enums", + "href": "/graphql/reference/enums#checkstatusstate" + } + ] + }, + { + "name": "CheckStepConnection", + "kind": "objects", + "id": "checkstepconnection", + "href": "/graphql/reference/objects#checkstepconnection", + "description": "

The connection type for CheckStep.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[CheckStepEdge]", + "id": "checkstepedge", + "kind": "objects", + "href": "/graphql/reference/objects#checkstepedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[CheckStep]", + "id": "checkstep", + "kind": "objects", + "href": "/graphql/reference/objects#checkstep" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "CheckStepEdge", + "kind": "objects", + "id": "checkstepedge", + "href": "/graphql/reference/objects#checkstepedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "CheckStep", + "id": "checkstep", + "kind": "objects", + "href": "/graphql/reference/objects#checkstep" + } + ] + }, { "name": "CheckSuite", "kind": "objects", @@ -7633,6 +8725,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "creator", + "description": "

The user who triggered the check suite.

", + "type": "User", + "id": "user", + "kind": "objects", + "href": "/graphql/reference/objects#user" + }, { "name": "databaseId", "description": "

Identifies the primary key from the database.

", @@ -7788,6 +8888,14 @@ "id": "uri", "kind": "scalars", "href": "/graphql/reference/scalars#uri" + }, + { + "name": "workflowRun", + "description": "

The workflow run associated with this check suite.

", + "type": "WorkflowRun", + "id": "workflowrun", + "kind": "objects", + "href": "/graphql/reference/objects#workflowrun" } ] }, @@ -8077,7 +9185,7 @@ }, { "name": "associatedPullRequests", - "description": "

The pull requests associated with a commit.

", + "description": "

The merged Pull Request that introduced the commit to the repository. If the\ncommit is not present in the default branch, additionally returns open Pull\nRequests associated with the commit.

", "type": "PullRequestConnection", "id": "pullrequestconnection", "kind": "objects", @@ -12185,6 +13293,549 @@ } ] }, + { + "name": "DeploymentProtectionRule", + "kind": "objects", + "id": "deploymentprotectionrule", + "href": "/graphql/reference/objects#deploymentprotectionrule", + "description": "

A protection rule.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + } + ], + "fields": [ + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "reviewers", + "description": "

The teams or users that can review the deployment.

", + "type": "DeploymentReviewerConnection!", + "id": "deploymentreviewerconnection", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentreviewerconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "timeout", + "description": "

The timeout in minutes for this protection rule.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "type", + "description": "

The type of protection rule.

", + "type": "DeploymentProtectionRuleType!", + "id": "deploymentprotectionruletype", + "kind": "enums", + "href": "/graphql/reference/enums#deploymentprotectionruletype" + } + ] + }, + { + "name": "DeploymentProtectionRuleConnection", + "kind": "objects", + "id": "deploymentprotectionruleconnection", + "href": "/graphql/reference/objects#deploymentprotectionruleconnection", + "description": "

The connection type for DeploymentProtectionRule.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DeploymentProtectionRuleEdge]", + "id": "deploymentprotectionruleedge", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentprotectionruleedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[DeploymentProtectionRule]", + "id": "deploymentprotectionrule", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentprotectionrule" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DeploymentProtectionRuleEdge", + "kind": "objects", + "id": "deploymentprotectionruleedge", + "href": "/graphql/reference/objects#deploymentprotectionruleedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "DeploymentProtectionRule", + "id": "deploymentprotectionrule", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentprotectionrule" + } + ] + }, + { + "name": "DeploymentRequest", + "kind": "objects", + "id": "deploymentrequest", + "href": "/graphql/reference/objects#deploymentrequest", + "description": "

A request to deploy a workflow run to an environment.

", + "fields": [ + { + "name": "currentUserCanApprove", + "description": "

Whether or not the current user can approve the deployment.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "environment", + "description": "

The target environment of the deployment.

", + "type": "Environment!", + "id": "environment", + "kind": "objects", + "href": "/graphql/reference/objects#environment" + }, + { + "name": "reviewers", + "description": "

The teams or users that can review the deployment.

", + "type": "DeploymentReviewerConnection!", + "id": "deploymentreviewerconnection", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentreviewerconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "waitTimer", + "description": "

The wait timer in minutes configured in the environment.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "waitTimerStartedAt", + "description": "

The wait timer in minutes configured in the environment.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + } + ] + }, + { + "name": "DeploymentRequestConnection", + "kind": "objects", + "id": "deploymentrequestconnection", + "href": "/graphql/reference/objects#deploymentrequestconnection", + "description": "

The connection type for DeploymentRequest.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DeploymentRequestEdge]", + "id": "deploymentrequestedge", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentrequestedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[DeploymentRequest]", + "id": "deploymentrequest", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentrequest" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DeploymentRequestEdge", + "kind": "objects", + "id": "deploymentrequestedge", + "href": "/graphql/reference/objects#deploymentrequestedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "DeploymentRequest", + "id": "deploymentrequest", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentrequest" + } + ] + }, + { + "name": "DeploymentReview", + "kind": "objects", + "id": "deploymentreview", + "href": "/graphql/reference/objects#deploymentreview", + "description": "

A deployment review.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + } + ], + "fields": [ + { + "name": "comment", + "description": "

The comment the user left.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "environments", + "description": "

The environments approved or rejected.

", + "type": "EnvironmentConnection!", + "id": "environmentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#environmentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "state", + "description": "

The decision of the user.

", + "type": "DeploymentReviewState!", + "id": "deploymentreviewstate", + "kind": "enums", + "href": "/graphql/reference/enums#deploymentreviewstate" + }, + { + "name": "user", + "description": "

The user that reviewed the deployment.

", + "type": "User!", + "id": "user", + "kind": "objects", + "href": "/graphql/reference/objects#user" + } + ] + }, + { + "name": "DeploymentReviewConnection", + "kind": "objects", + "id": "deploymentreviewconnection", + "href": "/graphql/reference/objects#deploymentreviewconnection", + "description": "

The connection type for DeploymentReview.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DeploymentReviewEdge]", + "id": "deploymentreviewedge", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentreviewedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[DeploymentReview]", + "id": "deploymentreview", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentreview" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DeploymentReviewEdge", + "kind": "objects", + "id": "deploymentreviewedge", + "href": "/graphql/reference/objects#deploymentreviewedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "DeploymentReview", + "id": "deploymentreview", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentreview" + } + ] + }, + { + "name": "DeploymentReviewerConnection", + "kind": "objects", + "id": "deploymentreviewerconnection", + "href": "/graphql/reference/objects#deploymentreviewerconnection", + "description": "

The connection type for DeploymentReviewer.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DeploymentReviewerEdge]", + "id": "deploymentrevieweredge", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentrevieweredge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[DeploymentReviewer]", + "id": "deploymentreviewer", + "kind": "unions", + "href": "/graphql/reference/unions#deploymentreviewer" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DeploymentReviewerEdge", + "kind": "objects", + "id": "deploymentrevieweredge", + "href": "/graphql/reference/objects#deploymentrevieweredge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "DeploymentReviewer", + "id": "deploymentreviewer", + "kind": "unions", + "href": "/graphql/reference/unions#deploymentreviewer" + } + ] + }, { "name": "DeploymentStatus", "kind": "objects", @@ -12249,7 +13900,7 @@ "Mutation.createDeployment" ], "owning_teams": [ - "@github/ecosystem-api" + "@github/c2c-actions-service" ], "accept_header": "application/vnd.github.flash-preview+json", "href": "/graphql/overview/schema-previews#deployments-preview" @@ -12411,6 +14062,1337 @@ } ] }, + { + "name": "Discussion", + "kind": "objects", + "id": "discussion", + "href": "/graphql/reference/objects#discussion", + "description": "

A discussion in a repository.

", + "implements": [ + { + "name": "Comment", + "id": "comment", + "href": "/graphql/reference/interfaces#comment" + }, + { + "name": "Deletable", + "id": "deletable", + "href": "/graphql/reference/interfaces#deletable" + }, + { + "name": "Labelable", + "id": "labelable", + "href": "/graphql/reference/interfaces#labelable" + }, + { + "name": "Lockable", + "id": "lockable", + "href": "/graphql/reference/interfaces#lockable" + }, + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + }, + { + "name": "Reactable", + "id": "reactable", + "href": "/graphql/reference/interfaces#reactable" + }, + { + "name": "RepositoryNode", + "id": "repositorynode", + "href": "/graphql/reference/interfaces#repositorynode" + }, + { + "name": "Subscribable", + "id": "subscribable", + "href": "/graphql/reference/interfaces#subscribable" + }, + { + "name": "Updatable", + "id": "updatable", + "href": "/graphql/reference/interfaces#updatable" + }, + { + "name": "Votable", + "id": "votable", + "href": "/graphql/reference/interfaces#votable" + } + ], + "fields": [ + { + "name": "activeLockReason", + "description": "

Reason that the conversation was locked.

", + "type": "LockReason", + "id": "lockreason", + "kind": "enums", + "href": "/graphql/reference/enums#lockreason" + }, + { + "name": "answer", + "description": "

The comment chosen as this discussion's answer, if any.

", + "type": "DiscussionComment", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment" + }, + { + "name": "answerChosenAt", + "description": "

The time when a user chose this discussion's answer, if answered.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "answerChosenBy", + "description": "

The user who chose this discussion's answer, if answered.

", + "type": "Actor", + "id": "actor", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#actor" + }, + { + "name": "author", + "description": "

The actor who authored the comment.

", + "type": "Actor", + "id": "actor", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#actor" + }, + { + "name": "authorAssociation", + "description": "

Author's association with the subject of the comment.

", + "type": "CommentAuthorAssociation!", + "id": "commentauthorassociation", + "kind": "enums", + "href": "/graphql/reference/enums#commentauthorassociation" + }, + { + "name": "body", + "description": "

The main text of the discussion post.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "bodyHTML", + "description": "

The body rendered to HTML.

", + "type": "HTML!", + "id": "html", + "kind": "scalars", + "href": "/graphql/reference/scalars#html" + }, + { + "name": "bodyText", + "description": "

The body rendered to text.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "category", + "description": "

The category for this discussion.

", + "type": "DiscussionCategory!", + "id": "discussioncategory", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncategory" + }, + { + "name": "comments", + "description": "

The replies to the discussion.

", + "type": "DiscussionCommentConnection!", + "id": "discussioncommentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncommentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "createdViaEmail", + "description": "

Check if this comment was created via an email reply.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "editor", + "description": "

The actor who edited the comment.

", + "type": "Actor", + "id": "actor", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#actor" + }, + { + "name": "includesCreatedEdit", + "description": "

Check if this comment was edited and includes an edit with the creation data.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "labels", + "description": "

A list of labels associated with the object.

", + "type": "LabelConnection", + "id": "labelconnection", + "kind": "objects", + "href": "/graphql/reference/objects#labelconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for labels returned from the connection.

", + "type": { + "name": "LabelOrder", + "id": "labelorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#labelorder" + } + } + ] + }, + { + "name": "lastEditedAt", + "description": "

The moment the editor made the last edit.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "locked", + "description": "

true if the object is locked.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "number", + "description": "

The number identifying this discussion within the repository.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "publishedAt", + "description": "

Identifies when the comment was published at.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "reactionGroups", + "description": "

A list of reactions grouped by content left on the subject.

", + "type": "[ReactionGroup!]", + "id": "reactiongroup", + "kind": "objects", + "href": "/graphql/reference/objects#reactiongroup" + }, + { + "name": "reactions", + "description": "

A list of Reactions left on the Issue.

", + "type": "ReactionConnection!", + "id": "reactionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#reactionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "content", + "description": "

Allows filtering Reactions by emoji.

", + "type": { + "name": "ReactionContent", + "id": "reactioncontent", + "kind": "enums", + "href": "/graphql/reference/enums#reactioncontent" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Allows specifying the order in which reactions are returned.

", + "type": { + "name": "ReactionOrder", + "id": "reactionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#reactionorder" + } + } + ] + }, + { + "name": "repository", + "description": "

The repository associated with this node.

", + "type": "Repository!", + "id": "repository", + "kind": "objects", + "href": "/graphql/reference/objects#repository" + }, + { + "name": "resourcePath", + "description": "

The path for this discussion.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "title", + "description": "

The title of this discussion.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "updatedAt", + "description": "

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

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "upvoteCount", + "description": "

Number of upvotes that this subject has received.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "url", + "description": "

The URL for this discussion.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "userContentEdits", + "description": "

A list of edits to this content.

", + "type": "UserContentEditConnection", + "id": "usercontenteditconnection", + "kind": "objects", + "href": "/graphql/reference/objects#usercontenteditconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "viewerCanDelete", + "description": "

Check if the current viewer can delete this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanReact", + "description": "

Can user react to this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanSubscribe", + "description": "

Check if the viewer is able to change their subscription status for the repository.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUpdate", + "description": "

Check if the current viewer can update this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUpvote", + "description": "

Whether or not the current user can add or remove an upvote on this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerDidAuthor", + "description": "

Did the viewer author this comment.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerHasUpvoted", + "description": "

Whether or not the current user has already upvoted this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerSubscription", + "description": "

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

", + "type": "SubscriptionState", + "id": "subscriptionstate", + "kind": "enums", + "href": "/graphql/reference/enums#subscriptionstate" + } + ] + }, + { + "name": "DiscussionCategory", + "kind": "objects", + "id": "discussioncategory", + "href": "/graphql/reference/objects#discussioncategory", + "description": "

A category for discussions in a repository.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + }, + { + "name": "RepositoryNode", + "id": "repositorynode", + "href": "/graphql/reference/interfaces#repositorynode" + } + ], + "fields": [ + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "description", + "description": "

A description of this category.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "emoji", + "description": "

An emoji representing this category.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "emojiHTML", + "description": "

This category's emoji rendered as HTML.

", + "type": "HTML!", + "id": "html", + "kind": "scalars", + "href": "/graphql/reference/scalars#html" + }, + { + "name": "isAnswerable", + "description": "

Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "name", + "description": "

The name of this category.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "repository", + "description": "

The repository associated with this node.

", + "type": "Repository!", + "id": "repository", + "kind": "objects", + "href": "/graphql/reference/objects#repository" + }, + { + "name": "updatedAt", + "description": "

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

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + } + ] + }, + { + "name": "DiscussionCategoryConnection", + "kind": "objects", + "id": "discussioncategoryconnection", + "href": "/graphql/reference/objects#discussioncategoryconnection", + "description": "

The connection type for DiscussionCategory.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DiscussionCategoryEdge]", + "id": "discussioncategoryedge", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncategoryedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[DiscussionCategory]", + "id": "discussioncategory", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncategory" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DiscussionCategoryEdge", + "kind": "objects", + "id": "discussioncategoryedge", + "href": "/graphql/reference/objects#discussioncategoryedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "DiscussionCategory", + "id": "discussioncategory", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncategory" + } + ] + }, + { + "name": "DiscussionComment", + "kind": "objects", + "id": "discussioncomment", + "href": "/graphql/reference/objects#discussioncomment", + "description": "

A comment on a discussion.

", + "implements": [ + { + "name": "Comment", + "id": "comment", + "href": "/graphql/reference/interfaces#comment" + }, + { + "name": "Deletable", + "id": "deletable", + "href": "/graphql/reference/interfaces#deletable" + }, + { + "name": "Minimizable", + "id": "minimizable", + "href": "/graphql/reference/interfaces#minimizable" + }, + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + }, + { + "name": "Reactable", + "id": "reactable", + "href": "/graphql/reference/interfaces#reactable" + }, + { + "name": "Updatable", + "id": "updatable", + "href": "/graphql/reference/interfaces#updatable" + }, + { + "name": "UpdatableComment", + "id": "updatablecomment", + "href": "/graphql/reference/interfaces#updatablecomment" + }, + { + "name": "Votable", + "id": "votable", + "href": "/graphql/reference/interfaces#votable" + } + ], + "fields": [ + { + "name": "author", + "description": "

The actor who authored the comment.

", + "type": "Actor", + "id": "actor", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#actor" + }, + { + "name": "authorAssociation", + "description": "

Author's association with the subject of the comment.

", + "type": "CommentAuthorAssociation!", + "id": "commentauthorassociation", + "kind": "enums", + "href": "/graphql/reference/enums#commentauthorassociation" + }, + { + "name": "body", + "description": "

The body as Markdown.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "bodyHTML", + "description": "

The body rendered to HTML.

", + "type": "HTML!", + "id": "html", + "kind": "scalars", + "href": "/graphql/reference/scalars#html" + }, + { + "name": "bodyText", + "description": "

The body rendered to text.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "createdViaEmail", + "description": "

Check if this comment was created via an email reply.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "deletedAt", + "description": "

The time when this replied-to comment was deleted.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "discussion", + "description": "

The discussion this comment was created in.

", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion" + }, + { + "name": "editor", + "description": "

The actor who edited the comment.

", + "type": "Actor", + "id": "actor", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#actor" + }, + { + "name": "includesCreatedEdit", + "description": "

Check if this comment was edited and includes an edit with the creation data.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "isAnswer", + "description": "

Has this comment been chosen as the answer of its discussion?.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "isMinimized", + "description": "

Returns whether or not a comment has been minimized.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "lastEditedAt", + "description": "

The moment the editor made the last edit.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "minimizedReason", + "description": "

Returns why the comment was minimized.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "publishedAt", + "description": "

Identifies when the comment was published at.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "reactionGroups", + "description": "

A list of reactions grouped by content left on the subject.

", + "type": "[ReactionGroup!]", + "id": "reactiongroup", + "kind": "objects", + "href": "/graphql/reference/objects#reactiongroup" + }, + { + "name": "reactions", + "description": "

A list of Reactions left on the Issue.

", + "type": "ReactionConnection!", + "id": "reactionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#reactionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "content", + "description": "

Allows filtering Reactions by emoji.

", + "type": { + "name": "ReactionContent", + "id": "reactioncontent", + "kind": "enums", + "href": "/graphql/reference/enums#reactioncontent" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Allows specifying the order in which reactions are returned.

", + "type": { + "name": "ReactionOrder", + "id": "reactionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#reactionorder" + } + } + ] + }, + { + "name": "replies", + "description": "

The threaded replies to this comment.

", + "type": "DiscussionCommentConnection!", + "id": "discussioncommentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncommentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "replyTo", + "description": "

The discussion comment this comment is a reply to.

", + "type": "DiscussionComment", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment" + }, + { + "name": "resourcePath", + "description": "

The path for this discussion comment.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "updatedAt", + "description": "

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

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "upvoteCount", + "description": "

Number of upvotes that this subject has received.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "url", + "description": "

The URL for this discussion comment.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "userContentEdits", + "description": "

A list of edits to this content.

", + "type": "UserContentEditConnection", + "id": "usercontenteditconnection", + "kind": "objects", + "href": "/graphql/reference/objects#usercontenteditconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "viewerCanDelete", + "description": "

Check if the current viewer can delete this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanMarkAsAnswer", + "description": "

Can the current user mark this comment as an answer?.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanMinimize", + "description": "

Check if the current viewer can minimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanReact", + "description": "

Can user react to this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUnmarkAsAnswer", + "description": "

Can the current user unmark this comment as an answer?.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUpdate", + "description": "

Check if the current viewer can update this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUpvote", + "description": "

Whether or not the current user can add or remove an upvote on this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCannotUpdateReasons", + "description": "

Reasons why the current viewer can not update this comment.

", + "type": "[CommentCannotUpdateReason!]!", + "id": "commentcannotupdatereason", + "kind": "enums", + "href": "/graphql/reference/enums#commentcannotupdatereason" + }, + { + "name": "viewerDidAuthor", + "description": "

Did the viewer author this comment.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerHasUpvoted", + "description": "

Whether or not the current user has already upvoted this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + ] + }, + { + "name": "DiscussionCommentConnection", + "kind": "objects", + "id": "discussioncommentconnection", + "href": "/graphql/reference/objects#discussioncommentconnection", + "description": "

The connection type for DiscussionComment.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DiscussionCommentEdge]", + "id": "discussioncommentedge", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncommentedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[DiscussionComment]", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DiscussionCommentEdge", + "kind": "objects", + "id": "discussioncommentedge", + "href": "/graphql/reference/objects#discussioncommentedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "DiscussionComment", + "id": "discussioncomment", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncomment" + } + ] + }, + { + "name": "DiscussionConnection", + "kind": "objects", + "id": "discussionconnection", + "href": "/graphql/reference/objects#discussionconnection", + "description": "

The connection type for Discussion.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[DiscussionEdge]", + "id": "discussionedge", + "kind": "objects", + "href": "/graphql/reference/objects#discussionedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[Discussion]", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "DiscussionEdge", + "kind": "objects", + "id": "discussionedge", + "href": "/graphql/reference/objects#discussionedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion" + } + ] + }, { "name": "Enterprise", "kind": "objects", @@ -13161,6 +16143,16 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" } + }, + { + "name": "membersOnly", + "description": "

Filter to external identities with valid org membership only.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } } ] }, @@ -13793,6 +16785,86 @@ } ] }, + { + "name": "domains", + "description": "

A list of domains owned by the enterprise.

", + "type": "VerifiableDomainConnection!", + "id": "verifiabledomainconnection", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomainconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "isApproved", + "description": "

Filter whether or not the domain is approved.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "isVerified", + "description": "

Filter whether or not the domain is verified.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for verifiable domains returned.

", + "type": { + "name": "VerifiableDomainOrder", + "id": "verifiabledomainorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#verifiabledomainorder" + } + } + ] + }, { "name": "ipAllowListEnabledSetting", "description": "

The setting value for whether the enterprise has an IP allow list enabled.

", @@ -13861,6 +16933,14 @@ } ] }, + { + "name": "ipAllowListForInstalledAppsEnabledSetting", + "description": "

The setting value for whether the enterprise has IP allow list configuration for installed GitHub Apps enabled.

", + "type": "IpAllowListForInstalledAppsEnabledSettingValue!", + "id": "ipallowlistforinstalledappsenabledsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue" + }, { "name": "isUpdatingDefaultRepositoryPermission", "description": "

Whether or not the default repository permission is currently being updated.

", @@ -14455,6 +17535,14 @@ } ] }, + { + "name": "notificationDeliveryRestrictionEnabledSetting", + "description": "

Indicates if email notification delivery for this enterprise is restricted to verified or approved domains.

", + "type": "NotificationRestrictionSettingValue!", + "id": "notificationrestrictionsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" + }, { "name": "organizationProjectsSetting", "description": "

The setting value for whether organization projects are enabled for organizations in this enterprise.

", @@ -15455,7 +18543,7 @@ "fields": [ { "name": "isPrivate", - "description": "

Identifies if the repository is private.

", + "description": "

Identifies if the repository is private or internal.

", "type": "Boolean!", "id": "boolean", "kind": "scalars", @@ -16430,6 +19518,154 @@ } ] }, + { + "name": "Environment", + "kind": "objects", + "id": "environment", + "href": "/graphql/reference/objects#environment", + "description": "

An environment.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + } + ], + "fields": [ + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "name", + "description": "

The name of the environment.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "protectionRules", + "description": "

The protection rules defined for this environment.

", + "type": "DeploymentProtectionRuleConnection!", + "id": "deploymentprotectionruleconnection", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentprotectionruleconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + } + ] + }, + { + "name": "EnvironmentConnection", + "kind": "objects", + "id": "environmentconnection", + "href": "/graphql/reference/objects#environmentconnection", + "description": "

The connection type for Environment.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[EnvironmentEdge]", + "id": "environmentedge", + "kind": "objects", + "href": "/graphql/reference/objects#environmentedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[Environment]", + "id": "environment", + "kind": "objects", + "href": "/graphql/reference/objects#environment" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "EnvironmentEdge", + "kind": "objects", + "id": "environmentedge", + "href": "/graphql/reference/objects#environmentedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "Environment", + "id": "environment", + "kind": "objects", + "href": "/graphql/reference/objects#environment" + } + ] + }, { "name": "ExternalIdentity", "kind": "objects", @@ -18916,6 +22152,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "titleHTML", + "description": "

Identifies the issue title rendered to HTML.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "updatedAt", "description": "

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

", @@ -19886,7 +23130,7 @@ "kind": "objects", "id": "label", "href": "/graphql/reference/objects#label", - "description": "

A label for categorizing Issues or Milestones with a given Repository.

", + "description": "

A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.

", "implements": [ { "name": "Node", @@ -20624,6 +23868,14 @@ } ] }, + { + "name": "claimant", + "description": "

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

", + "type": "User", + "id": "user", + "kind": "objects", + "href": "/graphql/reference/objects#user" + }, { "name": "createdAt", "description": "

Identifies the date and time when the object was created.

", @@ -27102,6 +30354,16 @@ "id": "projectowner", "href": "/graphql/reference/interfaces#projectowner" }, + { + "name": "RepositoryDiscussionAuthor", + "id": "repositorydiscussionauthor", + "href": "/graphql/reference/interfaces#repositorydiscussionauthor" + }, + { + "name": "RepositoryDiscussionCommentAuthor", + "id": "repositorydiscussioncommentauthor", + "href": "/graphql/reference/interfaces#repositorydiscussioncommentauthor" + }, { "name": "RepositoryOwner", "id": "repositoryowner", @@ -27261,6 +30523,86 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "domains", + "description": "

A list of domains owned by the organization.

", + "type": "VerifiableDomainConnection", + "id": "verifiabledomainconnection", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomainconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "isApproved", + "description": "

Filter by if the domain is approved.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "isVerified", + "description": "

Filter by if the domain is verified.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for verifiable domains returned.

", + "type": { + "name": "VerifiableDomainOrder", + "id": "verifiabledomainorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#verifiabledomainorder" + } + } + ] + }, { "name": "email", "description": "

The organization's public email.

", @@ -27337,9 +30679,17 @@ } ] }, + { + "name": "ipAllowListForInstalledAppsEnabledSetting", + "description": "

The setting value for whether the organization has IP allow list configuration for installed GitHub Apps enabled.

", + "type": "IpAllowListForInstalledAppsEnabledSettingValue!", + "id": "ipallowlistforinstalledappsenabledsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue" + }, { "name": "isVerified", - "description": "

Whether the organization has verified its profile email and website, always false on Enterprise.

", + "description": "

Whether the organization has verified its profile email and website.

", "type": "Boolean!", "id": "boolean", "kind": "scalars", @@ -27503,6 +30853,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#uri" }, + { + "name": "notificationDeliveryRestrictionEnabledSetting", + "description": "

Indicates if email notification delivery for this organization is restricted to verified or approved domains.

", + "type": "NotificationRestrictionSettingValue!", + "id": "notificationrestrictionsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" + }, { "name": "organizationBillingEmail", "description": "

The billing email for the organization.

", @@ -28025,6 +31383,157 @@ } ] }, + { + "name": "repositoryDiscussionComments", + "description": "

Discussion comments this user has authored.

", + "type": "DiscussionCommentConnection!", + "id": "discussioncommentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncommentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "onlyAnswers", + "defaultValue": false, + "description": "

Filter discussion comments to only those that were marked as the answer.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "repositoryId", + "description": "

Filter discussion comments to only those in a specific repository.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, + { + "name": "repositoryDiscussions", + "description": "

Discussions this user has started.

", + "type": "DiscussionConnection!", + "id": "discussionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "answered", + "description": "

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for discussions returned from the connection.

", + "type": { + "name": "DiscussionOrder", + "id": "discussionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#discussionorder" + } + }, + { + "name": "repositoryId", + "description": "

Filter discussions to only those in a specific repository.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, { "name": "requiresTwoFactorAuthentication", "description": "

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

", @@ -28620,6 +32129,16 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" } + }, + { + "name": "membersOnly", + "description": "

Filter to external identities with valid org membership only.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } } ] }, @@ -29841,6 +33360,165 @@ } ] }, + { + "name": "PinnedDiscussion", + "kind": "objects", + "id": "pinneddiscussion", + "href": "/graphql/reference/objects#pinneddiscussion", + "description": "

A Pinned Discussion is a discussion pinned to a repository's index page.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + }, + { + "name": "RepositoryNode", + "id": "repositorynode", + "href": "/graphql/reference/interfaces#repositorynode" + } + ], + "fields": [ + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "discussion", + "description": "

The discussion that was pinned.

", + "type": "Discussion!", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion" + }, + { + "name": "gradientStopColors", + "description": "

Color stops of the chosen gradient.

", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "pattern", + "description": "

Background texture pattern.

", + "type": "PinnedDiscussionPattern!", + "id": "pinneddiscussionpattern", + "kind": "enums", + "href": "/graphql/reference/enums#pinneddiscussionpattern" + }, + { + "name": "pinnedBy", + "description": "

The actor that pinned this discussion.

", + "type": "Actor!", + "id": "actor", + "kind": "interfaces", + "href": "/graphql/reference/interfaces#actor" + }, + { + "name": "preconfiguredGradient", + "description": "

Preconfigured background gradient option.

", + "type": "PinnedDiscussionGradient", + "id": "pinneddiscussiongradient", + "kind": "enums", + "href": "/graphql/reference/enums#pinneddiscussiongradient" + }, + { + "name": "repository", + "description": "

The repository associated with this node.

", + "type": "Repository!", + "id": "repository", + "kind": "objects", + "href": "/graphql/reference/objects#repository" + }, + { + "name": "updatedAt", + "description": "

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

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + } + ] + }, + { + "name": "PinnedDiscussionConnection", + "kind": "objects", + "id": "pinneddiscussionconnection", + "href": "/graphql/reference/objects#pinneddiscussionconnection", + "description": "

The connection type for PinnedDiscussion.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[PinnedDiscussionEdge]", + "id": "pinneddiscussionedge", + "kind": "objects", + "href": "/graphql/reference/objects#pinneddiscussionedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[PinnedDiscussion]", + "id": "pinneddiscussion", + "kind": "objects", + "href": "/graphql/reference/objects#pinneddiscussion" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "PinnedDiscussionEdge", + "kind": "objects", + "id": "pinneddiscussionedge", + "href": "/graphql/reference/objects#pinneddiscussionedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "PinnedDiscussion", + "id": "pinneddiscussion", + "kind": "objects", + "href": "/graphql/reference/objects#pinneddiscussion" + } + ] + }, { "name": "PinnedEvent", "kind": "objects", @@ -32920,6 +36598,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "titleHTML", + "description": "

Identifies the pull request title rendered to HTML.

", + "type": "HTML!", + "id": "html", + "kind": "scalars", + "href": "/graphql/reference/scalars#html" + }, { "name": "updatedAt", "description": "

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

", @@ -33058,6 +36744,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerLatestReview", + "description": "

The latest review given from the viewer.

", + "type": "PullRequestReview", + "id": "pullrequestreview", + "kind": "objects", + "href": "/graphql/reference/objects#pullrequestreview" + }, + { + "name": "viewerLatestReviewRequest", + "description": "

The person who has requested the viewer for review on this pull request.

", + "type": "ReviewRequest", + "id": "reviewrequest", + "kind": "objects", + "href": "/graphql/reference/objects#reviewrequest" + }, { "name": "viewerMergeBodyText", "description": "

The merge body text for the viewer and method.

", @@ -35049,6 +38751,39 @@ } ] }, + { + "name": "PullRequestTemplate", + "kind": "objects", + "id": "pullrequesttemplate", + "href": "/graphql/reference/objects#pullrequesttemplate", + "description": "

A repository pull request template.

", + "fields": [ + { + "name": "body", + "description": "

The body of the template.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "filename", + "description": "

The filename of the template.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "repository", + "description": "

The repository the template belongs to.

", + "type": "Repository!", + "id": "repository", + "kind": "objects", + "href": "/graphql/reference/objects#repository" + } + ] + }, { "name": "PullRequestTimelineConnection", "kind": "objects", @@ -35635,6 +39370,56 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "reactors", + "description": "

Reactors to the reaction subject with the emotion represented by this reaction group.

", + "type": "ReactorConnection!", + "id": "reactorconnection", + "kind": "objects", + "href": "/graphql/reference/objects#reactorconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "subject", "description": "

The subject that was reacted to.

", @@ -35691,7 +39476,9 @@ "href": "/graphql/reference/scalars#int" } } - ] + ], + "isDeprecated": true, + "deprecationReason": "

Reactors can now be mannequins, bots, and organizations. Use the reactors field instead. Removal on 2021-10-01 UTC.

" }, { "name": "viewerHasReacted", @@ -35703,6 +39490,80 @@ } ] }, + { + "name": "ReactorConnection", + "kind": "objects", + "id": "reactorconnection", + "href": "/graphql/reference/objects#reactorconnection", + "description": "

The connection type for Reactor.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[ReactorEdge]", + "id": "reactoredge", + "kind": "objects", + "href": "/graphql/reference/objects#reactoredge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[Reactor]", + "id": "reactor", + "kind": "unions", + "href": "/graphql/reference/unions#reactor" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "ReactorEdge", + "kind": "objects", + "id": "reactoredge", + "href": "/graphql/reference/objects#reactoredge", + "description": "

Represents an author of a reaction.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The author of the reaction.

", + "type": "Reactor!", + "id": "reactor", + "kind": "unions", + "href": "/graphql/reference/unions#reactor" + }, + { + "name": "reactedAt", + "description": "

The moment when the user made the reaction.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + } + ] + }, { "name": "ReadyForReviewEvent", "kind": "objects", @@ -36041,6 +39902,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "requiresCodeOwnerReviews", + "description": "

Are reviews from code owners required to update matching branches.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "requiresConversationResolution", + "description": "

Are conversations required to be resolved before merging.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "requiresLinearHistory", "description": "

Are merge commits prohibited from being pushed to this branch.

", @@ -36057,6 +39934,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerAllowedToDismissReviews", + "description": "

Is the viewer allowed to dismiss reviews.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanPush", "description": "

Can the viewer push to the branch.

", @@ -36151,6 +40036,11 @@ "id": "node", "href": "/graphql/reference/interfaces#node" }, + { + "name": "Reactable", + "id": "reactable", + "href": "/graphql/reference/interfaces#reactable" + }, { "name": "UniformResourceLocatable", "id": "uniformresourcelocatable", @@ -36174,6 +40064,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, { "name": "description", "description": "

The description of the release.

", @@ -36214,6 +40112,56 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "mentions", + "description": "

A list of users mentioned in the release description.

", + "type": "UserConnection", + "id": "userconnection", + "kind": "objects", + "href": "/graphql/reference/objects#userconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "name", "description": "

The title of the release.

", @@ -36230,6 +40178,84 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "reactionGroups", + "description": "

A list of reactions grouped by content left on the subject.

", + "type": "[ReactionGroup!]", + "id": "reactiongroup", + "kind": "objects", + "href": "/graphql/reference/objects#reactiongroup" + }, + { + "name": "reactions", + "description": "

A list of Reactions left on the Issue.

", + "type": "ReactionConnection!", + "id": "reactionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#reactionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "content", + "description": "

Allows filtering Reactions by emoji.

", + "type": { + "name": "ReactionContent", + "id": "reactioncontent", + "kind": "enums", + "href": "/graphql/reference/enums#reactioncontent" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Allows specifying the order in which reactions are returned.

", + "type": { + "name": "ReactionOrder", + "id": "reactionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#reactionorder" + } + } + ] + }, { "name": "releaseAssets", "description": "

List of releases assets which are dependent on this release.

", @@ -36366,6 +40392,14 @@ "id": "uri", "kind": "scalars", "href": "/graphql/reference/scalars#uri" + }, + { + "name": "viewerCanReact", + "description": "

Can user react to this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" } ] }, @@ -41160,6 +45194,146 @@ "kind": "scalars", "href": "/graphql/reference/scalars#html" }, + { + "name": "discussion", + "description": "

Returns a single discussion from the current repository by number.

", + "type": "Discussion", + "id": "discussion", + "kind": "objects", + "href": "/graphql/reference/objects#discussion", + "arguments": [ + { + "name": "number", + "description": "

The number for the discussion to be returned.

", + "type": { + "name": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "discussionCategories", + "description": "

A list of discussion categories that are available in the repository.

", + "type": "DiscussionCategoryConnection!", + "id": "discussioncategoryconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncategoryconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "discussions", + "description": "

A list of discussions that have been opened in the repository.

", + "type": "DiscussionConnection!", + "id": "discussionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "categoryId", + "description": "

Only include discussions that belong to the category with this ID.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for discussions returned from the connection.

", + "type": { + "name": "DiscussionOrder", + "id": "discussionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#discussionorder" + } + } + ] + }, { "name": "diskUsage", "description": "

The number of kilobytes this repository occupies on disk.

", @@ -41168,6 +45342,76 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" }, + { + "name": "environment", + "description": "

Returns a single active environment from the current repository by name.

", + "type": "Environment", + "id": "environment", + "kind": "objects", + "href": "/graphql/reference/objects#environment", + "arguments": [ + { + "name": "name", + "description": "

The name of the environment to be returned.

", + "type": { + "name": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + } + ] + }, + { + "name": "environments", + "description": "

A list of environments that are in this repository.

", + "type": "EnvironmentConnection!", + "id": "environmentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#environmentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "forkCount", "description": "

Returns how many forks there are of this repository in the whole network.

", @@ -41382,7 +45626,7 @@ }, { "name": "isPrivate", - "description": "

Identifies if the repository is private.

", + "description": "

Identifies if the repository is private or internal.

", "type": "Boolean!", "id": "boolean", "kind": "scalars", @@ -42060,6 +46304,56 @@ "kind": "objects", "href": "/graphql/reference/objects#repository" }, + { + "name": "pinnedDiscussions", + "description": "

A list of discussions that have been pinned in this repository.

", + "type": "PinnedDiscussionConnection!", + "id": "pinneddiscussionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#pinneddiscussionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "pinnedIssues", "description": "

A list of pinned issues for this repository.

", @@ -42254,6 +46548,14 @@ } ] }, + { + "name": "pullRequestTemplates", + "description": "

Returns a list of pull request templates associated to the repository.

", + "type": "[PullRequestTemplate!]", + "id": "pullrequesttemplate", + "kind": "objects", + "href": "/graphql/reference/objects#pullrequesttemplate" + }, { "name": "pullRequests", "description": "

A list of pull requests that have been opened in the repository.

", @@ -43812,7 +48114,7 @@ "kind": "objects", "id": "repositoryvulnerabilityalert", "href": "/graphql/reference/objects#repositoryvulnerabilityalert", - "description": "

A alert for a repository with an affected vulnerability.

", + "description": "

A Dependabot alert for a repository with a dependency affected by a security vulnerability.

", "implements": [ { "name": "Node", @@ -44624,6 +48926,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" }, + { + "name": "discussionCount", + "description": "

The number of discussions that matched the search query.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, { "name": "edges", "description": "

A list of edges.

", @@ -45340,6 +49650,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "isOneTimePayment", + "description": "

Whether this sponsorship represents a one-time payment versus a recurring sponsorship.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "maintainer", "description": "

The entity that is being sponsored.

", @@ -45383,6 +49701,14 @@ "id": "sponsorable", "kind": "interfaces", "href": "/graphql/reference/interfaces#sponsorable" + }, + { + "name": "tierSelectedAt", + "description": "

Identifies the date and time when the current tier was chosen for this sponsorship.

", + "type": "DateTime", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" } ] }, @@ -45861,6 +50187,11 @@ "name": "Node", "id": "node", "href": "/graphql/reference/interfaces#node" + }, + { + "name": "RequirableByPullRequest", + "id": "requirablebypullrequest", + "href": "/graphql/reference/interfaces#requirablebypullrequest" } ], "fields": [ @@ -45925,6 +50256,36 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "isRequired", + "description": "

Whether this is required to pass before merging for a specific pull request.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

The id of the pull request this is required for.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + }, + { + "name": "pullRequestNumber", + "description": "

The number of the pull request this is required for.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, { "name": "state", "description": "

The state of this status context.

", @@ -50245,6 +54606,16 @@ "id": "projectowner", "href": "/graphql/reference/interfaces#projectowner" }, + { + "name": "RepositoryDiscussionAuthor", + "id": "repositorydiscussionauthor", + "href": "/graphql/reference/interfaces#repositorydiscussionauthor" + }, + { + "name": "RepositoryDiscussionCommentAuthor", + "id": "repositorydiscussioncommentauthor", + "href": "/graphql/reference/interfaces#repositorydiscussioncommentauthor" + }, { "name": "RepositoryOwner", "id": "repositoryowner", @@ -50318,6 +54689,26 @@ "kind": "scalars", "href": "/graphql/reference/scalars#html" }, + { + "name": "canReceiveOrganizationEmailsWhenNotificationsRestricted", + "description": "

Could this user receive email notifications, if the organization had notification restrictions enabled?.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "login", + "description": "

The login of the organization to check.

", + "type": { + "name": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + } + ] + }, { "name": "commitComments", "description": "

A list of commit comments made by this user.

", @@ -50414,7 +54805,7 @@ }, { "name": "to", - "description": "

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

", + "description": "

Only contributions made before and up to (including) this time will be\ncounted. If omitted, defaults to the current time or one year from the\nprovided from argument.

", "type": { "name": "DateTime", "id": "datetime", @@ -51758,6 +56149,157 @@ } ] }, + { + "name": "repositoryDiscussionComments", + "description": "

Discussion comments this user has authored.

", + "type": "DiscussionCommentConnection!", + "id": "discussioncommentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncommentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "onlyAnswers", + "defaultValue": false, + "description": "

Filter discussion comments to only those that were marked as the answer.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "repositoryId", + "description": "

Filter discussion comments to only those in a specific repository.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, + { + "name": "repositoryDiscussions", + "description": "

Discussions this user has started.

", + "type": "DiscussionConnection!", + "id": "discussionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "answered", + "description": "

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for discussions returned from the connection.

", + "type": { + "name": "DiscussionOrder", + "id": "discussionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#discussionorder" + } + }, + { + "name": "repositoryId", + "description": "

Filter discussions to only those in a specific repository.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + }, { "name": "resourcePath", "description": "

The HTTP path for this user.

", @@ -52610,14 +57152,6 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, - { - "name": "id", - "description": "

ID of the object.

", - "type": "ID!", - "id": "id", - "kind": "scalars", - "href": "/graphql/reference/scalars#id" - }, { "name": "indicatesLimitedAvailability", "description": "

Whether this status indicates the user is not fully available on GitHub.

", @@ -52731,7 +57265,7 @@ "kind": "objects", "id": "verifiabledomain", "href": "/graphql/reference/objects#verifiabledomain", - "description": "

A domain that can be verified for an organization or an enterprise.

", + "description": "

A domain that can be verified or approved for an organization or an enterprise.

", "implements": [ { "name": "Node", @@ -52788,6 +57322,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isApproved", + "description": "

Whether or not the domain is approved.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isRequiredForPolicyEnforcement", "description": "

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

", @@ -52846,6 +57388,72 @@ } ] }, + { + "name": "VerifiableDomainConnection", + "kind": "objects", + "id": "verifiabledomainconnection", + "href": "/graphql/reference/objects#verifiabledomainconnection", + "description": "

The connection type for VerifiableDomain.

", + "fields": [ + { + "name": "edges", + "description": "

A list of edges.

", + "type": "[VerifiableDomainEdge]", + "id": "verifiabledomainedge", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomainedge" + }, + { + "name": "nodes", + "description": "

A list of nodes.

", + "type": "[VerifiableDomain]", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain" + }, + { + "name": "pageInfo", + "description": "

Information to aid in pagination.

", + "type": "PageInfo!", + "id": "pageinfo", + "kind": "objects", + "href": "/graphql/reference/objects#pageinfo" + }, + { + "name": "totalCount", + "description": "

Identifies the total count of items in the connection.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, + { + "name": "VerifiableDomainEdge", + "kind": "objects", + "id": "verifiabledomainedge", + "href": "/graphql/reference/objects#verifiabledomainedge", + "description": "

An edge in a connection.

", + "fields": [ + { + "name": "cursor", + "description": "

A cursor for use in pagination.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "node", + "description": "

The item at the end of the edge.

", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain" + } + ] + }, { "name": "ViewerHovercardContext", "kind": "objects", @@ -52885,6 +57493,234 @@ "href": "/graphql/reference/objects#user" } ] + }, + { + "name": "Workflow", + "kind": "objects", + "id": "workflow", + "href": "/graphql/reference/objects#workflow", + "description": "

A workflow contains meta information about an Actions workflow file.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + } + ], + "fields": [ + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "name", + "description": "

The name of the workflow.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "updatedAt", + "description": "

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

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + } + ] + }, + { + "name": "WorkflowRun", + "kind": "objects", + "id": "workflowrun", + "href": "/graphql/reference/objects#workflowrun", + "description": "

A workflow run.

", + "implements": [ + { + "name": "Node", + "id": "node", + "href": "/graphql/reference/interfaces#node" + } + ], + "fields": [ + { + "name": "checkSuite", + "description": "

The check suite this workflow run belongs to.

", + "type": "CheckSuite!", + "id": "checksuite", + "kind": "objects", + "href": "/graphql/reference/objects#checksuite" + }, + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "databaseId", + "description": "

Identifies the primary key from the database.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "deploymentReviews", + "description": "

The log of deployment reviews.

", + "type": "DeploymentReviewConnection!", + "id": "deploymentreviewconnection", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentreviewconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "pendingDeploymentRequests", + "description": "

The pending deployment requests of all check runs in this workflow run.

", + "type": "DeploymentRequestConnection!", + "id": "deploymentrequestconnection", + "kind": "objects", + "href": "/graphql/reference/objects#deploymentrequestconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "resourcePath", + "description": "

The HTTP path for this workflow run.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "runNumber", + "description": "

A number that uniquely identifies this workflow run in its parent workflow.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "updatedAt", + "description": "

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

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, + { + "name": "url", + "description": "

The HTTP URL for this workflow run.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "workflow", + "description": "

The workflow executed in this workflow run.

", + "type": "Workflow!", + "id": "workflow", + "kind": "objects", + "href": "/graphql/reference/objects#workflow" + } + ] } ], "interfaces": [ @@ -54415,6 +59251,175 @@ } ] }, + { + "name": "RepositoryDiscussionAuthor", + "kind": "interfaces", + "id": "repositorydiscussionauthor", + "href": "/graphql/reference/interfaces#repositorydiscussionauthor", + "description": "

Represents an author of discussions in repositories.

", + "fields": [ + { + "name": "repositoryDiscussions", + "description": "

Discussions this user has started.

", + "type": "DiscussionConnection!", + "id": "discussionconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussionconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "answered", + "description": "

Filter discussions to only those that have been answered or not. Defaults to\nincluding both answered and unanswered discussions.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "

Ordering options for discussions returned from the connection.

", + "type": { + "name": "DiscussionOrder", + "id": "discussionorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#discussionorder" + } + }, + { + "name": "repositoryId", + "description": "

Filter discussions to only those in a specific repository.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + } + ] + }, + { + "name": "RepositoryDiscussionCommentAuthor", + "kind": "interfaces", + "id": "repositorydiscussioncommentauthor", + "href": "/graphql/reference/interfaces#repositorydiscussioncommentauthor", + "description": "

Represents an author of discussion comments in repositories.

", + "fields": [ + { + "name": "repositoryDiscussionComments", + "description": "

Discussion comments this user has authored.

", + "type": "DiscussionCommentConnection!", + "id": "discussioncommentconnection", + "kind": "objects", + "href": "/graphql/reference/objects#discussioncommentconnection", + "arguments": [ + { + "name": "after", + "description": "

Returns the elements in the list that come after the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "

Returns the elements in the list that come before the specified cursor.

", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "

Returns the first n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "

Returns the last n elements from the list.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "onlyAnswers", + "defaultValue": false, + "description": "

Filter discussion comments to only those that were marked as the answer.

", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + }, + { + "name": "repositoryId", + "description": "

Filter discussion comments to only those in a specific repository.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + } + ] + } + ] + }, { "name": "RepositoryInfo", "kind": "interfaces", @@ -54536,7 +59541,7 @@ }, { "name": "isPrivate", - "description": "

Identifies if the repository is private.

", + "description": "

Identifies if the repository is private or internal.

", "type": "Boolean!", "id": "boolean", "kind": "scalars", @@ -54869,6 +59874,45 @@ } ] }, + { + "name": "RequirableByPullRequest", + "kind": "interfaces", + "id": "requirablebypullrequest", + "href": "/graphql/reference/interfaces#requirablebypullrequest", + "description": "

Represents a type that can be required by a pull request for merging.

", + "fields": [ + { + "name": "isRequired", + "description": "

Whether this is required to pass before merging for a specific pull request.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean", + "arguments": [ + { + "name": "pullRequestId", + "description": "

The id of the pull request this is required for.

", + "type": { + "name": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + } + }, + { + "name": "pullRequestNumber", + "description": "

The number of the pull request this is required for.

", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + } + ] + }, { "name": "Sponsorable", "kind": "interfaces", @@ -55243,6 +60287,39 @@ "href": "/graphql/reference/enums#commentcannotupdatereason" } ] + }, + { + "name": "Votable", + "kind": "interfaces", + "id": "votable", + "href": "/graphql/reference/interfaces#votable", + "description": "

A subject that may be upvoted.

", + "fields": [ + { + "name": "upvoteCount", + "description": "

Number of upvotes that this subject has received.

", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "viewerCanUpvote", + "description": "

Whether or not the current user can add or remove an upvote on this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerHasUpvoted", + "description": "

Whether or not the current user has already upvoted this subject.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + ] } ], "enums": [ @@ -55357,6 +60434,10 @@ "name": "IN_PROGRESS", "description": "

The check suite or run is in progress.

" }, + { + "name": "PENDING", + "description": "

The check suite or run is in pending state.

" + }, { "name": "QUEUED", "description": "

The check suite or run has been queued.

" @@ -55554,6 +60635,40 @@ } ] }, + { + "name": "DeploymentProtectionRuleType", + "kind": "enums", + "id": "deploymentprotectionruletype", + "href": "/graphql/reference/enums#deploymentprotectionruletype", + "description": "

The possible protection rule types.

", + "values": [ + { + "name": "REQUIRED_REVIEWERS", + "description": "

Required reviewers.

" + }, + { + "name": "WAIT_TIMER", + "description": "

Wait timer.

" + } + ] + }, + { + "name": "DeploymentReviewState", + "kind": "enums", + "id": "deploymentreviewstate", + "href": "/graphql/reference/enums#deploymentreviewstate", + "description": "

The possible states for a deployment review.

", + "values": [ + { + "name": "APPROVED", + "description": "

The deployment was approved.

" + }, + { + "name": "REJECTED", + "description": "

The deployment was rejected.

" + } + ] + }, { "name": "DeploymentState", "kind": "enums", @@ -55661,6 +60776,23 @@ } ] }, + { + "name": "DiscussionOrderField", + "kind": "enums", + "id": "discussionorderfield", + "href": "/graphql/reference/enums#discussionorderfield", + "description": "

Properties by which discussion connections can be ordered.

", + "values": [ + { + "name": "CREATED_AT", + "description": "

Order discussions by creation time.

" + }, + { + "name": "UPDATED_AT", + "description": "

Order discussions by most recent modification time.

" + } + ] + }, { "name": "EnterpriseAdministratorInvitationOrderField", "kind": "enums", @@ -56114,6 +61246,23 @@ } ] }, + { + "name": "IpAllowListForInstalledAppsEnabledSettingValue", + "kind": "enums", + "id": "ipallowlistforinstalledappsenabledsettingvalue", + "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue", + "description": "

The possible values for the IP allow list configuration for installed GitHub Apps setting.

", + "values": [ + { + "name": "DISABLED", + "description": "

The setting is disabled for the owner.

" + }, + { + "name": "ENABLED", + "description": "

The setting is enabled for the owner.

" + } + ] + }, { "name": "IssueCommentOrderField", "kind": "enums", @@ -56453,6 +61602,23 @@ } ] }, + { + "name": "NotificationRestrictionSettingValue", + "kind": "enums", + "id": "notificationrestrictionsettingvalue", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue", + "description": "

The possible values for the notification restriction setting.

", + "values": [ + { + "name": "DISABLED", + "description": "

The setting is disabled for the owner.

" + }, + { + "name": "ENABLED", + "description": "

The setting is enabled for the owner.

" + } + ] + }, { "name": "OauthApplicationCreateAuditEntryState", "kind": "enums", @@ -56988,6 +62154,68 @@ } ] }, + { + "name": "PinnedDiscussionGradient", + "kind": "enums", + "id": "pinneddiscussiongradient", + "href": "/graphql/reference/enums#pinneddiscussiongradient", + "description": "

Preconfigured gradients that may be used to style discussions pinned within a repository.

", + "values": [ + { + "name": "BLUE_MINT", + "description": "

A gradient of blue to mint.

" + }, + { + "name": "BLUE_PURPLE", + "description": "

A gradient of blue to purple.

" + }, + { + "name": "PINK_BLUE", + "description": "

A gradient of pink to blue.

" + }, + { + "name": "PURPLE_CORAL", + "description": "

A gradient of purple to coral.

" + }, + { + "name": "RED_ORANGE", + "description": "

A gradient of red to orange.

" + } + ] + }, + { + "name": "PinnedDiscussionPattern", + "kind": "enums", + "id": "pinneddiscussionpattern", + "href": "/graphql/reference/enums#pinneddiscussionpattern", + "description": "

Preconfigured background patterns that may be used to style discussions pinned within a repository.

", + "values": [ + { + "name": "CHEVRON_UP", + "description": "

An upward-facing chevron pattern.

" + }, + { + "name": "DOT", + "description": "

A hollow dot pattern.

" + }, + { + "name": "DOT_FILL", + "description": "

A solid dot pattern.

" + }, + { + "name": "HEART_FILL", + "description": "

A heart pattern.

" + }, + { + "name": "PLUS", + "description": "

A plus sign pattern.

" + }, + { + "name": "ZAP", + "description": "

A lightning bolt pattern.

" + } + ] + }, { "name": "ProjectCardArchivedState", "kind": "enums", @@ -57970,6 +63198,10 @@ "name": "IN_PROGRESS", "description": "

The check suite or run is in progress.

" }, + { + "name": "PENDING", + "description": "

The check suite or run is in pending state.

" + }, { "name": "QUEUED", "description": "

The check suite or run has been queued.

" @@ -58050,6 +63282,10 @@ "href": "/graphql/reference/enums#searchtype", "description": "

Represents the individual results of a search.

", "values": [ + { + "name": "DISCUSSION", + "description": "

Returns matching discussions in repositories.

" + }, { "name": "ISSUE", "description": "

Returns results matching issues in repositories.

" @@ -58075,6 +63311,10 @@ "name": "COMPOSER", "description": "

PHP packages hosted at packagist.org.

" }, + { + "name": "GO", + "description": "

Go modules.

" + }, { "name": "MAVEN", "description": "

Java artifacts hosted at the Maven central repository.

" @@ -58087,6 +63327,10 @@ "name": "NUGET", "description": "

.NET packages hosted at the NuGet Gallery.

" }, + { + "name": "OTHER", + "description": "

Applications, runtimes, operating systems and other kinds of software.

" + }, { "name": "PIP", "description": "

Python packages hosted at PyPI.org.

" @@ -58440,6 +63684,23 @@ "description": "

Order user statuses by when they were updated.

" } ] + }, + { + "name": "VerifiableDomainOrderField", + "kind": "enums", + "id": "verifiabledomainorderfield", + "href": "/graphql/reference/enums#verifiabledomainorderfield", + "description": "

Properties by which verifiable domain connections can be ordered.

", + "values": [ + { + "name": "CREATED_AT", + "description": "

Order verifiable domains by their creation date.

" + }, + { + "name": "DOMAIN", + "description": "

Order verifiable domains by the domain name.

" + } + ] } ], "unions": [ @@ -58572,6 +63833,25 @@ } ] }, + { + "name": "DeploymentReviewer", + "kind": "unions", + "id": "deploymentreviewer", + "href": "/graphql/reference/unions#deploymentreviewer", + "description": "

Users and teams.

", + "possibleTypes": [ + { + "name": "Team", + "id": "team", + "href": "/graphql/reference/objects#team" + }, + { + "name": "User", + "id": "user", + "href": "/graphql/reference/objects#user" + } + ] + }, { "name": "EnterpriseMember", "kind": "unions", @@ -58598,6 +63878,11 @@ "href": "/graphql/reference/unions#ipallowlistowner", "description": "

Types that can own an IP allow list.

", "possibleTypes": [ + { + "name": "App", + "id": "app", + "href": "/graphql/reference/objects#app" + }, { "name": "Enterprise", "id": "enterprise", @@ -59778,6 +65063,35 @@ } ] }, + { + "name": "Reactor", + "kind": "unions", + "id": "reactor", + "href": "/graphql/reference/unions#reactor", + "description": "

Types that can be assigned to reactions.

", + "possibleTypes": [ + { + "name": "Bot", + "id": "bot", + "href": "/graphql/reference/objects#bot" + }, + { + "name": "Mannequin", + "id": "mannequin", + "href": "/graphql/reference/objects#mannequin" + }, + { + "name": "Organization", + "id": "organization", + "href": "/graphql/reference/objects#organization" + }, + { + "name": "User", + "id": "user", + "href": "/graphql/reference/objects#user" + } + ] + }, { "name": "ReferencedSubject", "kind": "unions", @@ -59871,6 +65185,11 @@ "id": "app", "href": "/graphql/reference/objects#app" }, + { + "name": "Discussion", + "id": "discussion", + "href": "/graphql/reference/objects#discussion" + }, { "name": "Issue", "id": "issue", @@ -60026,6 +65345,49 @@ } ] }, + { + "name": "AddDiscussionCommentInput", + "kind": "inputObjects", + "id": "adddiscussioncommentinput", + "href": "/graphql/reference/input-objects#adddiscussioncommentinput", + "description": "

Autogenerated input type of AddDiscussionComment.

", + "inputFields": [ + { + "name": "body", + "description": "

The contents of the comment.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "discussionId", + "description": "

The Node ID of the discussion to comment on.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "replyToId", + "description": "

The Node ID of the discussion comment within this discussion to reply to.

", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "AddEnterpriseAdminInput", "kind": "inputObjects", @@ -60457,6 +65819,134 @@ } ] }, + { + "name": "AddUpvoteInput", + "kind": "inputObjects", + "id": "addupvoteinput", + "href": "/graphql/reference/input-objects#addupvoteinput", + "description": "

Autogenerated input type of AddUpvote.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "subjectId", + "description": "

The Node ID of the discussion or comment to upvote.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "AddVerifiableDomainInput", + "kind": "inputObjects", + "id": "addverifiabledomaininput", + "href": "/graphql/reference/input-objects#addverifiabledomaininput", + "description": "

Autogenerated input type of AddVerifiableDomain.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "domain", + "description": "

The URL of the domain.

", + "type": "URI!", + "id": "uri", + "kind": "scalars", + "href": "/graphql/reference/scalars#uri" + }, + { + "name": "ownerId", + "description": "

The ID of the owner to add the domain to.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "ApproveDeploymentsInput", + "kind": "inputObjects", + "id": "approvedeploymentsinput", + "href": "/graphql/reference/input-objects#approvedeploymentsinput", + "description": "

Autogenerated input type of ApproveDeployments.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "comment", + "description": "

Optional comment for approving deployments.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "environmentIds", + "description": "

The ids of environments to reject deployments.

", + "type": "[ID!]!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + }, + { + "name": "workflowRunId", + "description": "

The node ID of the workflow run containing the pending deployments.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "ApproveVerifiableDomainInput", + "kind": "inputObjects", + "id": "approveverifiabledomaininput", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput", + "description": "

Autogenerated input type of ApproveVerifiableDomain.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The ID of the verifiable domain to approve.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ArchiveRepositoryInput", "kind": "inputObjects", @@ -61200,6 +66690,32 @@ } ] }, + { + "name": "ConvertPullRequestToDraftInput", + "kind": "inputObjects", + "id": "convertpullrequesttodraftinput", + "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput", + "description": "

Autogenerated input type of ConvertPullRequestToDraft.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "pullRequestId", + "description": "

ID of the pull request to convert to draft.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "CreateBranchProtectionRuleInput", "kind": "inputObjects", @@ -61312,6 +66828,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "requiresConversationResolution", + "description": "

Are conversations required to be resolved before merging.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "requiresLinearHistory", "description": "

Are merge commits prohibited from being pushed to this branch.

", @@ -61561,7 +67085,7 @@ "Mutation.createDeployment" ], "owning_teams": [ - "@github/ecosystem-api" + "@github/c2c-actions-service" ], "accept_header": "application/vnd.github.flash-preview+json", "href": "/graphql/overview/schema-previews#deployments-preview" @@ -61660,7 +67184,7 @@ "Mutation.createDeployment" ], "owning_teams": [ - "@github/ecosystem-api" + "@github/c2c-actions-service" ], "accept_header": "application/vnd.github.flash-preview+json", "href": "/graphql/overview/schema-previews#deployments-preview" @@ -61733,6 +67257,57 @@ } ] }, + { + "name": "CreateDiscussionInput", + "kind": "inputObjects", + "id": "creatediscussioninput", + "href": "/graphql/reference/input-objects#creatediscussioninput", + "description": "

Autogenerated input type of CreateDiscussion.

", + "inputFields": [ + { + "name": "body", + "description": "

The body of the discussion.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "categoryId", + "description": "

The id of the discussion category to associate with this discussion.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "repositoryId", + "description": "

The id of the repository on which to create the discussion.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "title", + "description": "

The title of the discussion.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "CreateEnterpriseOrganizationInput", "kind": "inputObjects", @@ -61791,6 +67366,40 @@ } ] }, + { + "name": "CreateEnvironmentInput", + "kind": "inputObjects", + "id": "createenvironmentinput", + "href": "/graphql/reference/input-objects#createenvironmentinput", + "description": "

Autogenerated input type of CreateEnvironment.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "name", + "description": "

The name of the environment.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "repositoryId", + "description": "

The node ID of the repository.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "CreateIpAllowListEntryInput", "kind": "inputObjects", @@ -62395,6 +68004,84 @@ } ] }, + { + "name": "DeleteDiscussionCommentInput", + "kind": "inputObjects", + "id": "deletediscussioncommentinput", + "href": "/graphql/reference/input-objects#deletediscussioncommentinput", + "description": "

Autogenerated input type of DeleteDiscussionComment.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The Node id of the discussion comment to delete.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "DeleteDiscussionInput", + "kind": "inputObjects", + "id": "deletediscussioninput", + "href": "/graphql/reference/input-objects#deletediscussioninput", + "description": "

Autogenerated input type of DeleteDiscussion.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The id of the discussion to delete.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "DeleteEnvironmentInput", + "kind": "inputObjects", + "id": "deleteenvironmentinput", + "href": "/graphql/reference/input-objects#deleteenvironmentinput", + "description": "

Autogenerated input type of DeleteEnvironment.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The Node ID of the environment to be deleted.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "DeleteIpAllowListEntryInput", "kind": "inputObjects", @@ -62749,6 +68436,32 @@ } ] }, + { + "name": "DeleteVerifiableDomainInput", + "kind": "inputObjects", + "id": "deleteverifiabledomaininput", + "href": "/graphql/reference/input-objects#deleteverifiabledomaininput", + "description": "

Autogenerated input type of DeleteVerifiableDomain.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The ID of the verifiable domain to delete.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "DeploymentOrder", "kind": "inputObjects", @@ -62800,6 +68513,31 @@ } ] }, + { + "name": "DiscussionOrder", + "kind": "inputObjects", + "id": "discussionorder", + "href": "/graphql/reference/input-objects#discussionorder", + "description": "

Ways in which lists of discussions can be ordered upon return.

", + "inputFields": [ + { + "name": "direction", + "description": "

The direction in which to order discussions by the specified field.

", + "type": "OrderDirection!", + "id": "orderdirection", + "kind": "enums", + "href": "/graphql/reference/enums#orderdirection" + }, + { + "name": "field", + "description": "

The field by which to order discussions.

", + "type": "DiscussionOrderField!", + "id": "discussionorderfield", + "kind": "enums", + "href": "/graphql/reference/enums#discussionorderfield" + } + ] + }, { "name": "DismissPullRequestReviewInput", "kind": "inputObjects", @@ -63482,6 +69220,32 @@ } ] }, + { + "name": "MarkDiscussionCommentAsAnswerInput", + "kind": "inputObjects", + "id": "markdiscussioncommentasanswerinput", + "href": "/graphql/reference/input-objects#markdiscussioncommentasanswerinput", + "description": "

Autogenerated input type of MarkDiscussionCommentAsAnswer.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The Node ID of the discussion comment to mark as an answer.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "MarkFileAsViewedInput", "kind": "inputObjects", @@ -64137,6 +69901,74 @@ } ] }, + { + "name": "RegenerateVerifiableDomainTokenInput", + "kind": "inputObjects", + "id": "regenerateverifiabledomaintokeninput", + "href": "/graphql/reference/input-objects#regenerateverifiabledomaintokeninput", + "description": "

Autogenerated input type of RegenerateVerifiableDomainToken.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The ID of the verifiable domain to regenerate the verification token of.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "RejectDeploymentsInput", + "kind": "inputObjects", + "id": "rejectdeploymentsinput", + "href": "/graphql/reference/input-objects#rejectdeploymentsinput", + "description": "

Autogenerated input type of RejectDeployments.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "comment", + "description": "

Optional comment for rejecting deployments.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "environmentIds", + "description": "

The ids of environments to reject deployments.

", + "type": "[ID!]!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + }, + { + "name": "workflowRunId", + "description": "

The node ID of the workflow run containing the pending deployments.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ReleaseOrder", "kind": "inputObjects", @@ -64361,6 +70193,32 @@ } ] }, + { + "name": "RemoveUpvoteInput", + "kind": "inputObjects", + "id": "removeupvoteinput", + "href": "/graphql/reference/input-objects#removeupvoteinput", + "description": "

Autogenerated input type of RemoveUpvote.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "subjectId", + "description": "

The Node ID of the discussion or comment to remove upvote.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ReopenIssueInput", "kind": "inputObjects", @@ -64967,6 +70825,32 @@ } ] }, + { + "name": "UnmarkDiscussionCommentAsAnswerInput", + "kind": "inputObjects", + "id": "unmarkdiscussioncommentasanswerinput", + "href": "/graphql/reference/input-objects#unmarkdiscussioncommentasanswerinput", + "description": "

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The Node ID of the discussion comment to unmark as an answer.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "UnmarkFileAsViewedInput", "kind": "inputObjects", @@ -65226,6 +71110,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "requiresConversationResolution", + "description": "

Are conversations required to be resolved before merging.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "requiresLinearHistory", "description": "

Are merge commits prohibited from being pushed to this branch.

", @@ -65417,6 +71309,91 @@ } ] }, + { + "name": "UpdateDiscussionCommentInput", + "kind": "inputObjects", + "id": "updatediscussioncommentinput", + "href": "/graphql/reference/input-objects#updatediscussioncommentinput", + "description": "

Autogenerated input type of UpdateDiscussionComment.

", + "inputFields": [ + { + "name": "body", + "description": "

The new contents of the comment body.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "commentId", + "description": "

The Node ID of the discussion comment to update.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, + { + "name": "UpdateDiscussionInput", + "kind": "inputObjects", + "id": "updatediscussioninput", + "href": "/graphql/reference/input-objects#updatediscussioninput", + "description": "

Autogenerated input type of UpdateDiscussion.

", + "inputFields": [ + { + "name": "body", + "description": "

The new contents of the discussion body.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "categoryId", + "description": "

The Node ID of a discussion category within the same repository to change this discussion to.

", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "discussionId", + "description": "

The Node ID of the discussion to update.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "title", + "description": "

The new discussion title.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput", "kind": "inputObjects", @@ -65468,7 +71445,7 @@ }, { "name": "enterpriseId", - "description": "

The ID of the enterprise on which to set the default repository permission setting.

", + "description": "

The ID of the enterprise on which to set the base repository permission setting.

", "type": "ID!", "id": "id", "kind": "scalars", @@ -65477,7 +71454,7 @@ }, { "name": "settingValue", - "description": "

The value for the default repository permission setting on the enterprise.

", + "description": "

The value for the base repository permission setting on the enterprise.

", "type": "EnterpriseDefaultRepositoryPermissionSettingValue!", "id": "enterprisedefaultrepositorypermissionsettingvalue", "kind": "enums", @@ -65983,6 +71960,48 @@ } ] }, + { + "name": "UpdateEnvironmentInput", + "kind": "inputObjects", + "id": "updateenvironmentinput", + "href": "/graphql/reference/input-objects#updateenvironmentinput", + "description": "

Autogenerated input type of UpdateEnvironment.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "environmentId", + "description": "

The node ID of the environment.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "reviewers", + "description": "

The ids of users or teams that can approve deployments to this environment.

", + "type": "[ID!]", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id" + }, + { + "name": "waitTimer", + "description": "

The wait timer in minutes.

", + "type": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, { "name": "UpdateIpAllowListEnabledSettingInput", "kind": "inputObjects", @@ -66067,6 +72086,40 @@ } ] }, + { + "name": "UpdateIpAllowListForInstalledAppsEnabledSettingInput", + "kind": "inputObjects", + "id": "updateipallowlistforinstalledappsenabledsettinginput", + "href": "/graphql/reference/input-objects#updateipallowlistforinstalledappsenabledsettinginput", + "description": "

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "ownerId", + "description": "

The ID of the owner.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "settingValue", + "description": "

The value for the IP allow list configuration for installed GitHub Apps setting.

", + "type": "IpAllowListForInstalledAppsEnabledSettingValue!", + "id": "ipallowlistforinstalledappsenabledsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#ipallowlistforinstalledappsenabledsettingvalue" + } + ] + }, { "name": "UpdateIssueCommentInput", "kind": "inputObjects", @@ -66252,6 +72305,40 @@ } ] }, + { + "name": "UpdateNotificationRestrictionSettingInput", + "kind": "inputObjects", + "id": "updatenotificationrestrictionsettinginput", + "href": "/graphql/reference/input-objects#updatenotificationrestrictionsettinginput", + "description": "

Autogenerated input type of UpdateNotificationRestrictionSetting.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "ownerId", + "description": "

The ID of the owner on which to set the restrict notifications setting.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "settingValue", + "description": "

The value for the restrict notifications setting.

", + "type": "NotificationRestrictionSettingValue!", + "id": "notificationrestrictionsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#notificationrestrictionsettingvalue" + } + ] + }, { "name": "UpdateProjectCardInput", "kind": "inputObjects", @@ -67007,6 +73094,57 @@ "href": "/graphql/reference/enums#userstatusorderfield" } ] + }, + { + "name": "VerifiableDomainOrder", + "kind": "inputObjects", + "id": "verifiabledomainorder", + "href": "/graphql/reference/input-objects#verifiabledomainorder", + "description": "

Ordering options for verifiable domain connections.

", + "inputFields": [ + { + "name": "direction", + "description": "

The ordering direction.

", + "type": "OrderDirection!", + "id": "orderdirection", + "kind": "enums", + "href": "/graphql/reference/enums#orderdirection" + }, + { + "name": "field", + "description": "

The field to order verifiable domains by.

", + "type": "VerifiableDomainOrderField!", + "id": "verifiabledomainorderfield", + "kind": "enums", + "href": "/graphql/reference/enums#verifiabledomainorderfield" + } + ] + }, + { + "name": "VerifyVerifiableDomainInput", + "kind": "inputObjects", + "id": "verifyverifiabledomaininput", + "href": "/graphql/reference/input-objects#verifyverifiabledomaininput", + "description": "

Autogenerated input type of VerifyVerifiableDomain.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The ID of the verifiable domain to verify.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] } ], "scalars": [ diff --git a/lib/graphql/static/upcoming-changes.json b/lib/graphql/static/upcoming-changes.json index 945d870f62..23b91e2401 100644 --- a/lib/graphql/static/upcoming-changes.json +++ b/lib/graphql/static/upcoming-changes.json @@ -114,11 +114,165 @@ "date": "2020-04-01", "criticality": "breaking", "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" }, { - "location": "Query.sponsorsListing", - "description": "

sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead.

", - "reason": "

Query.sponsorsListing will be removed.

", + "location": "EnterpriseBillingInfo.seats", + "description": "

seats will be removed. Use EnterpriseBillingInfo.totalLicenses instead.

", + "reason": "

seats will be replaced with totalLicenses to provide more clarity on the value being returned

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "BlakeWilliams" + }, + { + "location": "EnterpriseBillingInfo.availableSeats", + "description": "

availableSeats will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.

", + "reason": "

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "BlakeWilliams" + }, + { + "location": "AssignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] + }, + "ghes-3.2": { + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + }, + { + "location": "EnterprisePendingCollaboratorEdge.isUnlicensed", + "description": "

isUnlicensed will be removed.

", + "reason": "

All pending collaborators consume a license

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "BrentWheeldon" + }, + { + "location": "EnterpriseOutsideCollaboratorEdge.isUnlicensed", + "description": "

isUnlicensed will be removed.

", + "reason": "

All outside collaborators consume a license

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "BrentWheeldon" + }, + { + "location": "EnterpriseMemberEdge.isUnlicensed", + "description": "

isUnlicensed will be removed.

", + "reason": "

All members consume a license

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "BrentWheeldon" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + }, + { + "location": "RepositoryInvitationOrderField.INVITEE_LOGIN", + "description": "

INVITEE_LOGIN will be removed.

", + "reason": "

INVITEE_LOGIN is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "jdennes" + }, + { + "location": "PullRequest.timeline", + "description": "

timeline will be removed. Use PullRequest.timelineItems instead.

", + "reason": "

timeline will be removed

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "mikesea" + }, + { + "location": "Issue.timeline", + "description": "

timeline will be removed. Use Issue.timelineItems instead.

", + "reason": "

timeline will be removed

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "mikesea" + }, + { + "location": "EnterpriseOwnerInfo.pendingCollaborators", + "description": "

pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead.

", + "reason": "

Repository invitations can now be associated with an email, not only an invitee.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "jdennes" + } + ], + "2020-07-01": [ + { + "location": "EnterprisePendingMemberInvitationEdge.isUnlicensed", + "description": "

isUnlicensed will be removed.

", + "reason": "

All pending members consume a license

", + "date": "2020-07-01", + "criticality": "breaking", + "owner": "BrentWheeldon" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", "date": "2020-04-01", "criticality": "breaking", "owner": "antn" @@ -754,147 +908,5 @@ "owner": "tambling" } ] - }, - "ghes-3.2": { - "2021-01-01": [ - { - "location": "MergeStateStatus.DRAFT", - "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", - "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", - "date": "2021-01-01", - "criticality": "breaking", - "owner": "nplasterer" - }, - { - "location": "EnterprisePendingCollaboratorEdge.isUnlicensed", - "description": "

isUnlicensed will be removed.

", - "reason": "

All pending collaborators consume a license

", - "date": "2021-01-01", - "criticality": "breaking", - "owner": "BrentWheeldon" - }, - { - "location": "EnterpriseOutsideCollaboratorEdge.isUnlicensed", - "description": "

isUnlicensed will be removed.

", - "reason": "

All outside collaborators consume a license

", - "date": "2021-01-01", - "criticality": "breaking", - "owner": "BrentWheeldon" - }, - { - "location": "EnterpriseMemberEdge.isUnlicensed", - "description": "

isUnlicensed will be removed.

", - "reason": "

All members consume a license

", - "date": "2021-01-01", - "criticality": "breaking", - "owner": "BrentWheeldon" - } - ], - "2020-10-01": [ - { - "location": "Sponsorship.sponsor", - "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", - "reason": "

Sponsorship.sponsor will be removed.

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "nholden" - }, - { - "location": "RepositoryInvitationOrderField.INVITEE_LOGIN", - "description": "

INVITEE_LOGIN will be removed.

", - "reason": "

INVITEE_LOGIN is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "jdennes" - }, - { - "location": "PullRequest.timeline", - "description": "

timeline will be removed. Use PullRequest.timelineItems instead.

", - "reason": "

timeline will be removed

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "mikesea" - }, - { - "location": "Issue.timeline", - "description": "

timeline will be removed. Use Issue.timelineItems instead.

", - "reason": "

timeline will be removed

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "mikesea" - }, - { - "location": "EnterpriseOwnerInfo.pendingCollaborators", - "description": "

pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead.

", - "reason": "

Repository invitations can now be associated with an email, not only an invitee.

", - "date": "2020-10-01", - "criticality": "breaking", - "owner": "jdennes" - } - ], - "2020-07-01": [ - { - "location": "EnterprisePendingMemberInvitationEdge.isUnlicensed", - "description": "

isUnlicensed will be removed.

", - "reason": "

All pending members consume a license

", - "date": "2020-07-01", - "criticality": "breaking", - "owner": "BrentWheeldon" - } - ], - "2020-04-01": [ - { - "location": "Sponsorship.maintainer", - "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", - "reason": "

Sponsorship.maintainer will be removed.

", - "date": "2020-04-01", - "criticality": "breaking", - "owner": "antn" - } - ], - "2020-01-01": [ - { - "location": "UnassignedEvent.user", - "description": "

user will be removed. Use the assignee field instead.

", - "reason": "

Assignees can now be mannequins.

", - "date": "2020-01-01", - "criticality": "breaking", - "owner": "tambling" - }, - { - "location": "EnterpriseBillingInfo.seats", - "description": "

seats will be removed. Use EnterpriseBillingInfo.totalLicenses instead.

", - "reason": "

seats will be replaced with totalLicenses to provide more clarity on the value being returned

", - "date": "2020-01-01", - "criticality": "breaking", - "owner": "BlakeWilliams" - }, - { - "location": "EnterpriseBillingInfo.availableSeats", - "description": "

availableSeats will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.

", - "reason": "

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned

", - "date": "2020-01-01", - "criticality": "breaking", - "owner": "BlakeWilliams" - }, - { - "location": "AssignedEvent.user", - "description": "

user will be removed. Use the assignee field instead.

", - "reason": "

Assignees can now be mannequins.

", - "date": "2020-01-01", - "criticality": "breaking", - "owner": "tambling" - } - ], - "2019-04-01": [ - { - "location": "LegacyMigration.uploadUrlTemplate", - "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", - "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", - "date": "2019-04-01", - "criticality": "breaking", - "owner": "tambling" - } - ] } } \ No newline at end of file diff --git a/lib/search/indexes/github-docs-2.22-cn-records.json.br b/lib/search/indexes/github-docs-2.22-cn-records.json.br index cfe526de4a..c0445aef5f 100644 --- a/lib/search/indexes/github-docs-2.22-cn-records.json.br +++ b/lib/search/indexes/github-docs-2.22-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c88630dd76dff2668b2f3743b5b490f4907a4a3b9fd8b3c23eb58fc057a55fa2 -size 506622 +oid sha256:900e225ccdbc985df1399f10ef88d3c784e81f67f744c038d65c4e018ecd26d8 +size 506558 diff --git a/lib/search/indexes/github-docs-2.22-cn.json.br b/lib/search/indexes/github-docs-2.22-cn.json.br index 544a0f24d7..b0e24e8f9e 100644 --- a/lib/search/indexes/github-docs-2.22-cn.json.br +++ b/lib/search/indexes/github-docs-2.22-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a2775d5ed380bf1ca5e194f14c004c0f0048644337fa4468048ab27ceaa751fe -size 802218 +oid sha256:d9e447d373636f7df9ea02716c62f2053cc1603f27d7056a97bd02b8c7054192 +size 802450 diff --git a/lib/search/indexes/github-docs-2.22-de-records.json.br b/lib/search/indexes/github-docs-2.22-de-records.json.br index 881a5ab895..ab9d8f12ab 100644 --- a/lib/search/indexes/github-docs-2.22-de-records.json.br +++ b/lib/search/indexes/github-docs-2.22-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b6978f4a9142f28d3d8bb8f836264329127992a193aacf8d6961e1687b8c6020 -size 469305 +oid sha256:c5e0766a29184ca881fedd305e863e90708929b6df7da166a5627282b80114b6 +size 469543 diff --git a/lib/search/indexes/github-docs-2.22-de.json.br b/lib/search/indexes/github-docs-2.22-de.json.br index 55eb83f9bb..d8444daa85 100644 --- a/lib/search/indexes/github-docs-2.22-de.json.br +++ b/lib/search/indexes/github-docs-2.22-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4f5cd5cb0457be9e223c77448b82486ba7ccc80272d4407c25d00231b91408b5 -size 2077234 +oid sha256:eb8db3e390b968ec69698a930454a05570c094929283f1290fab8f271132db91 +size 2078212 diff --git a/lib/search/indexes/github-docs-2.22-en-records.json.br b/lib/search/indexes/github-docs-2.22-en-records.json.br index 837161fe70..05170abbba 100644 --- a/lib/search/indexes/github-docs-2.22-en-records.json.br +++ b/lib/search/indexes/github-docs-2.22-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b827481189fbfd0d8df8fa8c0bf3df19d2e83ddd5c8805de20aae6f16304f2e3 -size 432720 +oid sha256:a7875d5165d3d774790f32736ca76dd86ce07d5a50c4f7489bef31278e9d68cb +size 432928 diff --git a/lib/search/indexes/github-docs-2.22-en.json.br b/lib/search/indexes/github-docs-2.22-en.json.br index 1c65c802c2..34b9b5b5f2 100644 --- a/lib/search/indexes/github-docs-2.22-en.json.br +++ b/lib/search/indexes/github-docs-2.22-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3ec9f7ea178e0982859b742a3d58ccedc15220bd13bcaccee764d2e7e3016171 -size 1696549 +oid sha256:ed96b511c8c49ad25a4813905ea38e018d20060a91273595f908567dff847078 +size 1698589 diff --git a/lib/search/indexes/github-docs-2.22-es-records.json.br b/lib/search/indexes/github-docs-2.22-es-records.json.br index 90d3c34a2a..16a540b00b 100644 --- a/lib/search/indexes/github-docs-2.22-es-records.json.br +++ b/lib/search/indexes/github-docs-2.22-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2c57f871f6918219fddc5bc3491bb218ad26876c5f3661a00bb52f7c4bcb7d61 -size 280158 +oid sha256:a88a0ab389f1bb736c662823a707c0e34f8c2f6878efa4052d8f0a30ade8feb8 +size 279907 diff --git a/lib/search/indexes/github-docs-2.22-es.json.br b/lib/search/indexes/github-docs-2.22-es.json.br index f515dc9339..bc057ff925 100644 --- a/lib/search/indexes/github-docs-2.22-es.json.br +++ b/lib/search/indexes/github-docs-2.22-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:039da5347cf968d8ffcfca2411f586f67acf88920b17d757f3cb70119313135d -size 1067543 +oid sha256:03ca3e9f9e97f0ce57f3cc3a01986d255be826cae50551187be82ff768c19338 +size 1066857 diff --git a/lib/search/indexes/github-docs-2.22-ja-records.json.br b/lib/search/indexes/github-docs-2.22-ja-records.json.br index 587aa55cad..e7f5353868 100644 --- a/lib/search/indexes/github-docs-2.22-ja-records.json.br +++ b/lib/search/indexes/github-docs-2.22-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8cec884ab1504d1582f3b6fd9f67a9fa65f8b26924a9fc42cd1f60fac6c11e1b -size 528606 +oid sha256:b198bf1f8bfed2972ad7e785ca3f39fe309a244dbb19de4e7096447e23385e90 +size 528686 diff --git a/lib/search/indexes/github-docs-2.22-ja.json.br b/lib/search/indexes/github-docs-2.22-ja.json.br index cf6fdb1fdb..72c048285a 100644 --- a/lib/search/indexes/github-docs-2.22-ja.json.br +++ b/lib/search/indexes/github-docs-2.22-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2cdaf03877f24b0201c290e96a27cd91a7dcb42c2c86f8be9c44b9febe0b49b9 -size 2796119 +oid sha256:bee494039ea2414e76ef965b77beb75808f1eb6f090614d48fdc0eaec6fb3a9c +size 2796328 diff --git a/lib/search/indexes/github-docs-2.22-pt-records.json.br b/lib/search/indexes/github-docs-2.22-pt-records.json.br index b40e5c424f..703cd5724b 100644 --- a/lib/search/indexes/github-docs-2.22-pt-records.json.br +++ b/lib/search/indexes/github-docs-2.22-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5930b3b0234030c8fd47ad8c8c82f061bccb87d18e91f3154fd4991902893d7b -size 443529 +oid sha256:6e5192892c1cb664db04f37942f99f3abfd8bb787a8b63b798d83e16df3f24f8 +size 443524 diff --git a/lib/search/indexes/github-docs-2.22-pt.json.br b/lib/search/indexes/github-docs-2.22-pt.json.br index 0798ef8627..44c3942711 100644 --- a/lib/search/indexes/github-docs-2.22-pt.json.br +++ b/lib/search/indexes/github-docs-2.22-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:285fdd1fe7e283bcf15a5152eab2fc93d628778bccd41a06d71652057d952af0 -size 1851478 +oid sha256:2b19be487223254af8deeb5db544420147a4f684da2c5d86b14aff599e54d835 +size 1852740 diff --git a/lib/search/indexes/github-docs-3.0-cn-records.json.br b/lib/search/indexes/github-docs-3.0-cn-records.json.br index 899e0bea77..19505856c6 100644 --- a/lib/search/indexes/github-docs-3.0-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.0-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ad1a42e398732f8d0bcf9ec562ec8629bb9f3c31c6e8bea97c80c359ecce219f -size 524571 +oid sha256:9c0eddc8dac916e0ca7b4f996fcfc07dae31dd2975970543d6ece7673afef401 +size 524645 diff --git a/lib/search/indexes/github-docs-3.0-cn.json.br b/lib/search/indexes/github-docs-3.0-cn.json.br index c66ec3f610..a178989074 100644 --- a/lib/search/indexes/github-docs-3.0-cn.json.br +++ b/lib/search/indexes/github-docs-3.0-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a42ae770cdc4b514d2a785d26851a7464d469adafd3c2f1995a631222f9fe3b4 -size 833047 +oid sha256:701ef459697ab66997b1175fc1c93424c8d00d98b7548087b000e1f3c5d06a16 +size 834095 diff --git a/lib/search/indexes/github-docs-3.0-de-records.json.br b/lib/search/indexes/github-docs-3.0-de-records.json.br index 196b82f2bf..a24bc8c91d 100644 --- a/lib/search/indexes/github-docs-3.0-de-records.json.br +++ b/lib/search/indexes/github-docs-3.0-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d7378f7d8e2fffdf251775391aec5bd388c64cfb144af3a514088074df615679 -size 490096 +oid sha256:530e94e05aac5a970ccf27b5d68f70980f8bc9883afe53f34e2c115f2ddeac88 +size 490167 diff --git a/lib/search/indexes/github-docs-3.0-de.json.br b/lib/search/indexes/github-docs-3.0-de.json.br index a4478d5709..bf6bba1296 100644 --- a/lib/search/indexes/github-docs-3.0-de.json.br +++ b/lib/search/indexes/github-docs-3.0-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:22de51888da4084c7de578f669aadf8a4d9931340c56a3913530930afc14481f -size 2177584 +oid sha256:5712cbf7cbfae99ca1e88e1322536df21d760d08e71864c5211375b2a94418e6 +size 2179478 diff --git a/lib/search/indexes/github-docs-3.0-en-records.json.br b/lib/search/indexes/github-docs-3.0-en-records.json.br index 428f664ead..6896beca94 100644 --- a/lib/search/indexes/github-docs-3.0-en-records.json.br +++ b/lib/search/indexes/github-docs-3.0-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:50fddffa9e421bc81779c2f6204821a58a8a65ef5578748a5957f7c4ea0a7306 -size 452229 +oid sha256:84e3471ab39e048861839b4e455feb01ec2728ff790c3943ca3797fa076b2380 +size 452915 diff --git a/lib/search/indexes/github-docs-3.0-en.json.br b/lib/search/indexes/github-docs-3.0-en.json.br index 883c14d15b..998d99d73c 100644 --- a/lib/search/indexes/github-docs-3.0-en.json.br +++ b/lib/search/indexes/github-docs-3.0-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fdd51e4a53711083c64bb51b4e211c71908a7b046a8a68246ccf2d468b187e78 -size 1771524 +oid sha256:b4c243c7614e4b8133ae769b6c533061c81f77c06c69ce13c1f98c2c8601e1e4 +size 1771611 diff --git a/lib/search/indexes/github-docs-3.0-es-records.json.br b/lib/search/indexes/github-docs-3.0-es-records.json.br index 5151fbf314..25c70720dd 100644 --- a/lib/search/indexes/github-docs-3.0-es-records.json.br +++ b/lib/search/indexes/github-docs-3.0-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e70fb14cead18608b6458f3d00096cf90968597b5e8783933678a41d7c7dd9bd -size 278110 +oid sha256:4dde80dbb4e91344f9f02ce20097c4a704f740e94e27cef80c0371bec4e2aa3b +size 278305 diff --git a/lib/search/indexes/github-docs-3.0-es.json.br b/lib/search/indexes/github-docs-3.0-es.json.br index 468b3ab1e4..5d2e04aaaa 100644 --- a/lib/search/indexes/github-docs-3.0-es.json.br +++ b/lib/search/indexes/github-docs-3.0-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ba962891016c72a7b36ea1febc5071d2bb1451f5255d6d1b0e39c839b66aa161 -size 1055479 +oid sha256:780d84efbcd768dbfa8c12f0d449c8504c5ada23c10d7c8b681da9941da935a3 +size 1055590 diff --git a/lib/search/indexes/github-docs-3.0-ja-records.json.br b/lib/search/indexes/github-docs-3.0-ja-records.json.br index f7d52a49dc..133f3e459e 100644 --- a/lib/search/indexes/github-docs-3.0-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.0-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:81d8a37cf48169f3abcd287ccc0f3ff32d869af0e3966fb277654d4bf5a5f039 -size 550348 +oid sha256:b23b22b080c4f5a47d66143cea5b70eafc6ceb506b1cafc7aa8ac96dcc870595 +size 550555 diff --git a/lib/search/indexes/github-docs-3.0-ja.json.br b/lib/search/indexes/github-docs-3.0-ja.json.br index f5a7540c4a..71306a254a 100644 --- a/lib/search/indexes/github-docs-3.0-ja.json.br +++ b/lib/search/indexes/github-docs-3.0-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ebead40ec36664fe4b8f74bec935851b826a4e520fc477ad5df15a53339a3337 -size 2913342 +oid sha256:cc5e326fa69cc8042eef6375de83e8d202e2e1027927a718b1adcf7a5d27415f +size 2912395 diff --git a/lib/search/indexes/github-docs-3.0-pt-records.json.br b/lib/search/indexes/github-docs-3.0-pt-records.json.br index d3780718f7..ec7c5406aa 100644 --- a/lib/search/indexes/github-docs-3.0-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.0-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5da57c499ec3892438e8e7184e34792c2f28fc50d2922b2a9a9a38bdbdc3c534 -size 464636 +oid sha256:be0d768509cada34e921f5952be360614b6889eb529a2516f857b8d00d481e91 +size 464691 diff --git a/lib/search/indexes/github-docs-3.0-pt.json.br b/lib/search/indexes/github-docs-3.0-pt.json.br index 4a9c150541..f6f4df9198 100644 --- a/lib/search/indexes/github-docs-3.0-pt.json.br +++ b/lib/search/indexes/github-docs-3.0-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2aca67e18f0349f07baef62c10ca30e480998b0eb6c78dab9b18689646ef51ba -size 1937942 +oid sha256:24333571c619355438a9374576bab25a098057c43756d4cfceb3bec43d4e0035 +size 1937314 diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br index 57a82aec2b..be5dc6ab04 100644 --- a/lib/search/indexes/github-docs-3.1-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:abd3faa6c970c7c889031badd928fc0fdd5ea26a063e6534563e6a92f6283831 -size 534218 +oid sha256:c6767750ed46a38ef4ed2729f639c763e19c919d0f040790cfcf466695d9ca45 +size 534045 diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br index b814ecb164..1bebd6b2de 100644 --- a/lib/search/indexes/github-docs-3.1-cn.json.br +++ b/lib/search/indexes/github-docs-3.1-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7ac50ada4c0217b2c9b4a8b886621767bd9c4f6a89f35d27cc78768697cc0f3d -size 845750 +oid sha256:1bfe35b3d0590cb1ca43466f9ff830f79756d7c182c20adcad44cbd1625654fd +size 846317 diff --git a/lib/search/indexes/github-docs-3.1-de-records.json.br b/lib/search/indexes/github-docs-3.1-de-records.json.br index 889818c158..632eb2e387 100644 --- a/lib/search/indexes/github-docs-3.1-de-records.json.br +++ b/lib/search/indexes/github-docs-3.1-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3e6ee335e4c32e5e0d8bff75d2b0dd081ed506b190e392d55de8253e4298f4e8 -size 497696 +oid sha256:4f60c5dfd4182ebd967320a380c02e3e4cbe61a00709063d0b9bcc7ed8bec4fd +size 497244 diff --git a/lib/search/indexes/github-docs-3.1-de.json.br b/lib/search/indexes/github-docs-3.1-de.json.br index e7d7e30469..60c5826b19 100644 --- a/lib/search/indexes/github-docs-3.1-de.json.br +++ b/lib/search/indexes/github-docs-3.1-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7ccc5497a4daf67e772bef0a130e6c5c0b0b9f0a6a2e0182168216aa65a78340 -size 2223120 +oid sha256:ad0e2da95a0782b82f7169a03787baa5ade24ce83ce25360e26a9193c2ccc8e8 +size 2220686 diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br index 325c98d166..546f56159e 100644 --- a/lib/search/indexes/github-docs-3.1-en-records.json.br +++ b/lib/search/indexes/github-docs-3.1-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9360ce8d0f964ff75c24556a193182fc6d3e3ee528b955f757d35f269375fbca -size 460772 +oid sha256:b25993f7eeb4f63e2b00eaaacf824b4b4838c06b4b1ed5cf8ab2d6d3e9bc93b7 +size 461101 diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br index 39cdd4615e..3ebb33eed1 100644 --- a/lib/search/indexes/github-docs-3.1-en.json.br +++ b/lib/search/indexes/github-docs-3.1-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3ca199e0aa4954028e699dc080d6a2a8c6b5b1c1a0f0c851229f98c580600ca9 -size 1805945 +oid sha256:02a572d43fb3755b64e8cba9d319081b975fea9448168c1a81cacdf5b848132b +size 1807831 diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br index 4b38390661..80909b8b49 100644 --- a/lib/search/indexes/github-docs-3.1-es-records.json.br +++ b/lib/search/indexes/github-docs-3.1-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e77a57e76cf449fe323a0eed596f4c0bdbc398aeb05bfa74a94c6611c87c261b -size 278457 +oid sha256:7bc202a4e0ee4b99e34ab457591fd1f09332ac707a44dc98d3b7488b8c2d8eb3 +size 279027 diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br index b660acc3b7..d19f6ccb8a 100644 --- a/lib/search/indexes/github-docs-3.1-es.json.br +++ b/lib/search/indexes/github-docs-3.1-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:25165b73815dc13fa6352b536cb1b90594b6eb28e91d2c597012224dba1a1365 -size 1056830 +oid sha256:fca07ea0a68dfc4ba31846ae694ce9ed4f11071c1fc76a67b2753b96de9da988 +size 1058903 diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br index 255aadc916..68a1fe934b 100644 --- a/lib/search/indexes/github-docs-3.1-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cb0d405f07bebabdae0f848cd1635161d1e9bc4372eaeee2dda3f273b8d39cc1 -size 559036 +oid sha256:70fc0c1a94863a41ef763fdf6cd9cf285ffc43ce26f8cb942afc6f01497b7ad1 +size 558756 diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br index 803d6f41c0..3195c3b37f 100644 --- a/lib/search/indexes/github-docs-3.1-ja.json.br +++ b/lib/search/indexes/github-docs-3.1-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c54a19d4fd7bf108a1a9ec81ff8b6118e82722c299f3b7575bb0d1974560876d -size 2966253 +oid sha256:04a69a38c6922f822c0aeec1159b06c45ef005e72cd713006ef1a56e01ef4820 +size 2964921 diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br index b1ac80503d..1c022d9769 100644 --- a/lib/search/indexes/github-docs-3.1-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8754cd31086397bccf0b275f3852f7eb48cdabeaed07ab74a1785575ef00cecd -size 472305 +oid sha256:e65a2c596db2358af50eed6568585118b23102570a7d9444221fbfa1284c22c8 +size 472197 diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br index ac8ede2545..a199999b3e 100644 --- a/lib/search/indexes/github-docs-3.1-pt.json.br +++ b/lib/search/indexes/github-docs-3.1-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:106927d929964455db4f0062d124027c4c432a8648d0c91273a9689bc760c9ca -size 1971887 +oid sha256:bc23691de5da8857fb0d1a7e933599356b085b45c84677cfc52aa195d7bf0ab8 +size 1972384 diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index 16761eeb1e..84b5bb0b7e 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1a2a11fc5b6a6bd713786ae87e1a65e452de479b94cebcd4713b7bb859750cc8 -size 539742 +oid sha256:1b87a0876ddd5ea44c51fb6ecdd3d30db3bd4e998a14ad6001b9d3a04d6e895f +size 539765 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index 9933e9c385..3188d1c1de 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bc753820b1b2bdaf96d5ab54b15f5caa95687feefe5be3a47847c77cb2cabe52 -size 852932 +oid sha256:49ad83d255d2f43f545bc63494d289c7296d292e03fe3f0345781a5553fa3644 +size 853676 diff --git a/lib/search/indexes/github-docs-3.2-de-records.json.br b/lib/search/indexes/github-docs-3.2-de-records.json.br index feb930cb37..d50ac1dffd 100644 --- a/lib/search/indexes/github-docs-3.2-de-records.json.br +++ b/lib/search/indexes/github-docs-3.2-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8999d8cc3ad09241ec61773d2e6b2dd185ede6e39bb4c2190a76003029cf7c9c -size 501742 +oid sha256:ab96684e9258b9e959d7086d48bb4e45409536d2e8353fcf31f8aa042af2ff72 +size 501949 diff --git a/lib/search/indexes/github-docs-3.2-de.json.br b/lib/search/indexes/github-docs-3.2-de.json.br index 18045b0a03..221290cd98 100644 --- a/lib/search/indexes/github-docs-3.2-de.json.br +++ b/lib/search/indexes/github-docs-3.2-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6d357aa4463040d3b16b816bb55d40801c5288650814a269f4359ccde94746e5 -size 2244366 +oid sha256:976d0292f977214113a2d3ccadd218da35542ee08bcba83291a0acf4caf78f90 +size 2245175 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index cf5e1d0b6b..0a8530bd40 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3ae9d97294c2d52fe8352cfff6d7a49875c71b7b2d9887240b4e6a7c4a6d76fc -size 469538 +oid sha256:3a9ddfdf9a3e0d3995f32a0773b7931e87aacf0639559d465923f43b653a1c1f +size 470173 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index f7e7fa422c..e8ace72fac 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2215d619fb311588dc78a3e13538e3ecb86d93c3c7af3342b2900847f1e73d3b -size 1838131 +oid sha256:442f3c62143fd7fa43048f31b281967586e7d09309a824951eedc4616aa8cca4 +size 1839818 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index 31c20c39a5..71cf46b200 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e6b0a0c1b8ab4857cd692bcf932c269214a3ed5f2b92f33a6de6db0666ade588 -size 278350 +oid sha256:8d24f954a866429a5047c1e2679865120b678513235e2a6aaa06147cc910cc85 +size 278264 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index d2fb3a11e9..01ffe30aa3 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a80837b013ee14f71074ae95abfd0fbe753a13ecb000fef39a4a4b6c399455b2 -size 1057071 +oid sha256:416db2267bcf73740f493c148a50caef53987c6449cb8539692c4545baad4fd5 +size 1056838 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index 8cd349ac6a..ec46358c08 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4bc172ea8c8dab3f8334184bb36027f134b8cb9b2e145533e1fd033b9432b454 -size 564877 +oid sha256:576b3f08f1290e545bd82065765c01e7938d9f148d6486220b589df3abfcb006 +size 564783 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index 03f9070797..0256e9028a 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:066831ff714429573bea083e6f45418831af42b32aca9bf0f4748ea58d585d8e -size 2998042 +oid sha256:52fa8f0a9c0b44bb228e25bb56978733a79fcdc12d6a834146b4a0fce06d963d +size 2998316 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index 51206e2268..a973bdc3e2 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e6f6cfce878ea66e068682eb67ac85c02c70a7d1fe6f0bf7b82bc33e77740c0f -size 476924 +oid sha256:ad03e0ef3208dc8e2b68b30c2276879a62de16097e90da0676411daf9e8e2bc7 +size 477161 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index 0b02ec1e89..54d08fe50d 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dec7f40c48d1767072a0e45a06395a8d7aca348f03af7fbcaf7719a6ae9e4ace -size 1994460 +oid sha256:9a74b8a1555cb72016c9031d73809c50951a77a7874ffed84f95fe988cd8bbaf +size 1996991 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index 34f30020df..0d0c5d95f9 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8213079114149b25ea09880e4f1a9b32319c9e6cb12a03482868ac588f91ede8 -size 709956 +oid sha256:360889f10f4a4ff31b9842dab09e0defce21ed6b55ab8fc3089aad82dfde52fc +size 695805 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index 23edfd7e03..c9f0150bf8 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:415432a50b29b796eb30d594d542472a5b1c04448dfec6f0b9afa461bceb8c8b -size 968891 +oid sha256:c39acc84340b8b3abffd30bfd3554e51a78acc0198eafdce8848a17af0eaf820 +size 947342 diff --git a/lib/search/indexes/github-docs-dotcom-de-records.json.br b/lib/search/indexes/github-docs-dotcom-de-records.json.br index ddee206147..c5749e86ee 100644 --- a/lib/search/indexes/github-docs-dotcom-de-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b915c3fc0573caae66035fbafb34eb9818fd40661f0a39898b77eece2af20e0b -size 647562 +oid sha256:893e0ae78389905cab1bc41c0543cf1350e9383a0f4aadea736695d64e611a4d +size 634035 diff --git a/lib/search/indexes/github-docs-dotcom-de.json.br b/lib/search/indexes/github-docs-dotcom-de.json.br index dc2123ca9a..5e9ce82f2c 100644 --- a/lib/search/indexes/github-docs-dotcom-de.json.br +++ b/lib/search/indexes/github-docs-dotcom-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:56bf4ca637ef1dbe4b129d08a206041cb0b8b8e3577bc77884d41b62188033ac -size 2900896 +oid sha256:9060d29d5927436064381a99bacbf3b7378ba9ca6d084a0aa3490de2a80b44f6 +size 2819933 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index 640c89cd8a..3541c0e186 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d196f9c7756b9886e5933d26c73fc13d7a523c7992711c3e16a432c0512d2f94 -size 625647 +oid sha256:fd81ed5d96104b14564f586451019d60d107d0f212c4f8a19d02dc754e8fb7c5 +size 626089 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index 072b37f96f..65e143dc7e 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2b9171a7f0b4e94cd7941727f1a5edc74a02a33100525896826f7ed510a66627 -size 2383103 +oid sha256:9b31f595a2d447038481634f0f3a4d5a3479ea074b85cee489f231bed402faae +size 2385594 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index ed89aff13c..9862c314cb 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5a3409dc69739f27392559a49ba28037232f6b9569ce89922cee32af130a4987 -size 306417 +oid sha256:3b421b24f92f50abf3668a5b983a276d7de3c7dca1435ba55b6901b9271e9803 +size 307199 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index 2c50d67be6..9610dca79a 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4a3960fbebc7a56079d4055a09145fae57a0c58a83449951d163d136d92282cf -size 1088356 +oid sha256:6a2633959ca32d28f40e897041ac9b184afc1033cfab2e2f7fc9ffbf389d9a47 +size 1090519 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index fa8fc67853..acf1a152fa 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1fddad2f0bb41bd26898defb8340d2595d6266e5e178baf955e2f2eb2ced2c48 -size 738740 +oid sha256:546729472f730dc856a72aaa968d0051eea0e41fce78eb1fa8d51d01fc58d8cb +size 723488 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 403a78a7b1..7cce2806e2 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4ad93f6ec7201f2350ca4710d06a57d072cabd0aba683856b2974ea532417e40 -size 3851921 +oid sha256:9b181f2085fb01c0e78139f7ed337cc37ef1e2220034a89f00a588b229c9db2e +size 3756880 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index 5a75636e8e..7db34af320 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:941b860f4e048fac2f8d0b82e8670e8ab12957562dd1b71a0b3ca3b07b7e59d4 -size 621675 +oid sha256:74e48571215e35b5b61b31e81ff35683984c196fb4207ee7de9731bbe8010119 +size 608040 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index 68b70a9b44..8daae2ad2a 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8484e29c9069ff79423ee1f333ca2a13007d49a2a265e648bda2aea39fe0058d -size 2552951 +oid sha256:2909390b5e678c86a04f936fd81ddaa040d354999cbe27942c7420f11633899d +size 2489714 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index 46b439e292..2d0efa21b4 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e4f97c2912bf217933fac43fb54426e921b6426c6a5559446d9686dd99b67dcf -size 414560 +oid sha256:42a14ef9f56c3d07c6b6f384f69a85bd3d24ccb78bfebfd3076b90df2046f53d +size 414650 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index c75eda2c94..fb2ee6448f 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7e580e998160c45051eb6d04abd385ecc4837adb05ccca271512073f2909deff -size 631102 +oid sha256:197fe8c661d858e9008749af9885cdcd8c9d8c03b8d77a6dd0c85d9aa9c308aa +size 631854 diff --git a/lib/search/indexes/github-docs-ghae-de-records.json.br b/lib/search/indexes/github-docs-ghae-de-records.json.br index 8ef647e89d..f933b09a2b 100644 --- a/lib/search/indexes/github-docs-ghae-de-records.json.br +++ b/lib/search/indexes/github-docs-ghae-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bd0774b2ecb79f098adba89bcb0c99419ef00aaeeaf654288c0ac5d3606cee36 -size 390597 +oid sha256:556469b7a73e52272446d56e3e5f3244704f7eb58ee917072c31d17376a56c25 +size 391137 diff --git a/lib/search/indexes/github-docs-ghae-de.json.br b/lib/search/indexes/github-docs-ghae-de.json.br index 8780f58505..c4073dcb6b 100644 --- a/lib/search/indexes/github-docs-ghae-de.json.br +++ b/lib/search/indexes/github-docs-ghae-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:95403bdac8a14343aff0ccc7cdfe2a6d3b2272189f7849ddec28a84f3c12eab1 -size 1698002 +oid sha256:fb99a42a883709d122f46a2aed99f6e41b902df4abeeb7a4f1067a46bae712c3 +size 1700292 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index b1fdc021a0..6fb5ae5257 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:72874c7787d5dc687bd693045455450d4a9f6cfa72426b29acc3ef637da54c2d -size 360968 +oid sha256:498fbdcb4e0c4ecc413de5b97f3cdab92a80b7f54df424d3fcf48bfe4c289d67 +size 361653 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index be474b93e6..885a80a826 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2df420e4e21612d2d9845c6eec1a0986ee9a8720fbab52b17acda36885c7eb95 -size 1355140 +oid sha256:3c071bc70f2bcfccc034e495a5601ad460a4428febfc707e232669360aa40516 +size 1355790 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index 0ab8900bdd..995867db82 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8df1fc40c8bf95301061cea22e7309028c22455e696933b16dc500876de2423a -size 200650 +oid sha256:c689457c2e7bdd4a83eb198d730c87d3209bae14175e810d1da70e01b3ece582 +size 201017 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index ca5c640005..a103976f41 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5cf7c31077cf6d6d76f99e81664c92412543cd4b467823096ca483e776716195 -size 717873 +oid sha256:6a929afbd00c65b25f5488d8e3a8c13c3c604395cd77b9675b4d3cbdcd03d315 +size 718717 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index d408d70687..cad30595d2 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2c35bacf76d95820518440a095f2be3462c81886502a5b5e3940538995b73cdd -size 435272 +oid sha256:974f09881ceeb896ea2ffe3b00a4bbd5d73cc0fcca291810cd3b816de607df2b +size 435203 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index 912b658b47..d8ceda17d2 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:071f0c303c64a5e5e7d3f5d008e926088f57394be187e13423e320d6c770452f -size 2216859 +oid sha256:4f54eaa82e92ccc69e07343dc61c3b796115649a84c28beaff26b9d414933fc8 +size 2215357 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index b69423e020..f2242bc74b 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fead09126527247ead95babf1fd3759262f6d60909cc49872ffceb75c6ad6d40 -size 371427 +oid sha256:a421e496dda05d60e5637ddd0ec416257195b94081fb0d6008dd73fed8a0032d +size 371680 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index a0ef11a8a4..d49c75299d 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f086d6d79306f8923cefcb8e873a8224a29382cb37ba1572d13a5e11fd86c4fe -size 1495858 +oid sha256:50209fd796fdb5cab033ba3b3e7e500fef4db3c88c47ae1b69c9b90344cff247 +size 1496665 diff --git a/lib/webhooks/README.md b/lib/webhooks/README.md new file mode 100644 index 0000000000..07693be0d8 --- /dev/null +++ b/lib/webhooks/README.md @@ -0,0 +1,44 @@ +# Webhooks + +## About this directory + +* `lib/webhooks/index.js` is human-editable. +* `lib/rest/static/**/*.payload.json` are manually edited and copied. When a new GHES release is created, the static webhook files from the previous version's directory are copied to a new version directory. + +## Editable files + +* `lib/webhooks/index.js` consumes the static JSON files in `lib/webhooks/static` and exports the data used by the REST middleware contextualizer. + +## Static files + +Generated by `script/rest/update-files.js`: + +* `lib/rest/static/dereferenced` - dereferenced OpenAPI schema file for each version of GitHub +* `lib/rest/static/decorated` - files generated from the dereferenced OpenAPI schema with the Markdown descriptions rendered in HTML + +## Rendering docs + +When the server starts, `middleware/contextualizers/webhooks.js` accesses the data exported from the static webhook JSON files, fetches the data for the current version and requested path, and adds it to the `context` object. The added property is: + +* `req.context.webhookPayloadsForCurrentVersion` - all webhook payloads with a version matching the current version + +Markdown files in `content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md` use Liquid to display the webhook payloads in `req.context.webhookPayloadsForCurrentVersion`. For example `{{ webhookPayloadsForCurrentVersion.user.created }}` references the payload file `user.created.payload.json` for the version being viewed. + +**Note** Payload files either contain the webhook action type or no action type at all. For example, `user.created.payload.json` is the webhook `user` with the action type of `created`. Not all webhooks have action types. If a file exists with no action type (e.g., `user.payload.json`) and the action types (e.g., `user.created.payload.json` and `user.deleted.payload.json`), the entry in the context for the file with no action type will be `default`. For example, for the three static file mentioned, the object would be: + +``` +{ + user: { + default: "STRING VALUE", + created: "STRING VALUE", + deleted: "STRING VALUE" + } +} +``` + +If no action types exist, and only `user.payload.json` exists, the object would be: + +``` +{ + user: "STRING VALUE" +} diff --git a/lib/webhooks/index.js b/lib/webhooks/index.js index f5a24bdc96..58f27065ac 100644 --- a/lib/webhooks/index.js +++ b/lib/webhooks/index.js @@ -19,7 +19,12 @@ versions.forEach((version) => { walk(versionSubdir, { includeBasePath: true }).forEach((payloadFile) => { // payload file: /path/to/check_run.completed.payload.json // payload path: check_run.completed - const payloadPath = path.basename(payloadFile).replace('.payload.json', '') + let payloadPath = path.basename(payloadFile).replace('.payload.json', '') + if (!payloadPath.includes('.') && payloadsPerVersion[payloadPath]) { + // append the key `default` to the payload path to + // prevent overwriting existing object + payloadPath = `${payloadPath}.default` + } set( payloadsPerVersion, payloadPath, diff --git a/script/deployment/deploy-to-staging.js b/script/deployment/deploy-to-staging.js index 507ee3f69b..58c2337971 100644 --- a/script/deployment/deploy-to-staging.js +++ b/script/deployment/deploy-to-staging.js @@ -2,6 +2,7 @@ import sleep from 'await-sleep' import got from 'got' import Heroku from 'heroku-client' +import { setOutput } from '@actions/core' import createStagingAppName from './create-staging-app-name.js' const SLEEP_INTERVAL = 5000 @@ -106,6 +107,12 @@ export default async function deployToStaging({ // Store this ID for later updating deploymentId = deployment.id + // Set some output variables for workflow steps that run after this script + if (process.env.GITHUB_ACTIONS) { + setOutput('deploymentId', deploymentId) + setOutput('logUrl', logUrl) + } + await octokit.repos.createDeploymentStatus({ owner, repo, diff --git a/tests/rendering/webhooks.js b/tests/rendering/webhooks.js new file mode 100644 index 0000000000..af6fff4a9e --- /dev/null +++ b/tests/rendering/webhooks.js @@ -0,0 +1,32 @@ +import { jest } from '@jest/globals' +import { getDOM } from '../helpers/supertest.js' +import { allVersions } from '../../lib/all-versions.js' + +describe('webhooks events and payloads', () => { + jest.setTimeout(300 * 1000) + + describe('rendering', () => { + test('every webhook event has at least one payload example', async () => { + const versions = Object.values(allVersions).map((value) => value.version) + + // For all versions, check that the webhook events and payloads page + // has at least one payload example for each event. Payload examples + // start with the id `webhook-payload-example` and have a sibling div + // with the class `height-constrained-code-block`. The sibling is + // usually but not always the next sibling element, which is why + // `nextUntil` is used. + for (const version of versions) { + const page = `/${version}/developers/webhooks-and-events/webhooks/webhook-events-and-payloads` + const $ = await getDOM(page) + const payloadExampleElem = $('[id^=webhook-payload-example]') + + payloadExampleElem.each((i, elem) => { + const siblings = $(elem) + .nextUntil('[id^=webhook-payload-example]') + .filter((i, elem) => $(elem).hasClass('height-constrained-code-block')) + expect(siblings.length).toBeGreaterThan(0) + }) + } + }) + }) +}) diff --git a/translations/de-DE/content/codespaces/about-codespaces.md b/translations/de-DE/content/codespaces/about-codespaces.md deleted file mode 100644 index 68715f7153..0000000000 --- a/translations/de-DE/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Über Codespaces -intro: '{% data variables.product.prodname_codespaces %} is a configurable online development environment, hosted by {% data variables.product.prodname_dotcom %} and powered by {% data variables.product.prodname_vscode %}, that allows you to develop entirely in the cloud.' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Informationen zu {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} is a configurable cloud development environment available in your browser on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -![Ein Open-Codespace](/assets/images/help/codespaces/codespace-overview.png) - -A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings. - -Codespaces offers many benefits to teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development. - -### A consistent environment - -You can create a single codespace configuration that defines the environment (or _dev container_) of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. A standardized environment is already available for them as soon as they create a codespace from the repository. Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." - -For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials. - -While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -### Fast and personal onboarding - -With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**. - -![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -As a result of standardizing on a repeatable developer environment, developers can get started with a new codespace without doing any manual configuration and do not need to do continued maintenance of their developer environment. A new codespace can be created when starting a new feature. - -Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - -Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs. - -### A secure environment - -{% data variables.product.prodname_codespaces %} allows developers to develop in the cloud instead of locally. This creates one single, trackable, source of truth. Entwickler können von überall her einen Beitrag leisten, von jedem Rechner aus, einschließlich Tablets oder Chromebooks, und es besteht keine Notwendigkeit, lokale Kopien des geistigen Eigentums zu verwalten. Developers always have to be logged in and provided with access to both {% data variables.product.prodname_codespaces %} and specific repositories. These permissions can be revoked at any time. As soon as you revoke access, those developers will lose all access to protected resources. In addition, authenticated developers create audit trails so you know who is doing what. For more information on access and security, see "[Managing access and security for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -Using {% data variables.product.prodname_codespaces %} is the most secure when all members of your team are using it. It means that there is no need to clone the repository onto a local machine and that developers don't need to install locally as `root`. - -Developers and organization administrators can also configure settings to add encrypted secrets and enable GPG verification. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)". - -### Informationen zur Abrechnung für {% data variables.product.prodname_codespaces %} - -{% data reusables.codespaces.about-billing-for-codespaces %} Weitere Informationen findest Du unter „[Informationen zur Abrechnung für {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)“. - -### Der Beta-Phase beitreten - -Eine begrenzte Anzahl von Personen wird eingeladen, der Beta-Phase beizutreten. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup). - -### Kontaktiere uns zu {% data variables.product.prodname_codespaces %} - -Wenn Du bei der Verwendung von {% data variables.product.prodname_codespaces %} Probleme entdeckst, lies bitte „[Fehlerbehebung Deines Codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." - -If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) discussion. diff --git a/translations/de-DE/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/de-DE/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index f621a80494..0000000000 --- a/translations/de-DE/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: About billing for Codespaces -intro: 'When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -Updates on the billing model for Codespaces will be shared in an upcoming announcement. diff --git a/translations/de-DE/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/de-DE/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index 75be9e6f73..0000000000 --- a/translations/de-DE/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Allowing your codespace to access a private image registry -intro: 'You can use secrets to allow {% data variables.product.prodname_codespaces %} to access a private image registry' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. You can create secrets in GitHub to store the access details for a private registry and use them to give your codespace access to images stored in the registry. - -When you launch a codespace, {% data variables.product.prodname_codespaces %} checks for three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -You can store secrets at the user, repository, or organization-level, allowing you to share them securely between different codespaces. When you create a set of secrets for a private image registry, you need to replace the “<*>” in the name with a consistent identifier. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" and "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)." - -For example, if you had a private image registry in Azure, you could create the following secrets: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/de-DE/content/codespaces/codespaces-reference/index.md b/translations/de-DE/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index f454770178..0000000000 --- a/translations/de-DE/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Referenz -intro: 'This section contains references that will allow you to be successful with {% data variables.product.prodname_codespaces %}' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry - - /using-the-command-palette-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/de-DE/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/de-DE/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index acea2d4a85..0000000000 --- a/translations/de-DE/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Fehlerbehebung Deines Codespace -intro: Use this guide to help you troubleshoot common issues with your codespace. -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Known Limitations - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### {% data variables.product.prodname_vscode %} troubleshooting - -Use **Issues** in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository to check for known issues or to log issues about the {% data variables.product.prodname_vscode %} experience. - - -### Configuration troubleshooting - -{% data reusables.codespaces.recovery-mode %} - -``` -This codespace is currently running in recovery mode due to a container error. -``` - -Review the creation logs, update the configuration as needed, and run **Codespaces: Rebuild Container** in the command palette to retry. Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." - -### dotfiles troubleshooting - -- Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. -- Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - - If your dotfiles were cloned, try manually re-running your install script to verify it's executable. - - If your dotfiles weren't cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. -- Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. Alternatively, you can view the `creation.log` by navigating to the command palette and entering **Codespaces: View Creation Log**. - - -### Browser troubleshooting - -Wenn Du bei der Verwendung eines nicht Chromium-basierten Browsers auf Probleme stößt, versuche auf einen Chromium-basierenden Browser zu wechseln oder suche nach bekannten Issues für Deinen Browser im `microsoft/vscode`-Repository, indem Du nach Problemen suchst, die mit dem Namen Deines Browsers gekennzeichnet sind, wie etwa [`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) oder [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari). - -Wenn Du bei der Verwendung eines Chromium-basierten Browsers auf Probleme stößt, kannst Du im [`microsoft/vscode`](https://github.com/microsoft/vscode/issues)-Repository.prüfen, ob du ein anderes bekanntes Problem mit {% data variables.product.prodname_vscode %} erlebst. - -### Container storage troubleshooting - -When you create a codespace, it has a finite amount of storage and over time it may be necessary for you to free up space. Try any of the following items to free up storage space. - -- Remove packages that are no longer by using `sudo apt autoremove` -- Clean the apt cache by using `sudo apt clean` -- Delete unneeded files like build artifacts and logs (these are very project-dependent) -- See the top 10 largest files in the codespace: `sudo find / -printf '%s %p\n'| sort -nr | head -10` - -More destructive options: -- Remove unused Docker images, networks, and containers by using `docker system prune` (append `-a` if you want to remove all images, and `--volumes` if you want to remove all volumes) -- Remove untracked files from working tree: `git clean -i` - -### Kontakt - -Wenn Du immer noch Hilfe benötigst, kannst Du uns kontaktieren. Weitere Informationen findest Du unter „[Über {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)." diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/de-DE/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index 75ed888220..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Erstellen eines Codespace -intro: 'Du kannst einen Codespace in einem Repository-Branch erstellen, um Online zu entwickeln.' -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Über die Codespace Erstellung - -You can create a codespace on either {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %} - -Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)." - - -When you create a codespace, a number of steps happen to enable full access to your development environment. - -- Resources such as a VM and storage for your container are assigned. A new VM is created every time you create or start a codespace to ensure that you always have the latest versions and security patches. -- {% data variables.product.prodname_codespaces %} recieves information about your repository, branch, commits, your public dotfiles repository, and any secrets that you have created. -- {% data variables.product.prodname_codespaces %} executes a shallow clone of the repository. -- If you have one in your repository, {% data variables.product.prodname_codespaces %} runs the `devcontainer.json` file. Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." -- Your Docker container, `docker-compose`, or other initialization is run. -- At this point, the codespace is marked as available and you can connect. -- Once the codespace is made available, depending on the commands in the devcontainer, the codespace will continue with some set up. - - The codespace shares ports added in the `devcontainer.json` file. - - The codespace runs anything specified in `postCreateCommand`. - - {% data variables.product.prodname_codespaces %} clones your dotfiles repository to the codespaces environment and looks for an install file. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - - Finally, the codespace does a full clone of the repo so you have full access to it. - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### Erstellen eines Codespace - -{% data reusables.repositories.navigate-to-repo %} -2. Benutze das „Branch"-Dropdownmenü unterhalb des Repository-Namens und wähle den Branch, für den Du einen Codespace erstellen willst. - - ![Dropdownmenü „Branch"](/assets/images/help/codespaces/branch-drop-down.png) - -3. Benutze das {% octicon "download" aria-label="The download icon" %} **Code**-Dropdownmenü unterhalb des Repository-Namens und wähle **Open with Codespaces** (Eröffnen mit Codespaces). - - ![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. To create a codespace using a Standard machine type, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![Schaltfläche „New codespace" (Neuer Codespace)](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/de-DE/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index dd74d3eecc..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Einen Codespace löschen -intro: 'Du kannst einen Codespace löschen, wenn Du ihn nicht länger benötigst.' -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. Navigate to the repository where you created the codespace. Select **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** and then click {% octicon "gear" aria-label="The Settings gear" %}. This will display all {% data variables.product.prodname_codespaces %} that you have created in the repository. ![Codespaces tab](/assets/images/help/codespaces/codespaces-manage.png) - - Alternatively, you can see every codespace owned by your user account at [github.com/codespaces](https://github.com/codespaces). - -2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete** ![Schaltfläche „Delete" (Löschen)](/assets/images/help/codespaces/delete-codespace.png) - -### Deleting a codespace in {% data variables.product.prodname_vscode %} - -For information on deleting a codespace in {% data variables.product.prodname_vscode %}, see "[Using Codespaces in Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)." diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/de-DE/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index 51fca79f66..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: In einem Codespace entwickeln -intro: 'Du kannst einen Codespace auf {% data variables.product.product_name %} eröffnen und dann mithilfe der {% data variables.product.prodname_vscode %}-Funktionen entwickeln.' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About development with {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} - -![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. Side Bar - By default, this area shows your project files in the Explorer. -2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. -3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it. -4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. -5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. - -For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} Weitere Informationen findest Du unter „[Fehlerbehebung Deines Codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." - -#### Personalizing your codespace - -{% data reusables.codespaces.about-personalization %} Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Konto personalisieren](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)." - -{% data reusables.codespaces.apply-devcontainer-changes %} Weitere Informationen findest du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." - -#### Running your app from a codespace -{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." - -#### Committing your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Navigating to an existing codespace - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. Klicke auf den Namen des Codespace, in dem Du entwickeln möchtest. ![Name des Codespace](/assets/images/help/codespaces/click-name-codespace.png) - -Alternatively, you can see any active codespaces for a repository by navigating to the repository in which it was made and selecting **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**. diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/de-DE/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index 63e2a73681..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Forwarding ports in your codespace -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About forwarded ports - -Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on port 4000, you can access the application from your browser to test and debug the application. - -When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards the port. You can click on the URL in the terminal to open the port in a browser. For example, if an application outputs `http://127.0.0.1:4000` or `http://localhost:4000` to the console, the log would automatically convert the output to a clickable URL for port 4000. - -![Automatic port forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) - -You can also forward a port manually, label forwarded ports, share fowarded ports publicly, and add forwarded ports to the codespace configuration. - -### Forwarding a port - -You can manually forward a port that wasn't forwarded automatically. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Under the list of ports, click **Add port**. ![Add port button](/assets/images/help/codespaces/add-port-button.png) -1. Type the port number or address, then press enter. ![Text box to type port button](/assets/images/help/codespaces/port-number-text-box.png) - -### Labeling a port - -You can label a port to make the port more easily identifiable in a list. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Hover over the port you want to label, then click the label icon. ![Label icon for port](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### Sharing a port - -If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to share, then click **Make Public**. ![Option to make port public in right-click menu](/assets/images/help/codespaces/make-public-option.png) -1. To the right of the local address for the port, click the copy icon. ![Copy icon for port URL](/assets/images/help/codespaces/copy-icon-port-url.png) -1. Send the copied URL to the person you want to share the port with. - -### Adding a port to the codespace configuration - -You can add a forwarded port to the {% data variables.product.prodname_codespaces %} configuration for the repository, so the port will automatically be forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -You can manually configure fowarded ports in a `.devcontainer.json` file using the `forwardPorts` property, or you can use the "Ports" panel in your codespace. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to add to the codespace configuration, then click **Set Label and Update devcontainer.json**. ![Option to set label and add port to devcontainer.json in the right-click menu](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/index.md b/translations/de-DE/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index 08438c8895..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: In einem Codespace entwickeln -intro: 'Create a codespace to get started with developing your project inside a dedicated cloud environment. You can use forwarded ports to run your application and even use codespaces inside {% data variables.product.prodname_vscode %}' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/de-DE/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index 406824a7cf..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Using Codespaces in Visual Studio Code -intro: 'Du kannst über {% data variables.product.prodname_vscode %} direkt in Deinem Codespace entwickeln, indem Du die {% data variables.product.prodname_github_codespaces %}-Erweiterung mit Deinem Konto auf {% data variables.product.product_name %} verbindest.' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Vorrausetzungen - -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. - -Du kannst {% data variables.product.prodname_vs %}-Marketplace verwenden, um die [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces)-Erweiterung zu installieren. Weitere Informationen findest Du unter „[Marketplace-Erweiterung](https://code.visualstudio.com/docs/editor/extension-gallery)" in der {% data variables.product.prodname_vscode %}-Dokumentation. - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Klicke auf **Sign in to view {% data variables.product.prodname_dotcom %}...** (Anmelden zur Anzeige von...). ![Anmelden, um {% data variables.product.prodname_codespaces %} anzuzeigen](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. Um {% data variables.product.prodname_vscode %} für den Zugriff zu Deinem Konto auf {% data variables.product.product_name %} zu autorisieren, klicke auf **Allow** (Genehmigen). -4. Melde Dich bei {% data variables.product.product_name %} an, um die Erweiterung zu genehmigen. - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**. ![Die {% data variables.product.prodname_codespaces %}-Kopfzeile](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. Klicke auf **Sign in to view {% data variables.product.prodname_codespaces %}...** (Anmelden zur Anzeige von...). ![Anmelden, um {% data variables.product.prodname_codespaces %} anzuzeigen](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. Um {% data variables.product.prodname_vscode %} für den Zugriff zu Deinem Konto auf {% data variables.product.product_name %} zu autorisieren, klicke auf **Allow** (Genehmigen). -5. Melde Dich bei {% data variables.product.product_name %} an, um die Erweiterung zu genehmigen. - -{% endwindows %} - -### Creating a codespace in {% data variables.product.prodname_vscode %} - -After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_github_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Click the Add icon, then click **Create New Codespace**. ![The Create new Codespace option in {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/create-codespace-vscode.png) -3. Type, then click the repository's name you want to develop in. ![Searching for repository to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-repository-vscode.png) -4. Click the branch you want to develop on. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Click the machine type you want to develop in. ![Instance types for a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-sku-vscode.png) -### Einen Codespace in {% data variables.product.prodname_vscode %} eröffnen - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Under "Codespaces", click the codespace you want to develop in. -3. Klicke auf das Symbol „Connect to Codespace" (Verbinde zu Codespace). ![Symbol „Connect to Codespace" (Verbinde mit Codespace) in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### Changing the machine type in {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.codespaces-machine-types %} - -You can change the machine type of your codespace at any time. - -1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). -2. Search for and select "Codespaces: Change Machine Type." ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Click the codespace that you want to change. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Choose the machine type you want to use. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. - -### Deleting a codespace in {% data variables.product.prodname_vscode %} - -1. Under "Codespaces", right-click the codespace you want to delete. -2. In the drop-down menu, click **Delete Codespace**. ![Deleting a codespace in {% data variables.product.prodname_dotcom %}](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/de-DE/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/de-DE/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index 11d7279d92..0000000000 --- a/translations/de-DE/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Using source control in your codespace -intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository. -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About source control in {% data variables.product.prodname_codespaces %} - -You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. - -Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." - -A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: - -* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." -* In your codespace, create a new branch to work on. -* Make your changes and save them. -* Commit the change. -* Raise a pull request. - -### Creating or switching branches - -1. If the current branch is not shown in the status bar, at the bottom of your codespace, right-click the status bar and select **Source control**. -1. Click the branch name in the status bar. ![The branch in the status bar](/assets/images/help/codespaces/branch-in-status-bar.png) -1. In the drop-down, either click the branch you want to switch to, or enter the name for a new branch and click **Create new branch**. ![Choose from the branch menu](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. - -{% endtip %} - -### Pulling changes from the remote repository - -You can pull changes from the remote repository into your codespace at any time. - -{% data reusables.codespaces.source-control-display-dark %} -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. In the drop-down menu, click **Pull**. - -If a dev container has been changed since you created the codespace you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -### Setting your codespace to automatically fetch new changes - -You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. - -If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. - -1. Click the **Manage** button at the bottom of the Activity Bar. ![Manage button](/assets/images/help/codespaces/manage-button.png) -1. In the menu, slick **Settings**. -1. On the Settings page, search for: `autofetch`. ![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) -1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. ![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) -1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. - -### Committing your changes - -{% data reusables.codespaces.source-control-display-dark %} -1. To stage your changes, click **+** next to the file you've changed, or next to **Changes** if you've changed multiple files and you want to stage them all. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. Type a commit message describing the change you've made. ![Source control side bar with a commit message](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. To commit your staged changes, click the check mark at the top the source control side bar. ![Click the check mark icon](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### Raising a pull request - -1. After you've committed changes to your local copy of the repository, click the **Create Pull Request** icon. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. Klicke auf **Create** (Erstellen). - -### Pushing changes to your remote repository - -You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. - -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. In the drop-down menu, click **Push**. diff --git a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index 0355417f9b..0000000000 --- a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Getting started with your C# (.NET) project in Codespaces -shortTitle: Getting started with your C# (.NET) project -allowTitleToDifferFromFilename: true -intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Einführung - -This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Vorrausetzungen - -- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![Schaltfläche „New codespace" (Neuer Codespace)](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project ](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. Click the recommended version of .NET. ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the .NET Core version that we want to use. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Dockerfile - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "dotnet restore", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - - ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via pip3. With our dependencies now installed, we can run our application. - -1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Nächste Schritte: - -You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index 55c1c30565..0000000000 --- a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: Getting started with your Java project in Codespaces -shortTitle: Getting started with your Java project -intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Einführung - -This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Vorrausetzungen - -- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![Schaltfläche „New codespace" (Neuer Codespace)](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Click the recommended version of Java. ![Java version selection](/assets/images/help/codespaces/add-java-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Dockerfile - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`. - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm. - -1. Run your application by pressing `F5`. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Nächste Schritte: - -You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index 1117c53786..0000000000 --- a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Getting started with your Node.js project in Codespaces -shortTitle: Getting started with your Node.js project -intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### Einführung - -This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Vorrausetzungen - -- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![Schaltfläche „New codespace" (Neuer Codespace)](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Click the recommended version of Node.js. ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Dockerfile - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the {% data variables.product.prodname_vscode %} docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm. - -1. Run your start command in the terminal with`npm start`. - - ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Nächste Schritte: - -You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index d3ee56ad84..0000000000 --- a/translations/de-DE/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Getting started with your Python project in Codespaces -shortTitle: Getting started with your Python project -intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### Einführung - -This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Vorrausetzungen - -- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![Schaltfläche „New codespace" (Neuer Codespace)](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgresSQL. ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Click the recommended version of Python. ![Python version selection](/assets/images/help/codespaces/add-python-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Dockerfile - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - - ![Extensions list](/assets/images/help/codespaces/python-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. - -1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Nächste Schritte: - -You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/de-DE/content/codespaces/getting-started-with-codespaces/index.md b/translations/de-DE/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index 396851c0bb..0000000000 --- a/translations/de-DE/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Getting Started with {% data variables.product.prodname_codespaces %}' -intro: 'Learn how to get started with {% data variables.product.prodname_codespaces %}, including set up and configuration for specific languages.' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/de-DE/content/codespaces/guides.md b/translations/de-DE/content/codespaces/guides.md deleted file mode 100644 index b719006750..0000000000 --- a/translations/de-DE/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Codespaces guides -shortTitle: Leitfäden -intro: 'Learn how to make the most of GitHub {% data reusables.gated-features.codespaces %}' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/de-DE/content/codespaces/index.md b/translations/de-DE/content/codespaces/index.md deleted file mode 100644 index d7c9926f2c..0000000000 --- a/translations/de-DE/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GitHub Codespaces Documentation -beta_product: true -shortTitle: GitHub Codespaces -intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.' -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index 7d7055b862..0000000000 --- a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Managing Codespaces for your organization -intro: 'You can manange and review how users in your organization can use {% data variables.product.prodname_github_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index f3d0f9eb29..0000000000 --- a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Managing access and security for your organization's codespaces -shortTitle: Managing access and security for your organization -intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Organization owners can manage which repositories a codespace can access. - -By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read and write permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust. - -To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "Access and security", select the setting you want for your organization. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index 846a64b7e1..0000000000 --- a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Managing encrypted secrets for your repository and organization for Codespaces -shortTitle: Managing secrets for your repository and organization -intro: 'Encrypted secrets allow you to store sensitive information in your organization, repository, or {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### About secrets - -Secrets are encrypted environment variables that you create in an organization or repository. The secrets that you create are available to use in {% data variables.product.prodname_codespaces %}. GitHub uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before they reach GitHub and only decrypts them when you use them in a codespace. - -Organization-level secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. - - {% data reusables.codespaces.secret-precedence %} - -#### Einschränkungen für Geheimnisse - -You can store up to 100 secrets per organization and 100 secrets per repository. - -Geheimnisse sind auf 64 KB beschränkt. - -### Adding secrets for a repository - -To create secrets for an organization repository, you must have administrator access. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. At the top of the page, click **New repository secret**. -1. Geben Sie einen Namen für Ihr Geheimnis in das Eingabefeld **Name** ein. -1. Geben Sie den Wert für Ihr Geheimnis ein. -1. Klicken Sie auf **Add secret** (Geheimnis hinzufügen). - -### Adding secrets for an organization - -Beim Erstellen eines geheimen Schlüssels in einer Organisation können Sie eine Richtlinie verwenden, um einzuschränken, welche Repositorys auf diesen geheimen Schlüssel zugreifen können. Sie können z. B. Zugriff auf alle Repositorys gewähren oder den Zugriff auf nur private Repositorys oder eine angegebene Liste von Repositorys beschränken. - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. At the top of the page, click **New organization secret**. -1. Geben Sie einen Namen für Ihr Geheimnis in das Eingabefeld **Name** ein. -1. Geben Sie den **Value** für Ihr Geheimnis ein. -1. Wählen Sie im **Repository-Zugriff** Dropdownliste eine Zugriffsrichtlinie aus. ![Repository Access list with private repositories selected](/assets/images/help/codespaces/secret-repository-access.png) -1. Klicken Sie auf **Add secret** (Geheimnis hinzufügen). - -### Überprüfen des Zugriffs auf Geheimnisse auf Organisationsebene - -You can check which access policies are applied to a secret in your organization. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Die Liste der Geheimnisse enthält alle konfigurierten Berechtigungen und Richtlinien. Ein Beispiel: ![Geheimliste](/assets/images/help/settings/actions-org-secrets-list.png) -1. Weitere Informationen zu den konfigurierten Berechtigungen für jeden geheimen Schlüssel finden Sie unter **Aktualisieren**. diff --git a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index f8c2c9ac71..0000000000 --- a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Managing user permissions for your organization -intro: You can control which users in your organization can use {% data variables.product.prodname_codespaces %}. -permissions: To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner. -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### About user permissions for {% data variables.product.prodname_codespaces %} - -Organization owners can control which users in your organization can create and use codespaces. - -To use codespaces in your organization, your users must have at least write access to the repositories where they want to use a codespace. You can enable codespaces for all users in your organization, or only specific users. - -By default, a codespace can only access the repository where it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -### Configuring which users in your organization can use {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select one of the following options: - - * **Disabled** to not allow any organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - - ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index c438a70311..0000000000 --- a/translations/de-DE/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Reviewing your organization's audit logs for Codespaces -shortTitle: Reviewing your organization's audit logs -intro: 'You can use the audit log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -When any member of your organization performs an action related to {% data variables.product.prodname_codespaces %}, you can review the actions in the audit log. For information about accessing the log, see "[Reviewing your audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)." - -![Audit log with Codespaces information](/assets/images/help/settings/codespaces-audit-log-org.png) - -The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)." diff --git a/translations/de-DE/content/codespaces/managing-your-codespaces/index.md b/translations/de-DE/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 142e6c292d..0000000000 --- a/translations/de-DE/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing your codespaces -intro: 'You can use {% data variables.product.prodname_github_codespaces %} settings to manage information that your codespace might need.' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/de-DE/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/de-DE/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index 2241dd5ecf..0000000000 --- a/translations/de-DE/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing access and security for your codespaces -intro: 'You can manage the repositories that {% data variables.product.prodname_codespaces %} can access.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read and write permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Access and security", select the setting you want for your user account. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/de-DE/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/de-DE/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index 9e34c2e376..0000000000 --- a/translations/de-DE/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Managing encrypted secrets for your codespaces -intro: 'You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### About encrypted secrets for {% data variables.product.prodname_codespaces %} - -You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. - -- Personal access tokens to cloud services -- Service principals -- Subscription identifiers -- [Credentials for a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository. - - {% data reusables.codespaces.secret-precedence %} - -#### Einschränkungen für Geheimnisse - -You can store up to 100 secrets for {% data variables.product.prodname_codespaces %}. - -Geheimnisse sind auf 64 KB beschränkt. - -### Adding a secret - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. To the right of "Codespaces secrets", click **New secret**. !["New secret" button](/assets/images/help/settings/codespaces-new-secret-button.png) -1. Under "Name", type a name for your secret. !["Name" text box](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Klicken Sie auf **Add secret** (Geheimnis hinzufügen). - -### Editing a secret - -You can update the value of an existing secret, and you can change which repositories can access a secret. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Codespaces secrets", to the right of the secret you want to edit, click **Update**. !["Update" button](/assets/images/help/settings/codespaces-secret-update-button.png) -1. Under "Value", click **enter a new value**. !["enter a new value" link](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Optionally, to remove the secret's access to a repository, deselect the repository. ![Checkboxes to remove access to repositories](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. Klicke auf **Save changes** (Änderungen speichern). - -### Deleting a secret - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Codespaces secrets", to the right of the secret you want to delete, click **Delete**. !["Delete" button](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. Lies die Warnung, dann klicke auf **OK**. ![Confirmation to delete secret](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/de-DE/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/de-DE/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index c9492f1760..0000000000 --- a/translations/de-DE/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Managing GPG verification for Codespaces -intro: 'You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "GPG verification", select the setting you want for GPG verification. ![Radio buttons to manage GPG verification](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository you want enable GPG verification for. Repeat for all repositories you want to enable GPG verification for. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/de-DE/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/de-DE/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index f7e213e258..0000000000 --- a/translations/de-DE/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Reviewing your security logs for Codespaces -shortTitle: Reviewing your security logs -intro: 'You can use the security log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### About security logs for {% data variables.product.prodname_codespaces %} - -When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your user account, you can review the actions in the security log. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." - -![security log with Codespaces information](/assets/images/help/settings/codespaces-audit-log.png) - -The security log includes details on what action occured and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". diff --git a/translations/de-DE/content/codespaces/quickstart.md b/translations/de-DE/content/codespaces/quickstart.md deleted file mode 100644 index ce704597cf..0000000000 --- a/translations/de-DE/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Quickstart for GitHub Codespaces -intro: 'Try out {% data variables.product.prodname_codespaces %} in 5 minutes or less.' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### Einführung - -In this guide, you'll create a codespace from the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces) and explore some of the essential features available to you within the codespace. - -The following example shows you how to create a codespace, connect to a forwarded port to view your running application, and personalize your setup with additional extensions and dotfiles. - -### Creating your codespace - -1. Navigate to the main page of the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces). - -2. Benutze das {% octicon "download" aria-label="The download icon" %} **Code**-Dropdownmenü unterhalb des Repository-Namens und wähle **Open with Codespaces** (Eröffnen mit Codespaces). - - ![Schaltfläche „Open with Codespaces" (Eröffnen mit Codespaces)](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. To create a codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![Schaltfläche „New codespace" (Neuer Codespace)](/assets/images/help/codespaces/new-codespace-button.png) - -### Run the application - -With your project open in a codespace, you can now run the application and launch it in a browser. - -1. Start the application by entering `npm run dev` in the terminal. This command executes the `dev` script in the package.json file and starts up the web application defined in the sample repository. - - ![npm run dev in terminal](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. Click **Open in Browser** to view your running application in a new tab. - -### Personalize with a theme extension - -Within a codespace, you have access to the Visual Studio Code Marketplace. For this example, you'll install an extension that alters the theme but you can install any extension that is useful for your workflow. - -1. In the left sidebar, click the Extensions icon. - -2. In the search bar, enter `fairyfloss` and install the fairyfloss extension. - - ![Add an extension](/assets/images/help/codespaces/add-extension.png) - -3. Select the `fairyfloss` theme by selecting it from the list. - - ![Select the fairyfloss theme](/assets/images/help/codespaces/fairyfloss.png) - -4. Changes you make to your editor setup in the current codespace, such as theme and keyboard bindings, are synced automatically to other codespaces via [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). - -### Personalize with dotfiles - -If your user account on GitHub owns a public repository named dotfiles, GitHub automatically uses this repository to personalize your codespace environment during codespace creation. - -This example guides you through creating a dotfiles repository for your codespaces. - -1. Navigate to the sample [dotfiles repository](https://github.com/aw-test-93/dotfiles/). - -2. Fork the repository to your account and ensure it's public. - - Verify the repository created under your account is named dotfiles, for example `yourname/dotfiles`. Any other name will cause {% data variables.product.prodname_codespaces %} to ignore the repository for personalization. - -3. Create a new codespace from the [sample application repository](https://github.com/2percentsilk/haikus-for-codespaces) as dotfile updates are only applied at creation time. The sample dotfiles will change the command prompt to bold purple and blue text. - - ![Custom command prompt](/assets/images/help/codespaces/custom-prompt.png) - -### Next Steps - -You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_codespaces %}. - - "[Getting Started guides](/codespaces/getting-started-with-codespaces)" for using {% data variables.product.prodname_codespaces %} with specific languages - - [Create a custom configuration](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project) to configure {% data variables.product.prodname_codespaces %} for your project. diff --git a/translations/de-DE/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/de-DE/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index c2e18a3030..0000000000 --- a/translations/de-DE/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: Codespace für Dein Projekt konfigurieren -intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About dev containers - -A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. When working with a dev container in {% data variables.product.prodname_codespaces %} you can either [use the default configuration](#using-the-default-configuration), [use a pre-defined configuration](#using-a-pre-defined-container-configuration), or [create your own configuration](#creating-a-custom-codespace-configuration). The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. - -{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. - -For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. - -#### Dockerfile - -A Dockerfile also lives in the `.devcontainer` folder. - -You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -You can use the `RUN` instruction to install any software and `&&` to join commands. - -Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. - -### Using the default configuration - -If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace with a base Linux image. The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. - -Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. - -The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. - - -### Using a predefined container configuration - -Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. - -Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. - -1. To access the command palette, in the upper-left corner, select the Application Menu and click **Command Palette…** from the **View** menu, then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. Click the definition you want to use. ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. Follow the prompts to customize your definition. -1. Klicke auf **OK**. ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) - - -### Erstellen einer benutzerdefinierten Codespace-Konfiguration - -If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} - -In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. - -{% data reusables.codespaces.vscode-settings-order %} - -Du kannst die Standard-Editor-Einstellungen für {% data variables.product.prodname_vscode %} an zwei Orten festlegen. - -* Editor-Einstellungen, die in `.vscode/settings.json` definiert sind, werden als _Workspace_-bezogene Einstellungen im Codespace angewendet. -* Editor--Einstellungen, die im `settings`-Schlüssel in der `devcontainer.json`-Datei definiert sind, werden als as _Remote [Codespaces]_-bezogene Einstellungen im Codespace angewendet. - -After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." - - - - -### Applying changes to your configuration - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %} -!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) - - To diagnose the error by reviewing the creation logs, click **View creation log**. - - To fix the errors identified in the logs, update your `devcontainer.json` file. - - To apply the changes, rebuild your container. {% data reusables.codespaces.rebuild-command %} diff --git a/translations/de-DE/content/codespaces/setting-up-your-codespace/index.md b/translations/de-DE/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index f47cc82ec3..0000000000 --- a/translations/de-DE/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Setting up your codespace -intro: '{% data variables.product.prodname_codespaces %} is a dedicated environment for you. You can configure your codespace with a dev container to install your dependencies or you can add a dotfile to personalize the user settings.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/de-DE/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/de-DE/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index 18f3605d23..0000000000 --- a/translations/de-DE/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Codespaces für Dein Konto personalisieren -intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About personalizing {% data variables.product.prodname_codespaces %} - -When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces. - -- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}. -- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations. - -{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create. - -Projektbetreuer können auch eine Standardkonfiguration definieren, die für jeden Codespace eines Repositorys gilt, egal wer ihn erstellt. Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." - -### Settings Sync - -Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}. - -Settings Sync is on by default. To configure any settings, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is on**. From the dialog, you can choose to configure, show settings and data, or turn off Settings Sync. - -![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode %} documentation. - -### Dotfiles - -'Dotfiles' sind Dateien und Verzeichnisse auf Unix-ähnlichen Systemen, die mit `.` beginnen und die die Konfiguration von Anwendungen und Shells auf Deinem System kontrollieren. Du kannst Deine 'dotfiles' in einem Repository auf {% data variables.product.prodname_dotcom %} speichern und verwalten. Für Ratschläge und Tutorials dazu, was Du in Deinem `dotfiles`-Repository hinzufügen solltest, siehe [GitHub does dotfiles](https://dotfiles.github.io/) (GitHub benutzt 'dotfiles'). - -Wenn Dein Benutzerkonto auf {% data variables.product.prodname_dotcom %} ein öffentliches Repository mit Namen `dotfiles` besitzt, wird {% data variables.product.prodname_dotcom %} dieses Repository automatisch nutzen, um Deine Codespace-Umgebung zu personalisieren. Private `dotfiles`-Repositorys sind momentan nicht unterstützt. - -Dein `dotfiles`-Repository könnte Deine Shell-Aliase und -Voreinstellungen beinhalten, sämtliche Werkzeuge, die Du installieren möchtest, oder jede andere Codespace-Personalisierung, die Du machen willst. - -Wenn Du einen neuen Codespace erstellst, klont {% data variables.product.prodname_dotcom %} Dein `dotfiles`-Repository in die Codespace-Umgebung und sucht nach einer der folgenden Dateien, um die Umgebung einzurichten. - -* _install.sh_ -* _install_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -Wenn keine dieser Dateien gefunden wird, werden Dateien oder Ordner in `dotfiles`, die mit einem `.` beginnen, symbolisch zum `~`- or `$HOME`-Verzeichnis des Codespace verknüpft. - -Änderungen an Deinem `dotfiles`-Repository gelten nur für neue Codespaces und verändern bestehende Codespaces nicht. - -{% note %} - -**Hinweis:** Derzeit unterstützt {% data variables.product.prodname_codespaces %} kein personalisieren der _Benutzer_ Einstellungen für den {% data variables.product.prodname_vscode %}-Editor mit Deinem `dotfiles`-Repository. Du kannst Standardeinstellungen für den _Arbeitsbereich _ und die _Remote [Codespaces]_ für ein bestimmtes Projekt in einem Projekt-Repository festlegen. Weitere Informationen findest Du unter „[{% data variables.product.prodname_codespaces %} für Dein Projekt konfigurieren](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)." - -{% endnote %} - -You can also configure settings for your user account to add encrypted secrets, enable GPG verification, and allow your codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." - -### Weiterführende Informationen - -* „[Ein neues Repository erstellen](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/de-DE/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/de-DE/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index 8a1128db5e..0000000000 --- a/translations/de-DE/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %} is free to use during the beta. When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage. diff --git a/translations/de-DE/data/reusables/codespaces/about-configuration.md b/translations/de-DE/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 728a09052c..0000000000 --- a/translations/de-DE/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -Du kannst eine Standard-Codespace-Konfiguration für Dein Repository erstellen, welche die Umgebung jedes neuen Codespace bestimmt, den jemand für dieses Repository erstellt. The configuration defines a development container that can include frameworks, tools, extensions, and port forwarding. diff --git a/translations/de-DE/data/reusables/codespaces/about-personalization.md b/translations/de-DE/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index 12c6c4dcc7..0000000000 --- a/translations/de-DE/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -You can also use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Die Personalisierung kann Shell-Präferenzen und zusätzliche Werkzeuge beinhalten. diff --git a/translations/de-DE/data/reusables/codespaces/about-port-forwarding.md b/translations/de-DE/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index 39b29dc4a0..0000000000 --- a/translations/de-DE/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -You can forward ports in your codespace to test and debug your application. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/de-DE/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index 8031bfb4af..0000000000 --- a/translations/de-DE/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -After the {% data variables.product.prodname_codespaces %} configuration for a repository changes, you can apply the changes to an existing codespace by rebuilding the container for the codespace. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/beta-functionality-limited.md b/translations/de-DE/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 9b0644a2c9..0000000000 --- a/translations/de-DE/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -Während der Beta-Phase ist die Funktionalität limitiert. -- {% data reusables.codespaces.use-chrome %} -- Nur eine einzige Größe von Codespace ist verfügbar. -- Nur Linux-Container werden unterstützt. -- Ein Codespace kann nicht vollständig wiederaufgenommen werden. Prozesse, die zum Zeitpunkt des Stopps des Codespace ausgeführt wurden, werden nicht neu gestartet. diff --git a/translations/de-DE/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/de-DE/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index 7f3cc83952..0000000000 --- a/translations/de-DE/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. Klicke in der linken Seitenleiste von {% data variables.product.prodname_vscode %} auf das „Remote Explorer"-Symbol. ![Das „Remote Explorer"-Symbol in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/codespace-config-order.md b/translations/de-DE/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index e02e59bf04..0000000000 --- a/translations/de-DE/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -Deine `dotfiles`-Personalisierung wird vor der Standard-Codespace-Konfiguration eines Repositorys angewendet. diff --git a/translations/de-DE/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/de-DE/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index 9ba14a8df7..0000000000 --- a/translations/de-DE/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -Jeder Codespace ist mit einem spezifischen Branch eines Repositorys verbunden. diff --git a/translations/de-DE/data/reusables/codespaces/codespaces-are-personal.md b/translations/de-DE/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index a9f41f0c21..0000000000 --- a/translations/de-DE/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -Jeder von Dir erstellte Codespace steht nur Dir zur Verfügung. Niemand sonst kann in Deinem Codespace arbeiten. diff --git a/translations/de-DE/data/reusables/codespaces/codespaces-machine-types.md b/translations/de-DE/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index 475114c1c5..0000000000 --- a/translations/de-DE/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -You can run your codespace on a choice of three types of remote machine: Basic, Standard, or Premium. Each of these has a different level of resources and a different billing tier.{% note %} - -**Note:** {% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -Switching machine types gives you the flexibility to choose the most appropriate resources for your work. Certain tasks may require different machine types: - -* **Basic** for updating a file and raising a pull request -* **Standard** for editing a website -* **Premium** for high compute tasks such as data analysis diff --git a/translations/de-DE/data/reusables/codespaces/committing-link-to-procedure.md b/translations/de-DE/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 87bfa539ff..0000000000 --- a/translations/de-DE/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding {% data variables.product.prodname_vscode %} extensions, will appear for all users. - -For information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)." \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/de-DE/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index 4d10268bd3..0000000000 --- a/translations/de-DE/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -Du kannst pro Repository oder sogar pro Branch mehr als einen Codespace erstellen. However, each user account has a two-codespace limit during limited public beta. Wenn Du das Limit erreicht hast und einen neuen Codespace erstellen möchtest, musst Du zuerst einen Codespace löschen. diff --git a/translations/de-DE/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/de-DE/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index f6f389132b..0000000000 --- a/translations/de-DE/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -Du kannst Dich direkt aus {% data variables.product.prodname_vscode %} mit Deinem Codespace verbinden. For more information, see "[Using Codespaces in {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)." diff --git a/translations/de-DE/data/reusables/codespaces/devcontainer-location.md b/translations/de-DE/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index 196fc006be..0000000000 --- a/translations/de-DE/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -This file can be located in the root of the repository or in a folder called `.devcontainer`. If the file is located in the root of the repository, the filename must begin with a period: `.devcontainer.json`. diff --git a/translations/de-DE/data/reusables/codespaces/navigate-to-codespaces.md b/translations/de-DE/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index f13ff1cd8c..0000000000 --- a/translations/de-DE/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. Klicke zuoberst auf einer beliebigen Seite auf **Codespaces**. ![{% data variables.product.prodname_codespaces %}-Link in der Kopfzeile](/assets/images/help/codespaces/header-link.png) diff --git a/translations/de-DE/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/de-DE/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index fed860897b..0000000000 --- a/translations/de-DE/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In your codespace, under the text editor, click "Ports". ![Ports tab](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/de-DE/data/reusables/codespaces/rebuild-command.md b/translations/de-DE/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index ea9e45b032..0000000000 --- a/translations/de-DE/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -Access the command palette (`shift command P` / `shift control P`), then start typing "Codespaces: Rebuild Container". Click **Codespaces: Rebuild Container**. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/recovery-mode.md b/translations/de-DE/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index fa4e73d013..0000000000 --- a/translations/de-DE/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -If changes to your codespace's configuration cause a container error, your codespace will run in recovery mode, and you will see an error message. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/release-stage.md b/translations/de-DE/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 4eb00a36b8..0000000000 --- a/translations/de-DE/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Hinweis:** {% data variables.product.prodname_codespaces %} befindet sich derzeit in der eingeschränkten Beta-Phase und kann sich jederzeit verändern. Weitere Informationen zum Beitritt zur Beta-Phase findest Du unter „[Über {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)." - -{% endnote %} diff --git a/translations/de-DE/data/reusables/codespaces/secret-precedence.md b/translations/de-DE/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index 582b91c1aa..0000000000 --- a/translations/de-DE/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/secrets-naming.md b/translations/de-DE/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index f19197f144..0000000000 --- a/translations/de-DE/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -Die folgenden Regeln gelten für geheime Namen: - -* Geheime Namen dürfen nur alphanumerische Zeichen (`[a-z]`, `[A-Z]`, `[0-9]`) oder Unterstriche (`_`) enthalten. Leerzeichen sind nicht zulässig. -* Geheime Namen dürfen nicht mit dem `GITHUB_` -Präfix beginnen. -* Geheime Namen dürfen nicht mit einer Zahl beginnen. -* Secret names are not case-sensitive. -* Geheime Namen müssen auf der Ebene eindeutig sein, auf der sie erstellt werden. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/secrets-on-start.md b/translations/de-DE/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index c4a5bf3b41..0000000000 --- a/translations/de-DE/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to suspend the codespace and resume it. \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/source-control-display-dark.md b/translations/de-DE/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index 90b3503dcd..0000000000 --- a/translations/de-DE/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. ![Source control view](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/source-control-display.md b/translations/de-DE/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index 09917cd3c8..0000000000 --- a/translations/de-DE/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. - - ![Source control view](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/type-port-label.md b/translations/de-DE/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index 498c9eb752..0000000000 --- a/translations/de-DE/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. Type a label for your port, then press enter. ![Text box to type label for port](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/codespaces/unsupported-repos.md b/translations/de-DE/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index ac3f7622a2..0000000000 --- a/translations/de-DE/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -Während der Beta-Phase werden private Repositorys von Organisationen oder Repositorys von Organisation, die SAML Single Sign-On verlangen, nicht unterstützt. diff --git a/translations/de-DE/data/reusables/codespaces/use-chrome.md b/translations/de-DE/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index 06e3da3183..0000000000 --- a/translations/de-DE/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -Für die beste Erfahrung mit {% data variables.product.prodname_codespaces %} empfehlen wir die Verwendung eines Chromium-basierten Browsers wie beispielsweise Google Chrome oder Microsoft Edge. diff --git a/translations/de-DE/data/reusables/codespaces/use-visual-studio-features.md b/translations/de-DE/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index 77d8f0ba9e..0000000000 --- a/translations/de-DE/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -You can edit code, debug, and use Git commands while developing in a codespace with {% data variables.product.prodname_vscode %}. Weitere Informationen findest Du in der [{% data variables.product.prodname_vscode %}-Dokumentation](https://code.visualstudio.com/docs). diff --git a/translations/de-DE/data/reusables/codespaces/vscode-settings-order.md b/translations/de-DE/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index 197cf0c2f0..0000000000 --- a/translations/de-DE/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -Wenn Du die Editor-Einstellungen für {% data variables.product.prodname_vscode %} konfigurierst, stehen Dir drei Bereiche zur Verfügung: _Workspace_ (Arbeitsbereich), _Remote [Codespaces]_ (Remote-Codespace) und _User_ (Benutzer). Wenn eine Einstellung in mehreren Bereichen definiert ist, haben _Workspace_-Einstellungen erste Priorität, danach _Remote [Codespaces]_- und dann _User_-Einstellungen. diff --git a/translations/de-DE/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/de-DE/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index afb626e71c..0000000000 --- a/translations/de-DE/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -You can see every available codespace that you have created at [github.com/codespaces](https://github.com/codespaces). diff --git a/translations/de-DE/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/de-DE/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index a5e98437c0..0000000000 --- a/translations/de-DE/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the top right corner of {% data variables.product.product_name %}, click your profile photo, then click **Your codespaces**. - - !['Your codespaces' menu option](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/gated-features/codespaces.md b/translations/de-DE/data/reusables/gated-features/codespaces.md deleted file mode 100644 index 0e77303c76..0000000000 --- a/translations/de-DE/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Codespaces sind für Benutzerkonten mit {% data variables.product.prodname_free_user %} oder {% data variables.product.prodname_pro %} verfügbar. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/de-DE/data/reusables/organizations/click-codespaces.md b/translations/de-DE/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index 6a15dd7757..0000000000 --- a/translations/de-DE/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. In the left sidebar, click **Codespaces**. !["Codespaces" tab in left sidebar](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/de-DE/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/de-DE/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index ae43f35c1f..0000000000 --- a/translations/de-DE/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. Select the "Repository access" drop-down menu, then click a repository you want to have access to the secret. Repeat for every repository you want to have access to the secret. !["Repository access" drop-down menu](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/user_settings/codespaces-secret-value.md b/translations/de-DE/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index 82cb0fbffe..0000000000 --- a/translations/de-DE/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. Under "Value", type the value of your secret. !["Value" textbox](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/de-DE/data/reusables/user_settings/codespaces-tab.md b/translations/de-DE/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index e4908fcf75..0000000000 --- a/translations/de-DE/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In the left sidebar, click **Codespaces**. ![Codespaces tab in the user settings sidebar](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/translations/es-ES/content/codespaces/about-codespaces.md b/translations/es-ES/content/codespaces/about-codespaces.md deleted file mode 100644 index 966ea3fc6e..0000000000 --- a/translations/es-ES/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Acerca de Codespaces -intro: '{% data variables.product.prodname_codespaces %} es un ambiente de desarrollo en línea configurable que hospeda {% data variables.product.prodname_dotcom %} y que impulsa {% data variables.product.prodname_vscode %}, el cual te permite desarrollar integralmente desde la nube.' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} es un ambiente de desarrollo configurable en la nube que está disponible en tu buscador dentro de {% data variables.product.prodname_dotcom %} o a través de {% data variables.product.prodname_vscode %}. - -![Un codespace abierto](/assets/images/help/codespaces/codespace-overview.png) - -Un codespace incluye todo lo que necesitan los desarrolladores para desarrollar en un repositorio específico, incluyendo la experiencia de editar en {% data variables.product.prodname_vscode %} y los lenguajes, herramientas y utilidades comunes. {% data variables.product.prodname_codespaces %} es completamente configurable, lo cual te permite crear un ambiente de desarrollo personalizado para tu proyecto y le permite a los desarrolladores personalizar su experiencia con extensiones y ajustes de dotfile. - -Los codespaces ofrecen muchos beneficios para los equipos al permitir un ambiente consistente a través de todo tu equipo, una incorporación rápida y la creación de un espacio de desarrollo seguro. - -### Un ambiente consistente - -Puedes crear solo una configuración de codespace que defina el ambiente (o _contenedor dev_) de cada codespace nuevo que cualquiera pueda crear para tu repositorio. Una vez que hagas una configuración, los desarrolladores no tienen que preocuparse por instalar las herramientas correctas para comentar, revisar o contribuir. Ellos ya tendrán un ambiente estandarizado disponible tan pronto creen un codespace desde el repositorio. Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)". - -Para obtener ayuda en iniciar con las configuraciones para lenguajes específicos, consulta los tutoriales de [Inicio](/codespaces/getting-started-with-codespaces). - -Si bien cada codespace de tu repositorio tiene un ambiente de desarrollo consistente, los desarrolladores pueden utilizar los {% data variables.product.prodname_codespaces %} donde sea que los necesiten – en {% data variables.product.prodname_dotcom %} o a través de {% data variables.product.prodname_vscode %}. - -### Incorporación rápida y personal - -Si tienes configurado un [contenedor de dev](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) en tu repositorio, cualquier desarrollador puede integrarse rápidamente con el ambiente de desarrollo correcto para tu proyecto si utilizan el {% octicon "download" aria-label="The download icon" %} menú desplegable de **Código** y seleccionan **Abrir con codespaces**. - -![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -Como resultado de estandarizar en un ambiente de desarrollador repetible, los desarrolladores puede iniciar con codespaces nuevos sin hacer ninguna configuración manual y no necesitan dar mantenimiento contínuo para su ambiente de desarrollo. Se puede crear un codespace nuevo cuando inicias una característica nueva. - -Los desarrolladores también pueden personalizar algunos aspectos del ambiente de un codespace utilizando un repositorio de [dotfiles](https://dotfiles.github.io/tutorials/) y la [Sincronización de ajustes](https://code.visualstudio.com/docs/editor/settings-sync). La personalización puede incluir preferencias de shell, herramientas adicionales, configuraciones de editor y extensiones tales como Live Share. Las personalizaciones que hagas se almacenan por usuario, así que cada codespace que abra un desarrollador tendrá su ambiente listo. Para obtener más información, consulta la sección "[Personalizar {% data variables.product.prodname_codespaces %} para tu cuenta](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)". - -Ya que se puede acceder a {% data variables.product.prodname_codespaces %} desde el buscador, los desarrolladores pueden trabajar en varios proyectos si cambian de pestaña. - -### Un ambiente seguro - -{% data variables.product.prodname_codespaces %} permite el desarrollo en la nube en vez de localmente. Esto crea una fuente única y rastreable de verdad. Los desarrolladores pueden contribuir desde donde sea, en cualquier máquina, incluyendo tablets o Chromebooks, y no es necesario mantener copias locales o propiedad intelectual. Los desarrolladores siempre tienen que iniciar sesión y contar con acceso tanto a {% data variables.product.prodname_codespaces %} como a los repositorios específcos. Estos permisos se pueden revocar en cualquier momento. Tan pronto revoques los accesos, estos desarrolladores perderán cualquier tipo de acceso a los recursos protegidos. Adicionalmente, los desarrolladores autenticados crean pistas de auditoría para que sepas quién hace qué. Para obtener más información sobre acceso y seguridad, consulta la sección "[Administrar el acceso y seguridad de los codespaces de tu organización](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". - -Utilizar {% data variables.product.prodname_codespaces %} es lo más seguro cuando todos los miembros de tu equipo lo están utilizando. Esto significa que no hay necesidad de clonar el repositorio en una máquina local y que los desarrolladores no necesitan instalar nada localmente como `root`. - -Los desarrolladores y administradores organizacionales también pueden configurar los ajustes para agregar secretos cifrados y habilitar la verificación de GPG. Para obtener más información, consulta las secciones "[Administrar los secretos cifrados de los {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Administrar la verificación GPG para los {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)". - -### Acerca de la facturación para {% data variables.product.prodname_codespaces %} - -{% data reusables.codespaces.about-billing-for-codespaces %} Para obtener más información, consulta "[Acerca de la facturación para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)". - -### Unirse al beta - -Se invitará a una cantidad limitada de personas para unirse al beta. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup). - -### Contáctanos para conocer sobre {% data variables.product.prodname_codespaces %} - -Si encuentras problemas al utilizar {% data variables.product.prodname_codespaces %}, consulta la sección "[Solución de problemas para tu codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)". - -Si aún necesitas ayuda o tienes algún tipo de retroalimentación sobre los {% data variables.product.prodname_codespaces %}, utiliza el debate de [Retroalimentación de los Codespaces](https://github.com/github/feedback/discussions/categories/codespaces-feedback). diff --git a/translations/es-ES/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/es-ES/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index 5eeae1969c..0000000000 --- a/translations/es-ES/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Acerca de la facturación para Codespaces -intro: 'Cuando {% data variables.product.prodname_codespaces %} se hace generalmente disponible, se te cobrará por el almacenamiento y uso del procesamiento.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -Las actualizaciónes sobre el modelo de facturación para Codespaces se compartirán en un anuncio siguiente. diff --git a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index bd50b986ac..0000000000 --- a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Permitir que tu codespace acceda a una imagen de registro privada -intro: 'Puedes utilizar secretos para permitir que los {% data variables.product.prodname_codespaces %} accedan a un registro de imagen privada' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Un registro es un espacio seguro para almacenar y administrar imágenes privadas de contenedores, tales como el Registro de Contenedores de Azure o DockerHub. Puedes crear secretos en GitHub para almacenar los detalles de acceso para un registro privado y utilizarlos para otorgar acceso a tu codespace para las imágenes que se almacenan en el registro. - -Cuando ejecutas un codespace, {% data variables.product.prodname_codespaces %} verifica tres secretos, los cuales definen el nombre de servidor, nombre de usuario y token de acceso personal (PAT) para un registro de contenedor. Si se encuentran estos secretos, {% data variables.product.prodname_codespaces %} hará que el registro esté disponible dentro de tu codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -Puedes almacenar los secretos a nivel de repositorio, organización o usuario, lo cual te permite compartirlos de forma segura entre diferentes codespaces. Cuando creas un conjunto de secretos para un registro de imagen privado, necesitas reemplazar el "<*>” del nombre con un identificador consistente. Para obtener más información, consulta las secciones "[Administrar los secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" y "[Administrar los secretos cifrados de tu repositorio y organización para los Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)". - -Por ejemplo, si tienes un registro de imagen privada en Azure, puedes crear los siguientes secretos: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Ejemplo de secreto de registro de imagen](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/es-ES/content/codespaces/codespaces-reference/index.md b/translations/es-ES/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index 22ad3e1567..0000000000 --- a/translations/es-ES/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Referencia -intro: 'Esta sección contiene referencias que te permitirán tener éxito con {% data variables.product.prodname_codespaces %}' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry - - /using-the-command-palette-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/es-ES/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/es-ES/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index a812a94ca0..0000000000 --- a/translations/es-ES/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Solucionar problemas de tu codespace -intro: Utiliza esta guía para ayudarte a solucionar los problemas comunes de tu codespace. -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Limitantes conocidas - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### Solución de problemas de {% data variables.product.prodname_vscode %} - -Utiliza las **Propuestas** en el repositorio [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) para registrar o conocer las propuestas que hay sobre la experiencia con {% data variables.product.prodname_vscode %}. - - -### Solución de problemas para la configuración - -{% data reusables.codespaces.recovery-mode %} - -``` -Este codespace se ejecuta acutalmente en modo de recuperación debido a un error del contenedor. -``` - -Revisa las bitácoras de creación, actualiza la configuración como lo requieras y ejecuta **Codespaces: Rebuild Container** en la paleta de comandos para volver a intentarlo. Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)". - -### Solución de problemas de dotfiles - -- Asegúrate que tu repositorio de dotfiles sea público. Si tienes secretos o datos sensibles que quieras utilizar en tu codespace, utiliza los [Secretos de codespace](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) en vez de los dotfiles privados. -- Verifica `/workspaces/.codespaces/.persistedshare/dotfiles` para ver si se clonaron tus dotfiles. - - Si se clonaron tus dotfiles, intenta volver a ejecutar tu script de instalación manualmente para verificar si es ejecutable. - - Si tus dotfiles ni se clonaron, verifica `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` para ver si hubo un problema al clonarlos. -- Verifica `/workspaces/.codespaces/.persistedshare/creation.log` para encontrar problemas posibles. Como alternativa, puedes ver el `creation.log` si navegas a la paleta de comandos e ingresas **Codespaces: View Creation Log**. - - -### Solución de problemas del buscador - -Si encuentras problemas al utilizar un buscador que no se base en Chromium, intenta cambiar a uno que sí se base en él, o revisa los problemas conocidos de tu buscador en el repositorio `microsoft/vscode` buscando los problemas etiquetados con el nombre del buscador, tales como [`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) o [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari). - -Si encuentras problemas al utilizar un buscador basado en Chromium, puedes revisar si estás experimentando otro problema conocido con {% data variables.product.prodname_vscode %} en el repositorio [`microsoft/vscode`](https://github.com/microsoft/vscode/issues). - -### Solución de problemas el almacenamiento de contenedores - -Cuando creas un codespace, este tiene una cantidad de almacenamiento finita y, con el tiempo, podría que necesites liberar espacio. Intenta cualquiera de los siguientes elementos para liberar espacio de almacenamiento. - -- Elimina los paquetes que ya no se utilizan con `sudo apt autoremove` -- Limpia el caché de apt utilizando `sudo apt clean` -- Borra los archivos innecesarios como artefactos de compilación y bitácoras (estos dependen mucho del proyecto) -- Consulta los 10 archivos más grandes en el codespace: `sudo find / -printf '%s %p\n'| sort -nr | head -10` - -Más opciones destructivas: -- Elimina las imágenes de Docker, redes y contenedores sin utilizar con `docker system prune` (adjunta una `-a` si quieres eliminar todas las imágenes, y `--volumes` si quieres eliminar todos los volúmenes) -- Elimina los archivos no rastreados del árbol de trabajo: `git clean -i` - -### Contáctanos - -Si aún necesitas ayuda, puedes contactarnos. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)". diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index 36c5a3414f..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Crear un codespace -intro: Puedes crear un codespace para una rama en un repositorio para desarrollar en línea. -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de la creación de codespaces - -Puedes crear un codespace ya sea en {% data variables.product.prodname_dotcom_the_website %} o en {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %} - -Los codespaces se asocian con una rama específica de un repositorio y este repositorio no puede estar vacío. {% data reusables.codespaces.concurrent-codespace-limit %} Para obtener más información, consulta la sección "[Borrar un codespace](/github/developing-online-with-codespaces/deleting-a-codespace)". - - -Cuando creas un codespace, suceden ciertos pasos para habilitar el acceso completo a tu ambiente de desarrollo. - -- Se asignan los recursos tales como MV y almacenamiento para tu contenedor. Se crea una MV cada vez que creas o inicias un codespace para garantizar que siempre tengas las versiones y parches de seguridad más recientes. -- {% data variables.product.prodname_codespaces %} recibe información de tu repositorio, rama, confirmaciones, tu repositorio de dotfiles público y de cualquier secreto que hayas creado. -- {% data variables.product.prodname_codespaces %} ejecuta un clon llano del repositorio. -- Si tienes uno en tu repositorio, {% data variables.product.prodname_codespaces %} ejecutará el archivo `devcontainer.json`. Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)". -- Se ejecuta tu contenedor de Docker, `docker-compose` u otra inicialización. -- En este punto, el codespace se marca como disponible y puedes conectarte. -- Una vez que el codespace se hace disponible, dependiendo de los comandos del contenedor dev, el codespace seguirá con algunas configuraciones. - - El codespace comparte los puertos que se agregaron en el archivo `devcontainer.json`. - - El codespace ejecuta lo que sea que se haya especificado en `postCreateCommand`. - - Los {% data variables.product.prodname_codespaces %} clonan tu repositorio de dotfiles en el ambiente de codespaces y buscan un archivo de instalación. Para obtener más información, consulta la sección "[Personalizar {% data variables.product.prodname_codespaces %} para tu cuenta](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)". - - Por fin, el codespace hace un clone integral del repositorio para que tengas acceso total a él. - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### Crear un codespace - -{% data reusables.repositories.navigate-to-repo %} -2. Debajo del nombre de repositorio, utiliza el menú desplegable de "Rama" y selecciona aquella en la que quieras crear un codespace. - - ![Menú desplegable de rama](/assets/images/help/codespaces/branch-drop-down.png) - -3. Debajo del nombre del repositorio, utiliza el menú desplegable {% octicon "download" aria-label="The download icon" %} **Código**, y selecciona **Abrir con codespaces**. - - ![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. Para crear un codespace utilizando un tipo de máquina estándar, haz clic en {% octicon "plus" aria-label="The plus icon" %}**Codespace nuevo**. - - ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index 7b83d0416c..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Borrar un codespace -intro: Puedes borrar un codespace que ya no necesites. -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. Navega al repositorio en donde creaste el codespace. Selecciona **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** y lugo haz clic en {% octicon "gear" aria-label="The Settings gear" %}. Esto mostrará todos los {% data variables.product.prodname_codespaces %} que hayas creado en el repositorio. ![Pestaña de codespaces](/assets/images/help/codespaces/codespaces-manage.png) - - Como alternativa, puedes ver cada codespace que pertenezca a tu cuenta de usuario en [github.com/codespaces](https://github.com/codespaces). - -2. A la derecha del codespace que quieres borrar, haz clic en {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} y luego en **Borrar {% octicon "trash" aria-label="The trash icon" %}** ![Botón de borrar](/assets/images/help/codespaces/delete-codespace.png) - -### Borrar un codespace en {% data variables.product.prodname_vscode %} - -Para obtener más información sobre borrar un codespace en {% data variables.product.prodname_vscode %}, consulta la sección "[Utilizar Codespaces en Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)". diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index 461bf24cdc..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Desarrollar en un codespace -intro: 'Puedes abrir un codespace en {% data variables.product.product_name %} y después desarrollar utilizando las características de {% data variables.product.prodname_vscode %}.' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca del desarrollo con {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} te proporciona la experiencia completa de desarrollo de {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} - -![Resumen de codespace con anotaciones](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. Barra lateral - Predeterminadamente, esta área te muestra los archivos de tu proyexcto en el explorador. -2. Barra de actividad - Esto muestra las vistas y te proporciona una forma de cambiar entre ellas. Puedes volver a ordenar las vistas si las arrastras y las sueltas. -3. Editor - Aquí es donde editas tus archivos. Puedes utilzar la pestaña para que cada editor la posicione exactamente donde la necesitas. -4. Paneles - Aquí es donde puedes ver la información de salida y depuración, así como el lugar predeterminado para la Terminal integrada. -5. Barra de estado - Esta área te proporciona información útil sobre tu codespace y proyecto. Por ejemplo, el nombre de rama, los puertos configurados y más. - -Para obtener más información sobre cómo utilizar {% data variables.product.prodname_vscode %}, consulta la [Guía de interface de usuario](https://code.visualstudio.com/docs/getstarted/userinterface) en la documentación de {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} Para obtener más información, consulta la sección "[Solucionar problemas de tu codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)". - -#### Personalizar tu codespace - -{% data reusables.codespaces.about-personalization %} Para obtener más información, consulta la sección "[Personalizar {% data variables.product.prodname_codespaces %} para tu cuenta](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)". - -{% data reusables.codespaces.apply-devcontainer-changes %} Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)". - -#### Ejecutar tu app desde un codespace -{% data reusables.codespaces.about-port-forwarding %} Para obtener más información, consulta la sección "[Abrir puertos en tu codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)". - -#### Configramr tus cambios - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Navegar a un codespace existente - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. Da clic en el nombre del codespace en el cual quieras desarrollar. ![Nombre del codespace](/assets/images/help/codespaces/click-name-codespace.png) - -Como alternativa, puedes ver cualquier codespace activo para un repositorio si navegas al repositorio en el que se hizo y seleccionas **Codespaces {% octicon "codespaces" aria-label="The codespaces icon" %}**. diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index 073026b8f2..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Reenviar puertos en tu codespace -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de los puertos reenviados - -La redirección de puertos te otorga acceso a los puertos CRP dentro de tu codespace. Por ejemplo, si estás ejecutando una aplicación web en el puerto 4000, puedes acceder a esta desde tu buscador para probarla y depurarla. - -Cuando una aplicación que se ejecuta en un codespace da salida a la consola a un puerto, el {% data variables.product.prodname_codespaces %} detecta el patrón de URL del host local y reenvía el puerto automáticamente. Puedes hacer clic en la URL de la terminal para abrir el puerto en un buscador. Por ejemplo, si una aplicación da como salida `http://127.0.0.1:4000` o `http://localhost:4000` en la consola, la bitácora convertirá la salida automáticamente en una URL para el puerto 4000 en la que se puede dar clic. - -![Reenvío automático de puertos](/assets/images/help/codespaces/automatic-port-forwarding.png) - -También puedes reenviar un puerto manualmente, etiquetar puertos reenviados, compartir puertos reenviados públicamente y agregar puertos reenviados a la configuración del codespace. - -### Reenviar un puerto - -Puedes reenviar manualmente a un puerto que no se haya reenviado automáticamente. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Debajo de la lista de puertos, haz clic en **Agregar puerto**. ![Botón de agregar puerto](/assets/images/help/codespaces/add-port-button.png) -1. Teclea el número de puerto o de dirección y luego presiona enter. ![Botón de caja de texto para teclear el puerto](/assets/images/help/codespaces/port-number-text-box.png) - -### Etiquetar un puerto - -Puedes etiquetar un puerto para hacerlo más fácil de identificar en una lista. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Pasa el mouse sobre el puerto que quieras etiquetar y luego haz clic en el icono de etiqueta. ![Icono de etiqueta para el puerto](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### Compartir un puerto - -Si quieres compartir un puerto reenviado con otros, puedes hacerlo público. Después de que lo haces público, cualquiera con la URL del puerto puede ver la aplicación que se ejecuta sin necesidad de autenticarse. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Haz clic derecho en el puerto que quieres compartir y luego en **Hacer público**. ![Opción para hacer el puerto público en el menú de clic derecho](/assets/images/help/codespaces/make-public-option.png) -1. A la derecha de la dirección local del puerto, haz clic en el icono de copiar. ![Copiar el icono para la URL del puerto](/assets/images/help/codespaces/copy-icon-port-url.png) -1. Envía la URL copiada a la persona con la que quieras compartir el puerto. - -### Agregar el peurto a la configuración del codespace - -Puedes agregar un puerto reenviado a la configuración de {% data variables.product.prodname_codespaces %} del repositorio para que este pueda reenviarse automáticamente a todos los codespaces que se crearon desde el repositorio. Después de que actualizas la configuración, cualquier codespace creado debe reconstruirse para que el cambio se aplique. Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)". - -Puedes configurar manualmente los puertos reenviados en un archivo `.devcontainer.json` utilizando la propiedad `forwardPorts` o puedes utilizar el panel "Puertos" en tu codespace. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Haz clic derecho en el puerto que quieras agregar a la configuración del codespace y luego haz clic en **Configurar etiqueta y actualizar devcontainer.json**. ![Opción para configurar una etiqueta y agregar el puerto a devcntainer.json en el menú de clic derecho](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/index.md b/translations/es-ES/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index f0b7554478..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Desarrollar en un codespace -intro: 'Crea un codespace para comenzar a desarrollar tu proyecto dentro de un ambiente dedicado en la nube. Puedes utilizar puertos reenviados para ejecutar tu aplicación e incluso utilizar codespaces dentro de {% data variables.product.prodname_vscode %}' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index d23fcf4096..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Utilizar codespaces en Visual Studio Code -intro: 'Puedes desarrollar tu codespace directamente en {% data variables.product.prodname_vscode %} si conectas la extensión de {% data variables.product.prodname_github_codespaces %} con tu cuenta en {% data variables.product.product_name %}.' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Prerrequisitos - -Para hacer desarrollos en un codespace directamente desde {% data variables.product.prodname_vscode %}, debes ingresar en la extensión de {% data variables.product.prodname_github_codespaces %}. La extensión de {% data variables.product.prodname_github_codespaces %} requiere el lanzamiento 1.51 de octubre de 2020 de {% data variables.product.prodname_vscode %} o superior. - -Utiliza {% data variables.product.prodname_vs %} Marketplace para instalar la extensión de [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). Para obtener más información, consulta la sección[Extensión de Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) en la documentación de {% data variables.product.prodname_vscode %}. - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Da clic en **Registrarse para ver {% data variables.product.prodname_dotcom %}...**. ![Registrarse para ver {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. Para autorizar a {% data variables.product.prodname_vscode %} para acceder a tu cuenta en {% data variables.product.product_name %}, da clic en **Permitir**. -4. Regístrate en {% data variables.product.product_name %} para aprobar la extensión. - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Utiliza el menú desplegable de "REMOTE EXPLORER" y luego da clic en **{% data variables.product.prodname_github_codespaces %}**. ![El encabezado {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. Da clic en **Registrarse para ver {% data variables.product.prodname_codespaces %}...**. ![Registrarse para ver {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. Para autorizar a {% data variables.product.prodname_vscode %} para acceder a tu cuenta en {% data variables.product.product_name %}, da clic en **Permitir**. -5. Regístrate en {% data variables.product.product_name %} para aprobar la extensión. - -{% endwindows %} - -### Crear un codespace en {% data variables.product.prodname_vscode %} - -Despuès de que conectas tu cuenta de {% data variables.product.product_name %} a la extensiòn de {% data variables.product.prodname_github_codespaces %}, puedes desarrollar en un codespace que hayas creado en {% data variables.product.product_name %} o en {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Da clic en el icono de Agregar y luego en **Crear codespace nuevo**. ![La opciòn de crear un codespace nuevo en {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/create-codespace-vscode.png) -3. Teclea y luego da clic en el nombre del repositorio en el que quieras desarrollar. ![Buscar un repositorio para crear un {% data variables.product.prodname_codespaces %} nuevo](/assets/images/help/codespaces/choose-repository-vscode.png) -4. Da clic en la rama en la que quieras desarrollar. ![Buscar una rama para crear un {% data variables.product.prodname_codespaces %} nuevo](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Haz clic en el tipo de máquina en la que quieres desarrollar. ![Tipos de instancia para un {% data variables.product.prodname_codespaces %} nuevo](/assets/images/help/codespaces/choose-sku-vscode.png) -### Abrir un codespace en {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Debajo de "Codespaces", da clic en el codespace en el que quieras desarrollar. -3. Da clic en en el icono de conexión al codespace. ![Icono de conectarse al codespace en {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### Cambiar el tipo de máquina en {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.codespaces-machine-types %} - -Puedes cambiar el tipo de máquina de tu codespace en cualquier momento. - -1. En {% data variables.product.prodname_vscode %}, abre la paleta de comandos (`shift command P` / `shift control P`). -2. Busca y selecciona "Codespaces: Cambiar mi tipo de máquina". ![Buscar una rama para crear un {% data variables.product.prodname_codespaces %} nuevo](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Haz clic en el codespace que quieras cambiar. ![Buscar una rama para crear un {% data variables.product.prodname_codespaces %} nuevo](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Elige el tipo de máquina que quieres utilizar. ![Buscar una rama para crear un {% data variables.product.prodname_codespaces %} nuevo](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -Si el codespace se está ejecutando actualmente, se mostrará un mensaje que pregunta si te gustaría reiniciar y reconectarte con tu codespace ahora. Haz clic en **Sí** en caso de que quieras cambiar el tipo de máquina que se utiliza para este codespace inmediatamente. Si haces clic en **No** o si el codespace no se está ejecutando actualmente, el cambio se reflejará la próxima vez que este se reinicie. - -### Borrar un codespace en {% data variables.product.prodname_vscode %} - -1. Debajo de "Codespaces", da clic derecho en el codespace que quieras borrar. -2. En el menù desplegable, da clic en **Borrar codespace**. ![Borrar un codespace en {% data variables.product.prodname_dotcom %}](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index 780e16af30..0000000000 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Utilizar el control de código fuente en tu codespace -intro: 'Después de hacer cambios en un archivo de tu codespace, puedes confirmar los cambios rápidamente y subir tu actualización al repositorio remoto.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca del control de código fuente en {% data variables.product.prodname_codespaces %} - -Puedes llevar a cabo todas las acciones de Git que necesites directamente dentro de tu codespace. Por ejemplo, puedes recuperar cambios del repositorio remoto, cambiar de rama, crear una rama nueva, confirmar y subir cambios y crear solicitudes de cambios. Puedes utilizar la terminal integrada dentro de tu codespace para ingresar comandos de Git o puedes hacer clic en los iconos u opciones de menú para completar las tareas más comunes de Git. Esta guía te explica cómo utilizar la interface de usuario gráfica para el control de código fuente. - -El control de fuentes en {% data variables.product.prodname_github_codespaces %} utiliza el mismo flujo de trabajo que {% data variables.product.prodname_vscode %}. Para obtener más información, consulta la sección de la documentación de {% data variables.product.prodname_vscode %} "[Utilizar el control de versiones en VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)". - -Un flujo de trabajo típico para actualizar un archivo utilizando {% data variables.product.prodname_github_codespaces %} sería: - -* Desde la rama predeterminada de tu repositorio en {% data variables.product.prodname_dotcom %}, crea un codespace. Consulta la sección "[Crear un codespace](/codespaces/developing-in-codespaces/creating-a-codespace)". -* En tu codespace, crea una rama nueva para trabajar en ella. -* Haz tus cambios y guárdalos. -* Confirma el cambio. -* Levanta una solicitud de cambios. - -### Crear o cambiar de rama - -1. Si la rama actual no se muestra en la barra de estado, en la parte inferior de tu codespace, haz clic derecho en la barra de estado y selecciona **Control de código fuente**. -1. Haz clic en el nombre de rama en la barra de estado. ![La rama en la barra de estado](/assets/images/help/codespaces/branch-in-status-bar.png) -1. En el menú desplegable, haz clic en la rama a la que quieras cambiar o ingresa el nombre de una rama nueva y haz clic en **Crear rama nueva**. ![Elige del menú de la rama](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**Tip**: Si alguien cambió un archivo en el repositorio remoto, en la rama a la cual te cambiaste, no verás estos cambios hasta que los extraigas hacia tu codespace. - -{% endtip %} - -### Extraer cambios del repositorio remoto - -Puedes extraer cambios del repositorio remoto hacia tu codespace en cualquier momento. - -{% data reusables.codespaces.source-control-display-dark %} -1. En la parte superior de la barra lateral, haz clic en los puntos suspensivos (**...**). ![Botón de puntos suspensivos para las acciones de "más" y "ver"](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. En el menú desplegable, haz clic en **Extraer**. - -Si algún contenedor dev cambió desde que creaste el codespace, puedes aplicar los cambios si recompilas el contenedor para el codespace. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)". - -### Configurar tu codespace para que recupere los cambios nuevos automáticamente - -Puedes configurar tu codespace para que recupere automáticamente los detalles de cualquier confirmación nueva que se haya hecho al repositorio remoto. Esto te permite ver si tu copia local del repositorio está desactualizada, en cuyo caso, podrías elegir extraer los cambios nuevos. - -Si la operación de búsqueda detecta cambios nuevos en el repositorio remoto, verás la cantidad de confirmaciones nuevas en la barra de estado. Luego podrás extraer los cambios en tu copia local. - -1. Haz clic en el botón de **Administrar** en la parte inferior de la barra de actividad. ![Botón de administrar](/assets/images/help/codespaces/manage-button.png) -1. En el menú, haz clic en **Ajustes**. -1. En la página de ajustes, busca: `autofetch`. ![Buscar la recuperación automática](/assets/images/help/codespaces/autofetch-search.png) -1. Para recuperar los detalles de las actualizaciones para todos los remotos registrados para el repositorio actual, configura **Git: Autofetch** en `all`. ![Habilitar la recuperación automática en Git](/assets/images/help/codespaces/autofetch-all.png) -1. Si quieres cambiar la cantidad de segundos entre cada recuperación automática, edita el valor de **Git: Autofetch Period**. - -### Configramr tus cambios - -{% data reusables.codespaces.source-control-display-dark %} -1. Para probar tus cambios, haz clic en **+** junto al archivo que cambiaste o junto a **Cambios** si cambiaste archivos múltiples y quieres probarlos todos. ![Barra lateral de control de código fuente con el botón de preparación resaltado](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. Teclea un mensaje de confirmación que describa el cambio que hiciste. ![Barra de control de código fuente con un mensaje de confirmación](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. Para confirmar tus cambios planeados, haz clic en la marca de verificación en la parte superior de la barra lateral del control de código fuente. ![Haz clic en el icono de verificación](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### Levantar una solicitud de cambios - -1. Después de haber confirmado los cambios en tu copia local del repositorio, haz clic en el icono de **Crear solicitud de cambios**. ![Barra lateral de control de código fuente con el botón de preparación resaltado](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Verifica que el repositorio y la rama local desde la que estás haciendo la fusión y la rama y repositorio remotos hacia los que estés haciendo la fusión sean correctos. Después, asigna un nombre y descripción a la solicitud de cambios. ![Barra lateral de control de código fuente con el botón de preparación resaltado](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. Da clic en **Crear**. - -### Subir cambios a tu repositorio remoto - -Puedes subir los cambios que has hecho. Esto aplica a aquellos de la rama ascendente en el repositorio remoto. Puede que necesites hacer eso si aún no estás listo para crear una solicitud de cambios o si prefieres crearla en {% data variables.product.prodname_dotcom %}. - -1. En la parte superior de la barra lateral, haz clic en los puntos suspensivos (**...**). ![Botón de puntos suspensivos para las acciones de "más" y "ver"](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. En el menú desplegable, haz clic en **Subir**. diff --git a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index d074a19501..0000000000 --- a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Iniciar con tu proyecto de C# (.NET) en Codespaces -shortTitle: Iniciar con tu proyecto de C# (.NET) -allowTitleToDifferFromFilename: true -intro: 'Inicia con tu proyecto de C# (.NET) en {% data variables.product.prodname_codespaces %} creando un contenedor dev personalizado.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introducción - -Esta guía te muestra cómo configurar tu proyecto de C# (.NET) en {% data variables.product.prodname_codespaces %}. Te mostrará un ejemplo de cómo abrir tu proyecto en un codespace y cómo agregar y modificar una configuración de contenedor de dev desde una plantilla. - -#### Prerrequisitos - -- Debes tener un proyecto existente de C# (.NET) en un repositorio de {% data variables.product.prodname_dotcom_the_website %}. Si no tienes un proyecto, puedes probar este tutorial con el siguiente ejemplo: https://github.com/2percentsilk/dotnet-quickstart. -- Debes tener {% data variables.product.prodname_codespaces %} habilitado en tu organización. - -### Paso 1: Abre tu proyecto en un codespace - -1. Navega al repositorio de tu proyecto. Utiliza el menú desplegable de {% octicon "download" aria-label="The download icon" %}**Código** y selecciona **Abrir con Codespaces**. Si no ves esta opción, tu proyecto no está disponible para {% data variables.product.prodname_codespaces %}. - - ![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para crear un codespace nuevo, haz clic en {% octicon "plus" aria-label="The plus icon" %} **Codespace nuevo**. ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) - -Cuando creas un codespace, tu proyecto se crea en una MV remota dedicada a ti. Predeterminadamente, el contenedor de tu codespace tiene muchos lenguajes de programación y tiempos de ejecución, incluyendo a .NET. También incluye un conjunto de herramientas comunes como git, wget, rsync, openssh y nano. - -Puedes personalizar tu codespace si ajustas la cantidad de vCPU y RAM, [agregando dotfiles para personalizar tu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account) o modificando las herramientas y scripts instalados. - -{% data variables.product.prodname_codespaces %} utiliza un archivo denominado `devcontainer.json` para almacenar configuraciones. Cuando se lanzan, los {% data variables.product.prodname_codespaces %} utilizan el archivo para instalar cualquier herramienta, dependencia u otro tipo de configuración que pueda necesitarse para el proyecto. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -### Paso 2: Agrega un contenedor de dev a tu codespace desde una plantilla - -El contenedor predeterminado para los codespaces tiene la última versión de .NET y las herramientas más recientes preinstaladas. Sin embargo, te exhortamos a que configures un contenedor personalizado para que puedas diseñar las herramientas y scripts que se ejecutan como parte de la creación de un codespace para que satisfagan las necesidades de tu proyecto y garanticen un ambiente totalmente reproducible para todos los usuarios de {% data variables.product.prodname_codespaces %} en tu repositorio. - -Para configurar tu proyecto con un contenedor personalizado, necesitarás utilizar un archivo `devcontainer.json` para definir el ambiente. En {% data variables.product.prodname_codespaces %}, puedes agregarlo ya sea desde una plantilla o puedes crear el tuyo propio. Para obtener más información sobre contenedores dev, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -1. Accede a la paleta de comandos (`shift command P` / `shift control P`), y luego comienza a teclear "dev container". Haz clic en **Codespaces: Agregar archivos de configuración de contenedores de desarrollo...** !["Codespaces: Agregar archivos de configuración de contenedores de desarrollo..." en la paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. Para este ejemplo, haz clic en **C# (.NET)**. Si necesitas características adicionales puedes seleccionar cualquier contenedor que sea específico para C# (.NET) o una combinación de herramientas tales como C# (.NET) y MS SQL. ![Selecciona la opción de C# (.NET) de la lista](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. Haz clic en la versión recomendada de .NET. ![Selección de la versión de.NET](/assets/images/help/codespaces/add-dotnet-version.png) -4. Acepta la opción predeterminada para agregar a Node.js a tu personalización. ![Agregar la selección Node.js](/assets/images/help/codespaces/dotnet-options.png) -5. Para volver a compilar tu contenedor, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomía de tu contenedor dev - -El agregar la plantilla de contenedor dev de C# (.NET) agregará una carpeta de `.devcontainer` a la raíz del repositorio de tu proyecto con los siguientes archivos: - -- `devcontainer.json` -- Dockerfile - -El archivo `devcontainer.json` recién agregado define unas cuantas propiedades que se describen después de la muestra. - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - Puedes nombrar a tu contenedor dev como quieras, esto es solo lo predeterminado. -- **Build** - Las propiedades de compilación. - - **Dockerfile** - En el objeto de compilación, `dockerfile` es una referencia al Dockerfile que también se agregó desde la plantilla. - - **Args** - - **Variant**: Este archivo solo contiene el argumento de compilación, el cual es la versión de .NET Core que queremos utilizar. -- **Settings** - Esta es la configuración de {% data variables.product.prodname_vscode %}. - - **Terminal.integrated.shell.linux** - Si bien bash es lo predeterminado aquí, podrías utilizar otros shells de terminal si lo modificas. -- **Extensions** - Estas son las extensiones que se incluyen predeterminadamente. - - **ms-dotnettools.csharp** - La extensión de C# de Microsoft proporciona soporte enriquecido para desarrollar en C#, incluyendo características tales como IntelliSense, limpieza de código, depuración, navegación de código, formateo de código, refactorización, explorador de variables, explorador de pruebas y más. -- **forwardPorts** - Cualquier puerto que se liste aquí se reenviará automáticamente. -- **postCreateCommand** - Si quieres ejecutar cualquier cosa después de que llegas a tu codespace y esto no se define en el Dockerfile, como `dotnet restore`, puedes hacerlo aquí. -- **remoteUser** - Predeterminadamente, lo estás ejecutando como el usuario de vscode, pero puedes configurar esto como root opcionalmente. - -##### Dockerfile - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -Puedes utilizar este Dockerfile para agregar capas de contenedor adicionales y especificar paquetes de SO, versiones de nodo o paquetes globales que queremos incluir en nuestro contenedor. - -### Paso 3: Modifica tu archivo devcontainer.json - -Ahora que agregaste tu contenedor dev y tienes un entendimiento básico de lo que hace cada cosa, puedes hacer cambios para configurarlo para tu ambiente. En este ejemplo, agregarás porpiedades para instalar extensiones y restablecer las dependencias de tu proyecto cuando se lance tu codespace. - -1. En el explorador, expande la carpeta `.devcontainer` y selecciona el archivo `devcontainer.json` del árbol para abrirlo. - - !["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Actualiza tu lista de `extensions` en tu archivo `devcontainer.json` para agregar algunas extensiones que son útiles al trabajar con tu proyecto. - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Deja de comentar el `postCreateCommand` para restablecer las dependencias como parte del proceso de configuración del codespace. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "dotnet restore", - ``` - -4. Para volver a compilar tu contenedor y aplicar los cambios del devcontainer.json, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. - - ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - - Reconstruir dentro de tu codespace garantiza que tus cambios funcionan como se espera antes de que los confirmes los en el repositorio. Si algo falla, se te colocará en un codespace con un contenedor de recuperación desde el cual puedes volver a compilar para seguir ajustando tu contenedor. - -5. Verifica que tus cambios se hayan aplicado con éxito verificando que se haya instalado la extensión "Code Spell Checker". - - ![Lista de extensiones](/assets/images/help/codespaces/dotnet-extensions.png) - -### Paso 4: Ejecuta tu aplicación - -En la sección anterior, utilizaste `postCreateCommand` para instalar un conjunto de paquetes a través de pip3. Ahora que instalamos nuestras dependencias, podemos ejecutar nuestra aplicación. - -1. Ejecuta tu aplicación presionando `F5` o ingresando `dotnet watch run` en tu terminal. - -2. Cuando tu proyecto inicia, debes ver una alerta en la esquina inferior derecha con un mensaje para conectarte al puerto que utiliza tu proyecto. - - ![Notificación de reenvío de puertos](/assets/images/help/codespaces/python-port-forwarding.png) - -### Paso 5: Confirma tus cambios - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Pasos siguientes - -Ahora debes estar listo para comenzar a desarrollar tu proyecto de C# (.NET) en {% data variables.product.prodname_codespaces %}. Aquí tienes algunos recursos adicionales para situaciones más avanzadas. - -- [Administrar secretos cifrados para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Administrar la verificación GPG para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Reenviar puertos en tu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index 22850354b6..0000000000 --- a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: Iniciar con tu proyecto de Java en Codespaces -shortTitle: Iniciar con tu proyecto de Java -intro: 'Inica con tu proyecto de Java en {% data variables.product.prodname_codespaces %} creando un contenedor dev personalizado.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introducción - -Esta guía te muestra cómo configurar tu proyecto de Java en {% data variables.product.prodname_codespaces %}. Te mostrará un ejemplo de cómo abrir tu proyecto en un codespace y cómo agregar y modificar una configuración de contenedor de dev desde una plantilla. - -#### Prerrequisitos - -- Debes tener un proyecto de Java existente en un repositorio de {% data variables.product.prodname_dotcom_the_website %}. Si no tienes un proyecto, puedes probar este tutorial con el siguiente ejemplo: https://github.com/microsoft/vscode-remote-try-java -- Debes tener {% data variables.product.prodname_codespaces %} habilitado en tu organización. - -### Paso 1: Abre tu proyecto en un codespace - -1. Navega al repositorio de tu proyecto. Utiliza el menú desplegable de {% octicon "download" aria-label="The download icon" %}**Código** y selecciona **Abrir con Codespaces**. Si no ves esta opción, tu proyecto no está disponible para {% data variables.product.prodname_codespaces %}. - - ![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para crear un codespace nuevo, haz clic en {% octicon "plus" aria-label="The plus icon" %} **Codespace nuevo**. ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) - -Cuando creas un codespace, tu proyecto se crea en una MV remota dedicada a ti. Predeterminadamente, el contenedor para tu codespace tiene muchos lenguajes y tiempos de ejecución, incluyendo Java, nvm, npm, y yarn. También incluye un conjunto de herramientas comunes como git, wget, rsync, openssh y nano. - -Puedes personalizar tu codespace si ajustas la cantidad de vCPU y RAM, [agregando dotfiles para personalizar tu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account) o modificando las herramientas y scripts instalados. - -{% data variables.product.prodname_codespaces %} utiliza un archivo denominado `devcontainer.json` para almacenar configuraciones. Cuando se lanzan, los {% data variables.product.prodname_codespaces %} utilizan el archivo para instalar cualquier herramienta, dependencia u otro tipo de configuración que pueda necesitarse para el proyecto. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -### Paso 2: Agrega un contenedor de dev a tu codespace desde una plantilla - -El contenedor predeterminado para los codespaces viene con la última versión de Java, adminsitradores de paquetes (Maven, Gradle) y otras herramientas comunes preinstaladas. Sin embargo, te recomendamos que configures un contenedor personalizado para definir las herramientas y scripts que necesita tu proyecto. Esto garantizará un ambiente totalmente reproducible para todos los usuarios de {% data variables.product.prodname_codespaces %} de tu repositorio. - -Para configurar tu proyecto con un contenedor personalizado, necesitarás utilizar un archivo `devcontainer.json` para definir el ambiente. En {% data variables.product.prodname_codespaces %}, puedes agregarlo ya sea desde una plantilla o puedes crear el tuyo propio. Para obtener más información sobre contenedores dev, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -1. Accede a la paleta de comandos (`shift command P` / `shift control P`), y luego comienza a teclear "dev container". Haz clic en **Codespaces: Agregar archivos de configuración de contenedores de desarrollo...** !["Codespaces: Agregar archivos de configuración de contenedores de desarrollo..." en la paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. Para este ejemplo, haz clic en **Java**. En la práctica, podrías seleccionar cualquier contenedor que sea específico de Java o una combinación de herramientas tales como Java y Azure Functions. ![Selecciona la opción de Java de la lista](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Haz clic en la versión recomendada de Java. ![Selección de la versión de Java](/assets/images/help/codespaces/add-java-version.png) -5. Para volver a compilar tu contenedor, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomía de tu contenedor dev - -El agregar la plantilla de contenedor dev de Java agrega una carpeta de `.devcontainer` a la raíz del repositorio de tu proyecto con los siguientes archivos: - -- `devcontainer.json` -- Dockerfile - -El archivo `devcontainer.json` recién agregado define unas cuantas propiedades que se describen después de la muestra. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - Puedes nombrar a tu contenedor dev como quieras, esto es solo lo predeterminado. -- **Build** - Las propiedades de compilación. - - **Dockerfile** - En el objeto de compilación, dockerfile es una referencia al Dockerfile que también se agregó desde la plantilla. - - **Args** - - **Variant**: Este archivo solo contiene un argumento de compilación, el cual es la versión de Java que se pasa al Dockerfile. -- **Settings** - Estos son los ajustes de {% data variables.product.prodname_vscode %} que puedes configurar. - - **Terminal.integrated.shell.linux** - Si bien bash es lo predeterminado aquí, podrías utilizar otros shells de terminal si lo modificas. -- **Extensions** - Estas son las extensiones que se incluyen predeterminadamente. - - **Vscjava.vscode-java-pack** - El paquete de extensión de Java proporciona extensiones populares para que puedas comenzar a desarrollar en Java. -- **forwardPorts** - Cualquier puerto que se liste aquí se reenviará automáticamente. -- **postCreateCommand** - Si quieres ejecutar lo que sea después de que llegas a tu codespace, lo cual no está definido en tu Dockerfile, puedes hacerlo aquí. -- **remoteUser** - Predeterminadamente, lo estás ejecutando como el usuario de `vscode`, pero puedes configurar esto como `root` opcionalmente. - -##### Dockerfile - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -Puedes utilizar este Dockerfile para agregar capas de contenedor adicionales y especificar paquetes de SO, versiones de Java o paquetes globales que queremos incluir en nuestro Dockerfile. - -### Paso 3: Modifica tu archivo devcontainer.json - -Ahora que agregaste tu contenedor dev y tienes un entendimiento básico de lo que hace cada cosa, puedes hacer cambios para configurarlo para tu ambiente. En este ejemplo, agregarás porpiedades para instalar extensiones y tus dependencias de pryecto cuando se lance tu codespace. - -1. En el explorador, selecciona el archivo `devcontainer.json` del árbol para abrirlo. Puede que tengas que expandir la carpeta `.devcontainer` para verlo. - - !["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Agrega las siguientes líneas a tu archivo `devcontainer.json` después de `extensions`. - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - Para obtener más información sobre las propiedades de `devcontainer.json`, consulta las [referencias de devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) en los documentos de Visual Studio Code. - -3. Para volver a compilar tu contenedor, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. - - ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - - Reconstruir dentro de tu codespace garantiza que tus cambios funcionan como se espera antes de que los confirmes los en el repositorio. Si algo falla, se te colocará en un codespace con un contenedor de recuperación desde el cual puedes volver a compilar para seguir ajustando tu contenedor. - - -### Paso 4: Ejecuta tu aplicación - -En la sección anterior, utilizaste `postCreateCommand` para instalar un conjunto de paquetes a través de npm. Ahora puedes utilizar esto para ejecutar nuestra aplicación con npm. - -1. Ejecuta tu aplicación presionando `F5`. - -2. Cuando tu proyecto inicia, debes ver una alerta en la esquina inferior derecha con un mensaje para conectarte al puerto que utiliza tu proyecto. - - ![Notificación de reenvío de puertos](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Paso 5: Confirma tus cambios - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Pasos siguientes - -Ahora debes estar listo para desarrollar tu proyecto de Java en {% data variables.product.prodname_codespaces %}. Aquí tienes algunos recursos adicionales para situaciones más avanzadas. - -- [Administrar secretos cifrados para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Administrar la verificación GPG para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Reenviar puertos en tu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index 403ead5f3e..0000000000 --- a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Iniciar con tu proyecto de Node.js en Codespaces -shortTitle: Iniciar con tu proyecto de Node.js -intro: 'Inicia con tu proyecto de JavaScript, Node.js o TypeScript en {% data variables.product.prodname_codespaces %} creando un contenedor dev personalizado.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### Introducción - -Esta guía te muestra cómo configurar tu proyecto de JavaScript, Node.js o TypeScript en {% data variables.product.prodname_codespaces %}. Te mostrará un ejemplo de cómo abrir tu proyecto en un codespace y cómo agregar y modificar una configuración de contenedor de dev desde una plantilla. - -#### Prerrequisitos - -- Debes tener un proyecto existente de JavaScript, Node.js, TypeScript en un repositorio de {% data variables.product.prodname_dotcom_the_website %}. Si no tienes un proyecto, puedes probar este tutorial con el siguiente ejemplo: https://github.com/microsoft/vscode-remote-try-node -- Debes tener {% data variables.product.prodname_codespaces %} habilitado en tu organización. - -### Paso 1: Abre tu proyecto en un codespace - -1. Navega al repositorio de tu proyecto. Utiliza el menú desplegable de {% octicon "download" aria-label="The download icon" %}**Código** y selecciona **Abrir con Codespaces**. Si no ves esta opción, tu proyecto no está disponible para {% data variables.product.prodname_codespaces %}. - - ![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para crear un codespace nuevo, haz clic en {% octicon "plus" aria-label="The plus icon" %} **Codespace nuevo**. ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) - -Cuando creas un codespace, tu proyecto se crea en una MV remota dedicada a ti. Predeterminadamente, el contenedor para tu codespace tiene muchos lenguajes y tiempos de ejecución, incluyendo a Node.js, JavaScript, TypeScript, nvm, npm y yarn. También incluye un conjunto de herramientas comunes como git, wget, rsync, openssh y nano. - -Puedes personalizar tu codespace si ajustas la cantidad de vCPU y RAM, [agregando dotfiles para personalizar tu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account) o modificando las herramientas y scripts instalados. - -{% data variables.product.prodname_codespaces %} utiliza un archivo denominado `devcontainer.json` para almacenar configuraciones. Cuando se lanzan, los {% data variables.product.prodname_codespaces %} utilizan el archivo para instalar cualquier herramienta, dependencia u otro tipo de configuración que pueda necesitarse para el proyecto. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -### Paso 2: Agrega un contenedor de dev a tu codespace desde una plantilla - -El contenedor predeterminado de codespaces será compatible para ejecutar proyectos de Node.js como [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) fuera de la caja. Al configurar un contenedor personalizado, puedes personalizar las herramientas y scripts que se ejecutan como parte de la creación de codespaces y asegurarte de que haya un ambiente integralmente reproducible para todos los usuarios de {% data variables.product.prodname_codespaces %} en tu repositorio. - -Para configurar tu proyecto con un contenedor personalizado, necesitarás utilizar un archivo `devcontainer.json` para definir el ambiente. En {% data variables.product.prodname_codespaces %}, puedes agregarlo ya sea desde una plantilla o puedes crear el tuyo propio. Para obtener más información sobre contenedores dev, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -1. Accede a la paleta de comandos (`shift command P` / `shift control P`), y luego comienza a teclear "dev container". Haz clic en **Codespaces: Agregar archivos de configuración de contenedores de desarrollo...** !["Codespaces: Agregar archivos de configuración de contenedores de desarrollo..." en la paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. Para este ejemplo, haz clic en **Node.js**. Si necesitas características adicionales, puedes seleccionar cualquier contenedor que sea específico para Node o una combinación de herramientas tales como Node y MongoDB. ![Selecciona la opción Node de la lista](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Haz clic en la versión recomendada de Node.js. ![Selección de la versión de Node.js](/assets/images/help/codespaces/add-node-version.png) -5. Para volver a compilar tu contenedor, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomía de tu contenedor dev - -El agregar la plantilla de contenedor dev de Node.js agregará una carpeta de `.devcontainer` a la raíz del repositorio de tu proyecto con los siguientes archivos: - -- `devcontainer.json` -- Dockerfile - -El archivo `devcontainer.json` recién agregado define unas cuantas propiedades que se describen después de la muestra. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Name** - Puedes nombrar a tu contenedor dev como quieras, esto es solo lo predeterminado. -- **Build** - Las propiedades de compilación. - - **dockerfile** - En el objeto de compilación, dockerfile es una referencia al Dockerfile que también se agregó desde la plantilla. - - **Args** - - **Variant**: Este archivo solo contiene un argumento de compilación, el cual es la variante de nodo que queremos utilizar y que se pasa en el Dockerfile. -- **Settings** - Estos son los ajustes de {% data variables.product.prodname_vscode %} que puedes configurar. - - **Terminal.integrated.shell.linux** - Si bien bash es lo predeterminado aquí, podrías utilizar otros shells de terminal si lo modificas. -- **Extensions** - Estas son las extensiones que se incluyen predeterminadamente. - - **Dbaeumer.vscode-eslint** - ES lint es una extención genial para limpiar código, pero para JavaScript, hay varias extensiones buenas en Marketplace que también podrías incluir. -- **forwardPorts** - Cualquier puerto que se liste aquí se reenviará automáticamente. -- **postCreateCommand** - Si quieres ejecutar lo que sea después de que llegas a tu codespace, lo cual no está definido en tu Dockerfile, puedes hacerlo aquí. -- **remoteUser** - Predeterminadamente, lo estás ejecutando como el usuario de vscode, pero puedes configurar esto como root opcionalmente. - -##### Dockerfile - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -Puedes utilizar este Dockerfile para agregar capas de contenedor adicionales y especificar paquetes de SO, versiones de nodo o paquetes globales que queremos incluir en nuestro Dockerfile. - -### Paso 3: Modifica tu archivo devcontainer.json - -Ahora que agregaste tu contenedor dev y tienes un entendimiento básico de lo que hace cada cosa, puedes hacer cambios para configurarlo para tu ambiente. En este ejemplo, agregarás propiedades para instalar npm cuando tu codespace se lance y haga una lista de puertos dentro del contenedor que está disponible localmente. - -1. En el explorador, selecciona el archivo `devcontainer.json` del árbol para abrirlo. Puede que tengas que expandir la carpeta `.devcontainer` para verlo. - - !["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Agrega las siguientes líneas a tu archivo `devcontainer.json` después de `extensions`: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - Para obtener más información sobre las propiedades de `devcontainer.json`, consulta la [ referencia de devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) en los documentos de {% data variables.product.prodname_vscode %}. - -3. Para volver a compilar tu contenedor, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. - - ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - - Reconstruir dentro de tu codespace garantiza que tus cambios funcionan como se espera antes de que los confirmes los en el repositorio. Si algo falla, se te colocará en un codespace con un contenedor de recuperación desde el cual puedes volver a compilar para seguir ajustando tu contenedor. - - -### Paso 4: Ejecuta tu aplicación - -En la sección anterior, utilizaste `postCreateCommand` para instalar un conjunto de paquetes a través de npm. Ahora puedes utilizar esto para ejecutar nuestra aplicación con npm. - -1. Ejecuta tu comando de inicio en la terminal con `npm start`. - - ![npm start en la terminal](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. Cuando tu proyecto inicia, debes ver una alerta en la esquina inferior derecha con un mensaje para conectarte al puerto que utiliza tu proyecto. - - ![Notificación de reenvío de puertos](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Paso 5: Confirma tus cambios - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Pasos siguientes - -Ahora debes estar listo para comenzar a desarrollar tu proyecto de JavaScript en {% data variables.product.prodname_codespaces %}. Aquí tienes algunos recursos adicionales para situaciones más avanzadas. - -- [Administrar secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [Administrar la verificación GPG para {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [Reenviar puertos en tu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index 13357e581d..0000000000 --- a/translations/es-ES/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Iniciar con tu proyecto de Python en Codespaces -shortTitle: Iniciar con tu proyecto de Python -intro: 'Iniciar con tu proyecto de Python en {% data variables.product.prodname_codespaces %} creando un contenedor de dev personalizado.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### Introducción - -Esta guía te muestra cómo configurar tu proyecto de Python en {% data variables.product.prodname_codespaces %}. Te mostrará un ejemplo de cómo abrir tu proyecto en un codespace y cómo agregar y modificar una configuración de contenedor de dev desde una plantilla. - -#### Prerrequisitos - -- Debes tener un proyecto existente de Python en un repositorio de {% data variables.product.prodname_dotcom_the_website %}. Si no tienes un proyecto, puedes probar este tutorial con el siguiente ejemplo: https://github.com/2percentsilk/python-quickstart. -- Debes tener {% data variables.product.prodname_codespaces %} habilitado en tu organización. - -### Paso 1: Abre tu proyecto en un codespace - -1. Navega al repositorio de tu proyecto. Utiliza el menú desplegable de {% octicon "download" aria-label="The download icon" %}**Código** y selecciona **Abrir con Codespaces**. Si no ves esta opción, tu proyecto no está disponible para {% data variables.product.prodname_codespaces %}. - - ![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para crear un codespace nuevo, haz clic en {% octicon "plus" aria-label="The plus icon" %} **Codespace nuevo**. ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) - -Cuando creas un codespace, tu proyecto se crea en una MV remota dedicada a ti. Predeterminadamente, el contenedor para tu codespace tiene muchos lenguajes y tiempos de ejecución, incluyendo a Node.js, JavaScript, TypeScript, nvm, npm y yarn. También incluye un conjunto de herramientas comunes como git, wget, rsync, openssh y nano. - -Puedes personalizar tu codespace si ajustas la cantidad de vCPU y RAM, [agregando dotfiles para personalizar tu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account) o modificando las herramientas y scripts instalados. - -{% data variables.product.prodname_codespaces %} utiliza un archivo denominado `devcontainer.json` para almacenar configuraciones. Cuando se lanzan, los {% data variables.product.prodname_codespaces %} utilizan el archivo para instalar cualquier herramienta, dependencia u otro tipo de configuración que pueda necesitarse para el proyecto. Para obtener más información, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -### Paso 2: Agrega un contenedor de dev a tu codespace desde una plantilla - -El contenedor predeterminado de codespaces viene con la última versión de Python, administradores de paquete (pip, Miniconda), y otras herramientas comunes preinstaladas. Sin embargo, te recomendamos que configures un contenedor personalizado para definir las herramientas y scripts que necesita tu proyecto. Esto garantizará un ambiente totalmente reproducible para todos los usuarios de {% data variables.product.prodname_codespaces %} de tu repositorio. - -Para configurar tu proyecto con un contenedor personalizado, necesitarás utilizar un archivo `devcontainer.json` para definir el ambiente. En {% data variables.product.prodname_codespaces %}, puedes agregarlo ya sea desde una plantilla o puedes crear el tuyo propio. Para obtener más información sobre contenedores dev, consulta la sección "[Configurar Codespaces para tu proyecto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -1. Accede a la paleta de comandos (`shift command P` / `shift control P`), y luego comienza a teclear "dev container". Haz clic en **Codespaces: Agregar archivos de configuración de contenedores de desarrollo...** !["Codespaces: Agregar archivos de configuración de contenedores de desarrollo..." en la paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. Para este ejemplo, haz clic en **Python 3**. Si necesitas características adicionales, puedes seleccionar cualquier contenedor que sea específico para Python o una combinación de herramientas tales como Python 3 y PostgreSQL. ![Selecciona la opción Python de la lista](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Haz clic en la versión recomendada de Python. ![Selección de la versión Python](/assets/images/help/codespaces/add-python-version.png) -4. Acepta la opción predeterminada para agregar a Node.js a tu personalización. ![Agregar la selección Node.js](/assets/images/help/codespaces/add-nodejs-selection.png) -5. Para volver a compilar tu contenedor, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomía de tu contenedor dev - -El agregar la plantilla de contenedor dev de Python agregará una carpeta de `.devcontainer` a la raíz del repositorio de tu proyecto con los siguientes archivos: - -- `devcontainer.json` -- Dockerfile - -El archivo `devcontainer.json` recién agregado define unas cuantas propiedades que se describen después de la muestra. - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - Puedes nombrar a tu contenedor dev como quieras, esto es solo lo predeterminado. -- **Build** - Las propiedades de compilación. - - **Dockerfile** - En el objeto de compilación, `dockerfile` es una referencia al Dockerfile que también se agregó desde la plantilla. - - **Args** - - **Variant**: Este archivo solo contiene un argumento de compilación, el cual es la variante de nodo que queremos utilizar y que se pasa en el Dockerfile. -- **Settings** - Esta es la configuración de {% data variables.product.prodname_vscode %}. - - **Terminal.integrated.shell.linux** - Si bien bash es lo predeterminado aquí, podrías utilizar otros shells de terminal si lo modificas. -- **Extensions** - Estas son las extensiones que se incluyen predeterminadamente. - - **ms-python.python** - La extensión de Python de Microsoft te proporciona una compatibilidad enriquecida para el lenguaje Python (para todas las versiones compatibles del lenguaje: >=3.6), incluyendo las característcas tales como IntelliSense, limpieza, depuración, navegación de código, formateo de código, refactorización, explorador de variables, explorador de pruebas y más. -- **forwardPorts** - Cualquier puerto que se liste aquí se reenviará automáticamente. -- **postCreateCommand** - Si quieres ejecutar cualquier cosa después de que llegues a tu codespace y que no se defina en el Dockerfile, como `pip3 install -r requirements`, puedes hacerlo aquí. -- **remoteUser** - Predeterminadamente, lo estás ejecutando como el usuario de `vscode`, pero puedes configurar esto como `root` opcionalmente. - -##### Dockerfile - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -Puedes utilizar este Dockerfile para agregar capas de contenedor adicionales y especificar paquetes de SO, versiones de nodo o paquetes globales que queremos incluir en nuestro contenedor. - -### Paso 3: Modifica tu archivo devcontainer.json - -Ahora que agregaste tu contenedor dev y tienes un entendimiento básico de lo que hace cada cosa, puedes hacer cambios para configurarlo para tu ambiente. En este ejemplo, agregarás porpiedades para instalar extensiones y tus dependencias de pryecto cuando se lance tu codespace. - -1. En el explorador, expande la carpeta `.devcontainer` y selecciona el archivo `devcontainer.json` del árbol para abrirlo. - - !["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Actualiza la lista de `extensions` en tu archivo `devcontainer.json` para agregar algunas extensiones que son útiles al trabajar con tu proyecto. - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Quita el comentario de `postCreateCommand` para instalar automáticamente los requisitos como parte del proceso de configuración de codespaces. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. Para volver a compilar tu contenedor y aplicar los cambios del devcontainer.json, accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclear "rebuild". Haz clic en **Codespaces: Rebuild Container**. - - ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - - Reconstruir dentro de tu codespace garantiza que tus cambios funcionan como se espera antes de que confirmes los cambios en el repositorio. Si algo resulta en un fallo, se te colocará en un codespace con un contenedor de recuperación desde el cual puedes reconstruir para seguir ajustando tu contenedor. - -5. Verifica tus cambios en donde se aplicaron con éxito verificando que se hayan instalado las extensiones "Code Spell Checker" y "Flask Snippet". - - ![Lista de extensiones](/assets/images/help/codespaces/python-extensions.png) - -### Paso 4: Ejecuta tu aplicación - -En la sección anterior, utilizaste `postCreateCommand` para instalar un conjunto de paquetes a través de pip3. Ahora que instalaste tus dependencias, puedes ejecutar tu aplicación. - -1. Ejecuta tu aplicación presionando `F5` o ingresando `python -m flask run` en la terminal del codespace. - -2. Cuando tu proyecto inicia, debes ver una alerta en la esquina inferior derecha con un mensaje para conectarte al puerto que utiliza tu proyecto. - - ![Notificación de reenvío de puertos](/assets/images/help/codespaces/python-port-forwarding.png) - -### Paso 5: Confirma tus cambios - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Pasos siguientes - -Ahora debes estar listo para comenzar a desarrollar tu proyecto de Python en {% data variables.product.prodname_codespaces %}. Aquí tienes algunos recursos adicionales para situaciones más avanzadas. - -- [Administrar secretos cifrados para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Administrar la verificación GPG para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Reenviar puertos en tu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/es-ES/content/codespaces/getting-started-with-codespaces/index.md b/translations/es-ES/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index f81ad81438..0000000000 --- a/translations/es-ES/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Iniciar con {% data variables.product.prodname_codespaces %}' -intro: 'Aprende cómo iniciar con los {% data variables.product.prodname_codespaces %}, incluyendo cómo configurar y hacer ajustes para lenguajes específicos.' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/es-ES/content/codespaces/guides.md b/translations/es-ES/content/codespaces/guides.md deleted file mode 100644 index 35c01d51c0..0000000000 --- a/translations/es-ES/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Guías de codespaces -shortTitle: Guías -intro: 'Aprende cómo sacar el mayor provecho de los {% data reusables.gated-features.codespaces %} de GitHub' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/es-ES/content/codespaces/index.md b/translations/es-ES/content/codespaces/index.md deleted file mode 100644 index 084fcf5a37..0000000000 --- a/translations/es-ES/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Documentación de Codespaces de GitHub -beta_product: true -shortTitle: Acerca de GitHub Codespaces -intro: 'Crea un codespace o comienza a desarrollar en un ambiente de desarrollo seguro, configurable y dedicado que funciona donde y como tu quieras.' -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index e244090735..0000000000 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Managing Codespaces for your organization -intro: 'Puedes administrar y revisar la forma en que los usuarios de tu organización pueden utilizar {% data variables.product.prodname_github_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index 2c95617994..0000000000 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Administrar el acceso y la seguridad para los codespaces de tu organización -shortTitle: Administrar el acceso y la seguridad para tu organización -intro: 'Puedes administrar los repositorios de tu organización a los cuales pueden acceder los {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Los propietarios de la organización pueden administrar a qué repositorios pueden acceder los codespaces. - -Predeterminadamente, un codespace solo puede acceer al repositorio en donde se creó. Cuando habilitas el acceso y la seguridad de un repositorio que pertenece a tu orgnización, cualquier codespace que se cree para dicho repositorio también tendrá permisos de lectura y escritura en el resto de los repositorios que pertenezcan a esa misma organización y a los cuales pueda acceder el creador de dicho codespace. Si quieres restringir los repositorios a los cuales puede acceder un codespace, puedes limitarlos a ya sea el repositorio en donde se creó el codespace o a algunos repositorios específicos. Solo debes habilitar el acceso y la seguridad para los repositorios en los cuales confíes. - -Para administrar qué usuarios de tu organización pueden utilizar {% data variables.product.prodname_codespaces %}, consulta la sección "[Administrar permisos de usuarios para tu organización](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)". - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Debajo de "Acceso y seguridad", selecciona la configuración que quieras para tu organización.![Botones radiales para adminsitrar los repositorios confiables](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. Si eliges "Repositorios seleccionados"; entonces selecciona el menú desplegable y da clic en un repositorio para permitir que los codespaces de éste accedan al resto de los repositorios que pertenecen a tu organización. Repite esto para todos los repositorios cuyos codespaces quieras que accedan al resto de los repositorios. ![Menú desplegable de "Repositorios seleccionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index e47627cba0..0000000000 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Administrar los secretos cifrados de tu repositorio y organización para los Codespaces -shortTitle: Administrar los secretos de tu repositorio y organización -intro: 'Los secretos cifrados te permiten almacenar información sensible en tu organización, repositorio o {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de los secretos - -Los secretos son variables de ambiente cifradas que creas en una organización o repositorio. Los secretos que creas están disponibles para utilizarse en {% data variables.product.prodname_codespaces %}. GitHub utiliza una [caja sellada de libsodium](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) para cifrar los secretos antes de que lleguen a GitHub y solo los decifra cuando los utilizas en un codespace. - -Los secretos a nivel organizacional te permiten compartir secretos entre repositorios múltiples, lo cual reduce la necesidad de crear secretos duplicados. Puedes utilizar las políticas de acceso para controlar qué repositorios pueden utilizar los secretos de la organización. - -{% data reusables.codespaces.secrets-on-start %} - -#### Nombrar secretos - -{% data reusables.codespaces.secrets-naming %} Por ejemplo, un secreto que se creó a nivel de repositorio debe tener un nombre único en dicho repositorio y uno que se haya cerado a nivel organizacional debe tener un nombre único en dicho nivel. - - {% data reusables.codespaces.secret-precedence %} - -#### Límites para los secretos - -Puedes almacenar hasta 100 secretos por organización y 100 por repositorio. - -Los secretos tienen un tamaño máximo de 64 KB. - -### Agregar secretos para un repositorio - -Para crear secretos para un repositorio de la organización, debes tener acceso adminsitrativo. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Navega hacia la parte inferior de la página y, debajo de **Secretos**, selecciona **Codespaces**. ![Opción de codespaces in la barra lateral](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. En la parte superior de la página, haz clci en **Secreto de repositorio nuevo**. -1. Teclea un nombre para tu secreto en el cuadro de entrada **Name**. -1. Ingresa el valor de tu secreto. -1. Haz clic en **Agregar secreto** (Agregar secreto). - -### Agregar secretos para una organización - -Cuando creas un secreto en una organización, puedes utilizar una política para limitar el acceso de los repositorios a este. Por ejemplo, puedes otorgar acceso a todos los repositorios, o limitarlo a solo los repositorios privados o a una lista específica de estos. - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Navega hacia la parte inferior de la página y, debajo de **Secretos**, selecciona **Codespaces**. ![Opción de codespaces in la barra lateral](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. En la parte superior de la página, haz clic en **Nuego secreto de organización**. -1. Teclea un nombre para tu secreto en el cuadro de entrada **Name**. -1. Ingresa el **Valor** para tu secreto. -1. Desde la lista desplegable **Acceso de los repositorios**, elige una política de acceso. ![Lista de acceso a los repositorios con los repositorios privados seleccionados](/assets/images/help/codespaces/secret-repository-access.png) -1. Haz clic en **Agregar secreto** (Agregar secreto). - -### Revisar el acceso a los secretos de nivel organizacional - -Puedes revisar qué políticas de acceso se aplican a un secreto en tu organización. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. La lista de secretos incluye cualquier política y permiso configurado. Por ejemplo: ![Lista de secretos](/assets/images/help/settings/actions-org-secrets-list.png) -1. Para encontrar más detalles sobre los permisos configurados para cada secreto, da clic en **Actualizar**. diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index 13e9c83c31..0000000000 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Administrar los permisos de usuario para tu organización -intro: 'Puedes controlar qué usuarios de tu organización pueden utilizar {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de los permisos de usuario para {% data variables.product.prodname_codespaces %} - -Los propietarios de organización pueden controlar qué usuarios de tu organización pueden crear y utilizar codespaces. - -Para utilizar codespaces en tu organización, tus usuarios deben tener por lo menos acceso de escritura en los repositorios en donde quieren utilizarlos. Puedes habilitar los codespaces para todos los usuarios en tu organización o solo para algunos específicos. - -Predeterminadamente, un codespace solo puede acceer al repositorio en donde se creó. Si quieres que los codespaces de tu organización puedan acceder a otros repositorios de organización a los que puede acceder el creador de dichos codespaces, consulta la sección "[Administrar el acceso y la seguridad de los {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". - -### Configurar qué usuarios de tu organización pueden utilizar {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Debajo de "Permisos de usuario", selecciona una de las siguientes opciones: - - * **Inhabilitado** para no permitir que los miembros de la organización utilicen {% data variables.product.prodname_codespaces %}. - * **Permitir para todos los usuarios** para permitir que todos los miembros de tu organización utilicen los {% data variables.product.prodname_codespaces %}. - * **Usuarios selectos** para seleccionar miembros específicos de la organización que puedan utilizar {% data variables.product.prodname_codespaces %}. - - ![Botones radiales de "Permisos de usuario"](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index 502a2f8262..0000000000 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Revisar las bitácoras de auditoría de tu organización para los codespaces -shortTitle: Revisar las bitácoras de auditoría de tu organización -intro: 'Puedes utilizar la bitácora de auditoría para revisar todas las acciones relacionadas con los {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -Cuando algún miembro de tu organización lleva a cabo una acción relacionada con los {% data variables.product.prodname_codespaces %}, puedes revisar las acciones en la bitácora de auditoría. Para obtener más información sobre cómo acceder a la bitácora, consulta la sección "[Revisar tu bitácora de auditoría](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)". - -![Bitácora de auditoría con información de los codespaces](/assets/images/help/settings/codespaces-audit-log-org.png) - -La bitácora de auditoría incluye detalles tales como quién realizó la acción, qué fue esa acción y cuándo se llevó a cabo. Para obtener información sobre las acciones de los {% data variables.product.prodname_codespaces %}, consulta la sección "[acciones de categoría de los {% data variables.product.prodname_codespaces %}](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)". diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/index.md b/translations/es-ES/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 15e85b7fb6..0000000000 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Administrar tus codespaces -intro: 'Puedes utilizar los ajustes de {% data variables.product.prodname_github_codespaces %} para administrar la información que pudiera necesitar tu codespace.' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index 3008eab46f..0000000000 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Administrar el acceso y la seguridad de tus codespaces -intro: 'Puedes administrar los repositorios a los cuales pueden acceder los {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Cuando habilitas el acceso y la seguridad de un repositorio que pertenezca a tu cuenta de usuario, cualquier codespace que se cree para este tendrá permisos de escritura en el resto de los repositorios que te pertenezcan. Si quieres restringir los repositorios a los que puede acceder un codespace, puedes limitarlos a ya sea el repositorio para el cual se abrió el codespace o a repositorios específicos. Solo debes habilitar el acceso y la seguridad para los repositorios en los cuales confíes. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Debajo de "Acceso y seguridad"; selecciona la configuración que quieras para tu cuenta de usurio. ![Botones radiales para adminsitrar los repositorios confiables](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. Si eliges "Repositorios seleccionados", selecciona el menú desplegable y luego da clic en un repositorio para permitir que los codespaces de éste accedan al resto de los repositorios que te pertenecen. Repite esto para todos los repositorios cuyos codespaces quieras que accedan al resto de tus repositorios. ![Menú desplegable de "Repositorios seleccionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index 38cda61c72..0000000000 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Administrar secretos cifrados para tus codespaces -intro: 'Puedes almacenar información sensible, como los tokens, a la cual quieras acceder en tus codespaces en forma de variables de ambiente.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### Acerca de los secretos cifrados para los {% data variables.product.prodname_codespaces %} - -Puedes agregar a tu cuenta de usuario los secretos cifrados que quieras utilizar en tus codespaces. Por ejemplo, puede que quieras almacenar y acceder a la siguiente información sensible en forma de un secreto cifrado. - -- Tokens de acceso personal para los servicios en la nube -- Entidades de servicio -- Identificadores de suscripción -- [Credenciales para un registro de imagen privada](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -Puedes elegir qué repositorios deben tener acceso a cada secreto. Posteriormente, puedes utilizar el secreto en cualquier codespace que crees para un repositorio que tenga acceso a él. - -{% data reusables.codespaces.secrets-on-start %} - -#### Nombrar secretos - -{% data reusables.codespaces.secrets-naming %} Por ejemplo, un secreto que se crea a nivel de repositorio debe tener un nombre único en este. - - {% data reusables.codespaces.secret-precedence %} - -#### Límites para los secretos - -Puedes almacenar hasta 100 secretos para los {% data variables.product.prodname_codespaces %}. - -Los secretos tienen un tamaño máximo de 64 KB. - -### Agregar un secreto - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. A la derecha de "Secretos de los codespaces", da clic en **Secreto nuevo**. ![Botón de "Secreto nuevo"](/assets/images/help/settings/codespaces-new-secret-button.png) -1. Debajo de "Nombre", teclea un nombre para tu secreto. ![Caja de texto de "Nombre"](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Haz clic en **Agregar secreto** (Agregar secreto). - -### Editar un secreto - -Puedes actualizar el valor de un secreto existente y puedes cambiar qué repositorios pueden acceder a un secreto. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Debajo de "Secretos de los codespaces"; a la derecha del secreto que quieras editar, da clic en **Actualizar**. ![Botón de "Actualizar"](/assets/images/help/settings/codespaces-secret-update-button.png) -1. Debajo de "Valor", da clic en **Ingresar un valor nuevo**. ![Enlace de "Ingresar un valor nuevo"](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Opcionalmente, para eliminar el acceso del secreto a un repositorio, deselecciona el repositorio. ![Casillas de verificación para eliminar el acceso a los repositorios](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. Haz clic en **Guardar cambios**. - -### Borrar un secreto - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Debajo de "Secretos de los codespaces", a la derecha del secreto que quieras borrar, da clic en **Borrar**. ![Botón de "Borrar"](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. Lee la advertencia y da clic en **OK**. ![Confirmación para borrar un secreto](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index 53853f7633..0000000000 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Administrar la verificación de GPG para los Codespaces -intro: 'Puedes permitir que {% data variables.product.company_short %} utilice automáticamente GPG para firmar las confirmaciones que haces en tus codespaces para que otras personas puedan tener la confianza de que los cambios vienen de una fuente confiable.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Después de que habilitas la verificación de GPG, {% data variables.product.company_short %} firmará automáticamente las confirmaciones que hagas en los {% data variables.product.prodname_codespaces %} y éstas tendrán un estado de verificado en {% data variables.product.product_name %}. Predeterminadamente, la verificación GPG se encuentra inhabilitada para los codespaces que creas. Puedes elegir permitir la verificación de GPG para todos los repositorios o para repositorios específicos. Habilita la verificación GPG únicamente para los repositorios en los cuales confías. Para obtener más información acerca de las confirmaciones firmadas por {% data variables.product.product_name %}, consulta la sección "[Acerca de la verificación de firmas de las confirmaciones](/github/authenticating-to-github/about-commit-signature-verification)". - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Debajo de "verificación GPG", selecciona la configuración que quieras para la verificación de GPG. ![Botones radiales para administrar la verificación GPG](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. Si eliges "Repositorios seleccionados"; selecciona el menú desplegable y luego da clic en el repositorio para el cual quieras habilitar la verificación de GPG. Repite esto para todos los repositorios en los cuales quieras habilitar la verificación GPG. ![Menú desplegable de "Repositorios seleccionados"](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index 6fd4b55253..0000000000 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Revisar las bitácoras de seguridad de los Codespaces -shortTitle: Revisar tus bitácoras de seguridad -intro: 'Puedes utilizar la bitácora de seguridad para revisar todas las acciones relacionadas con los {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de las bitácoras de seguridad para los {% data variables.product.prodname_codespaces %} - -Cuando realizas una acción relacionada con {% data variables.product.prodname_codespaces %} en los repositorios que le pertenecen a tu cuenta de usuario, puedes revisar las acciones en la bitácora de seguridad. Para obtener más información sobre acceder a la bitácora, consulta la sección "[Revisar tu bitácora de seguridad](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)". - -![bitácora de seguridad con información sobre los codespaces](/assets/images/help/settings/codespaces-audit-log.png) - -La bitácora de seguridad incluye detalles de qué acción ocurrió y cuándo la realizaste. Para obtener información sobre las acciones de los {% data variables.product.prodname_codespaces %}, consulta la sección "[acciones de categoría de los {% data variables.product.prodname_codespaces %}](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". diff --git a/translations/es-ES/content/codespaces/quickstart.md b/translations/es-ES/content/codespaces/quickstart.md deleted file mode 100644 index e52bbb80ef..0000000000 --- a/translations/es-ES/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Guía de inicio rápido para los Codespaces de GitHub -intro: 'Prueba los {% data variables.product.prodname_codespaces %} en 5 minutos o menos.' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### Introducción - -En esta guía, crearás un codespace desde el [repositorio de muestra](https://github.com/2percentsilk/haikus-for-codespaces) y explorarás algunas de las características esenciales disponibles para ti dentro del codespace. - -El siguiente ejemplo muestra cómo crear un codespace, conectarlo a un puerto reenviado para ver tu aplicación en ejecución y personalizar tu configuración con extensiones adicionales y dotfiles. - -### Crea tu codespace - -1. Navega a la página principal del [repositorio de muestra](https://github.com/2percentsilk/haikus-for-codespaces). - -2. Debajo del nombre del repositorio, utiliza el menú desplegable {% octicon "download" aria-label="The download icon" %} **Código**, y selecciona **Abrir con codespaces**. - - ![Botón de abrir con codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. Para crear un codespace, haz clic en {% octicon "plus" aria-label="The plus icon" %} **Codespace nuevo**. - - ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) - -### Ejecuta la aplicación - -Con tu proyecto abierto en un codespace, ahora puedes ejecutar la aplicación y lanzarla en un buscador. - -1. Inicia la aplicación ingresando `npm run dev` en la terminal. Este comando ejecuta el script `dev` en el archivo package.json e inicia la aplicación web que se define en el repositorio de muestra. - - ![npm run dev en la temrinal](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. Cuando tu proyecto inicia, debes ver una alerta en la esquina inferior derecha con un mensaje para conectarte al puerto que utiliza tu proyecto. - - ![Notificación de reenvío de puertos](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. Haz clic en **Abrir en el buscador** para ver tu aplicación que se está ejecutando en una pestaña nueva. - -### Personalización con una extensión de tema - -Dentro de un codespace, tienes acceso al Visual Studio Code Marketplace. En este ejemplo, instalarás una extensión que alterará el tema, pero puedes instalar cualquier extensión que sea útil para tu flujo de trabajo. - -1. En la barra lateral, haz clic en el icono de extensiones. - -2. En la barra de búsqueda, ingresa `fairyfloss` e instala la extensión de fairyfloss. - - ![Agregar una extensión](/assets/images/help/codespaces/add-extension.png) - -3. Selecciona el tema `fairyfloss` seleccionándolo de la lista. - - ![Seleccionar el tema de fairyfloss](/assets/images/help/codespaces/fairyfloss.png) - -4. Los cambios que hagas a tu configuración de editor en el codespace actual, tales como el tema y los enlaces de teclado, se sincronizarán automáticamente a otros codespaces a través de la [Sincronización de ajustes](https://code.visualstudio.com/docs/editor/settings-sync). - -### Personalización con dotfiles - -Si tu cuenta de usuario de GitHub es propietaria de un repositorio público denominado dotfiles, GitHub lo utilizará automáticamente para personalizar tu ambiente de codespace durante su creación. - -Este ejemplo te orienta para crear un repositorio de dotfiles para tus codespaces. - -1. Navega al [repositorio de dotfiles](https://github.com/aw-test-93/dotfiles/) de muestra. - -2. Bifurca el repositorio hacia tu cuenta y asegúrate de que sea público. - - Verifica que el repositorio que creaste en tu cuenta se llame dotfiles, por ejemplo `yourname/dotfiles`. Cualquier otro nombre ocasionará que {% data variables.product.prodname_codespaces %} ignore la personalización del repositorio. - -3. El crear un codespace nuevo desde el [repositorio de aplicación de muestra](https://github.com/2percentsilk/haikus-for-codespaces) como actualizaciones de dotfile solo se aplica en el momento de la creación. Los dotfiles de ejemplo cambiarán el símbolo de sistema para que muestre texto en negritas morado y azul. - - ![Personalizar el símbolo de sistema](/assets/images/help/codespaces/custom-prompt.png) - -### Siguientes pasos - -Creaste, personalizaste y ejecutaste exitosamente tu primer aplicación dentro de un codespace, pero ¡hay mucho más que explorar! Aquí tienes algunos recursos útiles para que tomes tus siguientes pasos con {% data variables.product.prodname_codespaces %}. - - "[Guías de inicio](/codespaces/getting-started-with-codespaces)" Para utilizar {% data variables.product.prodname_codespaces %} con lenguajes específicos - - [Crear una configuración personalizada](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project) para configurar {% data variables.product.prodname_codespaces %} para tu proyecto. diff --git a/translations/es-ES/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/es-ES/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index cc82c1843f..0000000000 --- a/translations/es-ES/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: Configurar Codespaces para tu proyecto -intro: 'Puedes utilizar un archivo de `devcontainer.json` para definir un ambiente de {% data variables.product.prodname_codespaces %} para tu repositorio.' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de los contenedores dev - -Un contenedor de desarrollo o contenedor dev es el ambiente que utilizan los {% data variables.product.prodname_codespaces %} para proporcionar las herramientas y tiempos de ejecución que necesita tu proyecto para su desarrollo. Cuando trabajas con un contenedor de dev en los {% data variables.product.prodname_codespaces %}, puedes ya sea [utilizar la configuración predeterminada](#using-the-default-configuration), [utilizar una configuración predeterminada](#using-a-pre-defined-container-configuration) o [crear tu propia configuración](#creating-a-custom-codespace-configuration). La opción que elijas dependerá de las herramientas, tiempos de ejecución, dependencias y flujos de trabajo que el usuario pudiese necesitar para tener éxito en tu proyecto. - -{% data variables.product.prodname_codespaces %} permite la personalización por proyecto y por rama con un archivo `devcontainer.json`. Este archivo de configuración determina el ambiente de cada codespace nuevo que cualquier persona cree en tu repositorio definiendo un contenedor de desarrollo que puede incluir marcos de trabajo, herramientas, extensiones y reenvío de puertos. También puede utilizarse un Dockerfile junto con el archivo `devcontainer.json` en la carpeta `.devcontainer` para definir todo lo que se necesita para crear una imagen de contenedor. - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -Puedes utilizar tu `devcontainer.json` para configurar los ajustes predeterminados para todo el ambiente de codespaces, incluyendo el editor, pero también puedes configurar ajustes específicos del editor para [espacios de trabajo](https://code.visualstudio.com/docs/editor/workspaces) individuales de un codespace en un archivo llamado `.vscode/settings.json`. - -Para obtener más información sobre la configuración y propiedades que puedes configurar en un `devcontainer.json`, consulta la [referencia a devcontainer.json](https://aka.ms/vscode-remote/devcontainer.json) en la documentación de {% data variables.product.prodname_vscode %}. - -#### Dockerfile - -Un Dockerfile también vive en la carpeta `.devcontainer`. - -Puedes agregar un Dockerfile a tu proyecto para definir una imagen de contenedor e instalar software. En el Dockerfile, puedes utilizar `FROM` para especificar la imagen de contenedor. - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -Puedes utilizar la instrucción e `RUN` para instalar cualquier software y `&&` para unir comandos. - -Referencia tu Dockerfile en tu archivo de `devcontainer.json` utilizando la propiedad `dockerfile`. - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -Para obtener más información sobre cómo utilizar un Dockerfile en un contenedor de dev, consulta la sección [Crear un contenedor de desarrollo](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) en la documentación de {% data variables.product.prodname_vscode %}. - -### Utilizar la configuración predeterminada - -Si no defines una configuración en tu repositorio, {% data variables.product.prodname_dotcom %} creará un codespace con una imagen base de Linux. La imagen base de Linux incluye lenguajes y tiempos de ejecución como Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, y Rust. También incluye otras herramientas y utilidades de desarrollador como git, el CLI de GitHub, yarn, openssh y vim. Para ver todos los lenguajes, tiempos de ejecución y herramientas que se incluyen, utiliza el comando `devcontainer-info content-url` dentro de tu terminal del codespace y sigue la url que este produce. - -Como alternativa, para obtener más información sobre todo lo que incluye la imagen básica de Linux, consulta el archivo más reciente del repositorio [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers). - -La configuración predeterminada es una buena opción si estás trabajando en un proyecto pequeño que utilice los lenguajes y herramientas que proporciona {% data variables.product.prodname_codespaces %}. - - -### Utilizar una configuración de contenedor predefinida - -Las definiciones predefinidas de contenedores incluyen una configuración común para u tipo de proyecto en particular y pueden ayudarte a iniciar rápidamente con una configuración que ya tenga las opciones adecuadas del contenedor, los ajustes de {% data variables.product.prodname_vscode %} y las extensiones de {% data variables.product.prodname_vscode %} que deben estar instaladas. - -Utilizar una configuración predefinida es una gran idea si necesitas extensibilidad adicional. También puedes iniciar con una configuración predefinida y modificarla conforme lo requieras de acuerdo con los ajustes de tu proyecto. - -1. Para acceder a la paleta de comandos, en la esquina superior izquierda, selecciona el menú de aplicaciones y haz clic en **Paleta de comandos...** desde el menú de **Ver** y luego comienza a teclear "Codespaces: Add Development Container Configuration Files...". Haz clic en **Codespaces: Agregar archivos de configuración de contenedores de desarrollo...** !["Codespaces: Agregar archivos de configuración de contenedores de desarrollo..." en la paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. Haz clic en la definición que quieras utilizar. ![Lista de definiciones de contenedores predefinidas](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. Sigue los mensajes para personalizar tu definición. -1. Haz clic en **OK** (aceptar). ![Botón de OK](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. Para aplicar los cambios, en la esquina inferior derecha de la pantalla, haz clic en **Reconstruir ahora**. Para obtener más información sbre reconstruir tu contenedor, consulta la sección "[Acplicar los cambios a tu configuración](#applying-changes-to-your-configuration)". !["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/rebuild-prompt.png) - - -### Crear una configuración personalizada para un codespace - -Si ninguna de las configuraciones predefinidas satisface tus necesidades, puedes crear una configuración personalizada si agregas un archivo `devcontainer.json`. {% data reusables.codespaces.devcontainer-location %} - -En el archivo, puedes utilizar las [llaves de configuración compatibles](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) para especificar los aspectos del ambiente del codespace, como cuáles extensiones de {% data variables.product.prodname_vscode %} se instalarán. - -{% data reusables.codespaces.vscode-settings-order %} - -Puedes definir la configuración predeterminada del editor para {% data variables.product.prodname_vscode %} en dos lugares. - -* La configuración del editor que se definió en `.vscode/settings.json` se aplica como una configuración con alcance de _Workspace_- en este codespace. -* La configuración del editor que se definió en la clave `settings` en `devcontainer.json` se aplica como una configuración con alcance de _Remote [Codespaces]_ en este codespace. - -Después de actualizar el archivo `devcontainer.json`, puedes reconstruir el contenedor para que tu codespace aplique los cambios. Para obtener más información, consulta la sección "[Aplicar cambios a tu configuración](#applying-changes-to-your-configuration)". - - - - -### Aplicar cambios a tu configuración - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %}!["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} Arreglar los errores en la configuración. ![Mensaje de error sobre el modo de recuperación](/assets/images/help/codespaces/recovery-mode-error-message.png) - - Para diagnosticar el error revisando la bitácora de creación, haz clic en **Ver bitácora de creación**. - - Para arreglar los errores que se identificaron en las bitácoras, actualiza tu archivo `devcontainer.json`. - - Para aplicar los cambios, vuelve a crear tu contenedor. {% data reusables.codespaces.rebuild-command %} diff --git a/translations/es-ES/content/codespaces/setting-up-your-codespace/index.md b/translations/es-ES/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index b78007e4ab..0000000000 --- a/translations/es-ES/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Configurar tu codespace -intro: '{% data variables.product.prodname_codespaces %} es un ambiente dedicado para ti. Puedes configurar tu codespace con un contenedor dev para instalar tus dependencias o puedes agregar un dotfile para personalizar la los ajustes de usuario.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/es-ES/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/es-ES/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index 0572327747..0000000000 --- a/translations/es-ES/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Personalizar Codespaces para tu cuenta -intro: 'Puedes personalizar {% data variables.product.prodname_codespaces %} utilizando un repositorio de `dotfiles` en {% data variables.product.product_name %} o utilizando la sincronización de ajustes.' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### Acerca de personalizar los {% data variables.product.prodname_codespaces %} - -Cuando utilizas cualquier ambiente de desarrollo, personalizar las configuraciones y herramientas de acuerdo con tus preferencias y flujos de trabajo es un paso importante. {% data variables.product.prodname_codespaces %} permite dos formas principales de personalizar tus codespaces. - -- [Sincronización de ajustes](#settings-sync) - Puedes utilizar y compartir los ajustes de {% data variables.product.prodname_vscode %} entre {% data variables.product.prodname_codespaces %} y otras instancias de {% data variables.product.prodname_vscode %}. -- [Dotfiles](#dotfiles) – Puedes utilizar un repositorio público de `dotfiles` para especificar scripts, preferencias de shell y otras configuraciones. - -La personalización de {% data variables.product.prodname_codespaces %} aplica a cualquier codespace que crees. - -Los mantenendores de proyecto también pueden definir una configuración predeterminada que aplique a cada codespace para un repositorio que cree alguien más. Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)". - -### Sincronización de ajustes - -La configuración de ajustes te permite compartir configuraciones tales como configuraciones, atajos de teclado, fragmentos de código, extensiones y estados de IU entre máquinas e instancias de {% data variables.product.prodname_vscode %}. - -La sincronización de ajustes está activada predeterminadamente. Para configurar cualquier ajuste, en la esquina inferior izquierda de la barra de actividad, selecciona el {% octicon "gear" aria-label="The gear icon" %} y haz clic en **La sincronización de ajustes está activa**. Desde el diálogo, puedes elegir configurar, mostrar los ajustes y datos o apagar la sincronización de ajustes. - -![La opción de sincronización de ajustes en el menú de administración](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -Para obtener más información, consulta la [Guía de sincronización de ajustes](https://code.visualstudio.com/docs/editor/settings-sync) en la documentación de {% data variables.product.prodname_vscode %}. - -### Dotfiles - -Los Dotfiles son archivos y carpetas de sistemas parecidos a Unix que comienzan con `.` y que controlan la configuración de aplicaciones y shells de tu sistema. Puedes alamacenar y administrar tus dotfiles en un repositorio en {% data variables.product.prodname_dotcom %}. Para encontrar consejos y tutoriales sobre qué incluir en tu repositorio de `dotfiles`, consulta la sección [GitHub maneja dotfiles](https://dotfiles.github.io/). - -Si tu cuenta de usuario en {% data variables.product.prodname_dotcom %} es propietaria de un repositorio público llamado `dotfiles`, {% data variables.product.prodname_dotcom %} utilizará este repositorio automáticamente para personalizar el ambiente de tu codespace. Actualmente, no son compatibles los repositorios `dotfiles` privados. - -Tu repositorio `dotfiles` puede incluir los alias de tu shell y tus preferencias, cualquier herramienta que quieras instalar, o cualquier otra personalización del codespace que quieras hacer. - -Cuando creas un codespace nuevo, {% data variables.product.prodname_dotcom %} clona tu repositorio `dotfiles` hacia el ambiente del codespace, y busca uno de los siguientes archivos para configurar el ambiente. - -* _install.sh_ -* _install_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -Si no encuentra alguno de estos archivos, entonces cualquier archivo o carpeta en `dotfiles` que comience con `.` se enlazará simbólicamente al directorio `~` o `$HOME` del codespace. - -Cualquier cambio a tu repositorio `dotfiles` se aplicará únicamente a cada codespace nuevo, y no afectará a ningún codespace existente. - -{% note %} - -**Nota:** Actualmente, {% data variables.product.prodname_codespaces %} no es compatible con la personalización de la configuración de _Usuario_ para el editor de {% data variables.product.prodname_vscode %} con tu repositorio de `dotfiles`. Puedes configurar ajustes predeterminados de _Workspace_ y _Remote [Codespaces]_ para un proyecto específico en el repositorio de éste. Para obtener más información, consulta la sección "[Configurar {% data variables.product.prodname_codespaces %} para tu proyecto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)". - -{% endnote %} - -También puedes configurar los ajustes para que tu cuenta de usuario agregue secretos cifrados, habilite la verificación de GPG y permita a tus codespaces acceder a otros repositorios. Para obtener más información, consulta las secciones "[Administrar los secretos cifrados para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Administrar la verificación de GPG para los {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", y "[Ad,omostrar el acceso y la seguridad para los {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)". - -### Leer más - -* "[Crear un repositorio nuevo](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)". diff --git a/translations/es-ES/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/es-ES/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index 6df432813b..0000000000 --- a/translations/es-ES/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %} es de uso gratuito durante el beta. Cuando {% data variables.product.prodname_codespaces %} se hace generalmente disponible, se te cobrará por el almacenamiento y uso del procesamiento. diff --git a/translations/es-ES/data/reusables/codespaces/about-configuration.md b/translations/es-ES/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 3ceca47b26..0000000000 --- a/translations/es-ES/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -Puedes crear una configuración predeterminada de codespaces para tu repositorio, la cual determine el ambiente de cada codespace nuevo que alguien cree para este repositorio. La configuración define un contenedor de desarrollo que puede incluir marcos de trabajo, herramientas, extensiones y redireccionamiento de puertos. diff --git a/translations/es-ES/data/reusables/codespaces/about-personalization.md b/translations/es-ES/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index ac99999c8c..0000000000 --- a/translations/es-ES/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -También puedes utilizar un repositorio de [dotfiles](https://dotfiles.github.io/tutorials/) y [Sincronizar la configuración](https://code.visualstudio.com/docs/editor/settings-sync) para personalizar los aspectos del ambiente de codespaces para cualquier codespace que crees. La personalización puede incluir preferencias de shell y herramientas adicionales. diff --git a/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md b/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index b010026461..0000000000 --- a/translations/es-ES/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -Puedes reenviar los puertos en tu codespace para probar y depurar tu aplicación. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/es-ES/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index 8ea4f5ec25..0000000000 --- a/translations/es-ES/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -Después de que cambia la configuración de los {% data variables.product.prodname_codespaces %} para un repositorio, puedes aplicar los cambios a un codespace existente si vuelves a compilar el contenedor para el codespace. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/beta-functionality-limited.md b/translations/es-ES/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 2181e82fea..0000000000 --- a/translations/es-ES/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -Durante el beta, la funcionalidad será limitada. -- {% data reusables.codespaces.use-chrome %} -- Úicamente estará disponible un tamaño único de codespace. -- Únicamente serán compatibles los contenedores Linux. -- Un codespace no se puede reanudar completamente. Los procesos que estuvieran ejecutándose al momento en el que se paró un codespace no se reiniciarán. diff --git a/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index f4f8c50435..0000000000 --- a/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. En {% data variables.product.prodname_vscode %}, en la barra lateral izquierda, da clic en el icono de Explorador Remoto. ![El icono de explorador remoto en {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/codespace-config-order.md b/translations/es-ES/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index bed5b60232..0000000000 --- a/translations/es-ES/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -Tu personalización de `dotfiles` se aplica antes de una configuración predeterminada de codespaces de un repositorio. diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/es-ES/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index 0133ab3010..0000000000 --- a/translations/es-ES/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -Cada codespace se asocia con una rama específica de un repositorio. diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-are-personal.md b/translations/es-ES/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index f26636327f..0000000000 --- a/translations/es-ES/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -Cada codespace que crees está únicamente disponible para ti. Nadie más puede trabajar en tu codespace. diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-machine-types.md b/translations/es-ES/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index a131bcd48a..0000000000 --- a/translations/es-ES/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -Puedes ejecutar tu codespace en una selección de tres tipos de máquina remota: Básica, Estándar o Premium. Cada una de estas tiene un nivel de recursos y de facturación diferentes.{% note %} - -**Nota:**{% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -El cambiar entre tipos de máquina te proporciona la flexibilidad para elegir los recursos más adecuados para tu trabajo. Algunas tareas podrían requerir tipos de máquina diferentes: - -* **Básico** para actualizar un archivo y levantar una solicitud de cambios -* **Estándar** para editar un sitio web -* **Premium** para tareas de cálculos altos tales como análilsis de datos diff --git a/translations/es-ES/data/reusables/codespaces/committing-link-to-procedure.md b/translations/es-ES/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 5212de0bf3..0000000000 --- a/translations/es-ES/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -Una vez que hayas hecho cambios a tu codespace, ya sea de código nuevo o de cambios de configuración, necesitarás confirmar tus cambios. El confirmar los cambios en tu repositorio garantiza que cualquiera que cree un codespace desde este repositorio tendrá la misma configuración. Esto también significa que cualquier personalización que hagas, tal como agregar extensiones de {% data variables.product.prodname_vscode %}, aparecerá para todos los usuarios. - -Para obtener más información, consulta la sección "[Utilizar el control de código fuente en tu codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)" \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/es-ES/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index d74e19de2e..0000000000 --- a/translations/es-ES/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -Puedes crear más de un codespace por repositorio o incluso por rama. Sin embargo, cada cuenta de usuario tiene un límite de dos codespaces durante el beta público limitado. Si has alcanzado el límite y quieres crear un codespace nuevo, primero debes borrar un codespace. diff --git a/translations/es-ES/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/es-ES/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index 363dffdd70..0000000000 --- a/translations/es-ES/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -Puedes conectarte a tu codespace directamente desde {% data variables.product.prodname_vscode %}. Para obtener más información, consulta la sección "[Utilizar codespaces en {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)". diff --git a/translations/es-ES/data/reusables/codespaces/devcontainer-location.md b/translations/es-ES/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index 4108e47069..0000000000 --- a/translations/es-ES/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -Este archivo puede ubicarse en la raíz del repositorio o en una carpeta que se llame `.devcontainer`. Si el archivo se ubica en la raíz del repositorio, el nombre del archivo debe comenzar con un punto: `.devcontainer.json`. diff --git a/translations/es-ES/data/reusables/codespaces/navigate-to-codespaces.md b/translations/es-ES/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index 639c7df307..0000000000 --- a/translations/es-ES/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. En la parte superior de cualquier página, da clic en **Codespaces**. ![Enlace de {% data variables.product.prodname_codespaces %} en el encabezado](/assets/images/help/codespaces/header-link.png) diff --git a/translations/es-ES/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/es-ES/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index 4203c5929f..0000000000 --- a/translations/es-ES/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. En tu codespace, debajo del editor de texto, haz clic en "Puertos". ![Pestaña de puertos](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/es-ES/data/reusables/codespaces/rebuild-command.md b/translations/es-ES/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index 4c2882e4f1..0000000000 --- a/translations/es-ES/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -Accede a la paleta de comandos (`shift command P` / `shift control P`) y luego comienza a teclare "Codespaces: Rebuild Container". Haz clic en **Codespaces: Rebuild Container**. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/recovery-mode.md b/translations/es-ES/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index 0059dc812e..0000000000 --- a/translations/es-ES/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -Si los cambios a la configuración de tu codespace causan un error de contenedor, este se ejecutará en modo de recuperación y verás un mensaje de error. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/release-stage.md b/translations/es-ES/data/reusables/codespaces/release-stage.md deleted file mode 100644 index f03425ab0c..0000000000 --- a/translations/es-ES/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Nota:**{% data variables.product.prodname_codespaces %} actualmente está en un beta público limitado y está sujeto a cambios. Par obtener más información acerca de unirse al beta, consulta "[Acerca de {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)". - -{% endnote %} diff --git a/translations/es-ES/data/reusables/codespaces/secret-precedence.md b/translations/es-ES/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index 45cdc14d0e..0000000000 --- a/translations/es-ES/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -Si un secreto con el mismo nombre existe en varios niveles, aquél en el nivel más bajo tomará presedencia. Por ejemplo, si un secreto a nivel de organización tiene el mismo nombre que un secreto a nivel de repositorio, entonces el secreto a nivel de repositorio tomará precedencia. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/secrets-naming.md b/translations/es-ES/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index 22f2c730a6..0000000000 --- a/translations/es-ES/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -Las siguientes reglas aplican a los nombres secretos: - -* Los nombres secretos solo contienen caracteres alfanuméricos (`[a-z]`, `[A-Z]`, `[0-9]`) o guiones bajos (`_`). No se permiten espacios. -* Los nombres secretos no deben comenzar con el prefijo `GITHUB_`. -* Los nombres secretos no deben comenzar con un número. -* Los nombres de secreto no distinguen entre mayúsculas y minúsculas. -* Los nombres secretos deben ser únicos en el nivel en el que se hayan creado. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/secrets-on-start.md b/translations/es-ES/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index d30cf9e54f..0000000000 --- a/translations/es-ES/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -Una vez que hayas creado un secreto, estará disponible cuando creas un codespace nuevo o cuando reinicias el codespace. Para utilizar un secreto que acabas de crear en un codespace actual, necesitarás suspenderlo y reanudarlo. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/source-control-display-dark.md b/translations/es-ES/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index f8f8cf287e..0000000000 --- a/translations/es-ES/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. En la barra de actividad, haz clic en la vista de **Control de código fuente**. ![Vista de control de código fuente](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/source-control-display.md b/translations/es-ES/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index fe78e1c886..0000000000 --- a/translations/es-ES/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. En la barra de actividad, haz clic en la vista de **Control de código fuente**. - - ![Vista de control de código fuente](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/type-port-label.md b/translations/es-ES/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index ec2eb93c12..0000000000 --- a/translations/es-ES/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. Teclea una etiqueta para tu puerto y luego presiona enter. ![Caja de texto para teclear la etiqueta para el puerto](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/unsupported-repos.md b/translations/es-ES/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index e39868b20f..0000000000 --- a/translations/es-ES/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -Durante el beta, no serán compatibles los repositorios privados que pertenezcan a las organizaciones o cualquier repositorio perteneciente a una organización que requiera el inicio de sesión único de SAML. diff --git a/translations/es-ES/data/reusables/codespaces/use-chrome.md b/translations/es-ES/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index cb55835480..0000000000 --- a/translations/es-ES/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -Para una mejor experiencia con {% data variables.product.prodname_codespaces %}, te recomenamos utilizar un buscador basado en Chromium, como Google Chrome o Microsoft Edge. diff --git a/translations/es-ES/data/reusables/codespaces/use-visual-studio-features.md b/translations/es-ES/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index 17af192cf7..0000000000 --- a/translations/es-ES/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -Puedes editar código, depurar y utilizar comandos de git mientras que desarrollas en un codespace con {% data variables.product.prodname_vscode %}. Para obtener más información, consulta la sección [documentación de {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs). diff --git a/translations/es-ES/data/reusables/codespaces/vscode-settings-order.md b/translations/es-ES/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index 1519e4c06f..0000000000 --- a/translations/es-ES/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -Cuando configuras los ajustes de editor para {% data variables.product.prodname_vscode %}, hay tres alcances disponibles: _Espacio de trabajo_, _[Codespaces] Remotos _, y _Usuario_. Si una configuración se define en varios alcances, los ajustes de _espacio de trabajo_ tomarán prioridad, luego los de _[Codespaces] Remotos_, y luego los de _Usuario_. diff --git a/translations/es-ES/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/es-ES/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index 9b9097d84a..0000000000 --- a/translations/es-ES/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Puedes ver cualquier codespace disponible que hayas creado en [github.com/codespaces](https://github.com/codespaces). diff --git a/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index 9b01d062d6..0000000000 --- a/translations/es-ES/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. En la esquina superior derecha de {% data variables.product.product_name %}, haz clic en tu foto de perfil y luego haz clic en **Tus codespaces**. - - ![Opción de menú 'Tus codespaces'](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/gated-features/codespaces.md b/translations/es-ES/data/reusables/gated-features/codespaces.md deleted file mode 100644 index 4a8a8cf28b..0000000000 --- a/translations/es-ES/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Codespaces está disponible para las cuentas de usuario que utilicen {% data variables.product.prodname_free_user %} o {% data variables.product.prodname_pro %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/es-ES/data/reusables/organizations/click-codespaces.md b/translations/es-ES/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index 3e41713050..0000000000 --- a/translations/es-ES/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. En la barra lateral izquierda, da clic en **Codespaces**. ![Pestaña de "Codespaces" en la barra lateral izquierda](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/es-ES/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/es-ES/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index 250d772614..0000000000 --- a/translations/es-ES/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. Selecciona el menú desplegable de "Acceso al repositorio" y luego da clic en aquél a cuyo secreto quieras acceder. Repite esto para cada repositorio del cual quieras tener acceso al secreto. ![Menú desplegable de "Acceso al repositorio"](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/user_settings/codespaces-secret-value.md b/translations/es-ES/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index 246e6ab228..0000000000 --- a/translations/es-ES/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. Debajo de "Valor", teclea el valor de tu secreto. ![Caja de texto de "Valor"](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/user_settings/codespaces-tab.md b/translations/es-ES/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index 69002607f8..0000000000 --- a/translations/es-ES/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. En la barra lateral izquierda, da clic en **Codespaces**. ![Pestaña de Codespaces en la barra lateral de la configuración de usuario](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/about-configuration.md b/translations/es-XL/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 3ceca47b26..0000000000 --- a/translations/es-XL/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -Puedes crear una configuración predeterminada de codespaces para tu repositorio, la cual determine el ambiente de cada codespace nuevo que alguien cree para este repositorio. La configuración define un contenedor de desarrollo que puede incluir marcos de trabajo, herramientas, extensiones y redireccionamiento de puertos. diff --git a/translations/es-XL/data/reusables/codespaces/about-personalization.md b/translations/es-XL/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index af73ae7810..0000000000 --- a/translations/es-XL/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -También puedes personalizar los aspectos del ambiente de un codespace para cad acodespace que tu cuenta cree. La personalización puede incluir preferencias de shell y herramientas adicionales. diff --git a/translations/es-XL/data/reusables/codespaces/beta-functionality-limited.md b/translations/es-XL/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 2181e82fea..0000000000 --- a/translations/es-XL/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -Durante el beta, la funcionalidad será limitada. -- {% data reusables.codespaces.use-chrome %} -- Úicamente estará disponible un tamaño único de codespace. -- Únicamente serán compatibles los contenedores Linux. -- Un codespace no se puede reanudar completamente. Los procesos que estuvieran ejecutándose al momento en el que se paró un codespace no se reiniciarán. diff --git a/translations/es-XL/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/es-XL/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index f4f8c50435..0000000000 --- a/translations/es-XL/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. En {% data variables.product.prodname_vscode %}, en la barra lateral izquierda, da clic en el icono de Explorador Remoto. ![El icono de explorador remoto en {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/codespace-config-order.md b/translations/es-XL/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index bed5b60232..0000000000 --- a/translations/es-XL/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -Tu personalización de `dotfiles` se aplica antes de una configuración predeterminada de codespaces de un repositorio. diff --git a/translations/es-XL/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/es-XL/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index d77b4cdcd1..0000000000 --- a/translations/es-XL/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -Cada codespace se asocia con una rama específica de un repositorio. \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/codespaces-are-personal.md b/translations/es-XL/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index 6e45142a3c..0000000000 --- a/translations/es-XL/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -Cada codespace que crees está únicamente disponible para ti. Nadie más puede trabajar en tu codespace. \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/es-XL/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index d74e19de2e..0000000000 --- a/translations/es-XL/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -Puedes crear más de un codespace por repositorio o incluso por rama. Sin embargo, cada cuenta de usuario tiene un límite de dos codespaces durante el beta público limitado. Si has alcanzado el límite y quieres crear un codespace nuevo, primero debes borrar un codespace. diff --git a/translations/es-XL/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/es-XL/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index c81fa5c6bf..0000000000 --- a/translations/es-XL/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -Puedes conectarte a tu codespace directamente desde {% data variables.product.prodname_vscode %}. Para obtener más información, consulta la sección "[Conectarte a tu codespace desde {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code)". \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/navigate-to-codespaces.md b/translations/es-XL/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index 32549a2737..0000000000 --- a/translations/es-XL/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. En la parte superior de cualquier página, da clic en **Codespaces**. ![Enlace de {% data variables.product.prodname_codespaces %} en el encabezado](/assets/images/help/codespaces/header-link.png) \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/release-stage.md b/translations/es-XL/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 3e5bd7ee69..0000000000 --- a/translations/es-XL/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Nota:**{% data variables.product.prodname_codespaces %} actualmente está en un beta público limitado y está sujeto a cambios. Durante el periodo beta, {% data variables.product.prodname_dotcom %} no garantiza la disponibilidad de {% data variables.product.prodname_codespaces %}. Par obtener más información acerca de unirse al beta, consulta "[Acerca de {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)". - -{% endnote %} \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/unsupported-repos.md b/translations/es-XL/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index 771da183c1..0000000000 --- a/translations/es-XL/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -Durante el beta, no serán compatibles los repositorios privados que pertenezcan a las organizaciones o cualquier repositorio perteneciente a una organización que requiera el inicio de sesión único de SAML. \ No newline at end of file diff --git a/translations/es-XL/data/reusables/codespaces/use-chrome.md b/translations/es-XL/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index cb55835480..0000000000 --- a/translations/es-XL/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -Para una mejor experiencia con {% data variables.product.prodname_codespaces %}, te recomenamos utilizar un buscador basado en Chromium, como Google Chrome o Microsoft Edge. diff --git a/translations/es-XL/data/reusables/codespaces/use-visual-studio-features.md b/translations/es-XL/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index 87d2140753..0000000000 --- a/translations/es-XL/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -Después de que abras un codespace, puedes desarrollar utilizando las características de {% data variables.product.prodname_vscode %} tales como edición de texto, depuración, y comandos de Git. Para obtener más información, consulta la sección [documentación de {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs). diff --git a/translations/es-XL/data/reusables/codespaces/vscode-settings-order.md b/translations/es-XL/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index 1519e4c06f..0000000000 --- a/translations/es-XL/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -Cuando configuras los ajustes de editor para {% data variables.product.prodname_vscode %}, hay tres alcances disponibles: _Espacio de trabajo_, _[Codespaces] Remotos _, y _Usuario_. Si una configuración se define en varios alcances, los ajustes de _espacio de trabajo_ tomarán prioridad, luego los de _[Codespaces] Remotos_, y luego los de _Usuario_. diff --git a/translations/es-XL/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/es-XL/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index 6dfb46c028..0000000000 --- a/translations/es-XL/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Puedes ver cada codespace que pertenezca a tu cuenta de usuario en [github.com/codespaces](https://github.com/codespaces). \ No newline at end of file diff --git a/translations/es-XL/data/reusables/gated-features/codespaces.md b/translations/es-XL/data/reusables/gated-features/codespaces.md deleted file mode 100644 index 4a8a8cf28b..0000000000 --- a/translations/es-XL/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Codespaces está disponible para las cuentas de usuario que utilicen {% data variables.product.prodname_free_user %} o {% data variables.product.prodname_pro %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/ja-JP/content/codespaces/about-codespaces.md b/translations/ja-JP/content/codespaces/about-codespaces.md deleted file mode 100644 index 6aa9285b62..0000000000 --- a/translations/ja-JP/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: codespace について -intro: '{% data variables.product.prodname_codespaces %} is a configurable online development environment, hosted by {% data variables.product.prodname_dotcom %} and powered by {% data variables.product.prodname_vscode %}, that allows you to develop entirely in the cloud.' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### {% data variables.product.prodname_codespaces %} について - -{% data variables.product.prodname_codespaces %} is a configurable cloud development environment available in your browser on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -![codespace(オープン)](/assets/images/help/codespaces/codespace-overview.png) - -A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings. - -Codespaces offers many benefits to teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development. - -### A consistent environment - -You can create a single codespace configuration that defines the environment (or _dev container_) of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. A standardized environment is already available for them as soon as they create a codespace from the repository. 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)」を参照してください。 - -For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials. - -While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -### Fast and personal onboarding - -With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**. - -![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -As a result of standardizing on a repeatable developer environment, developers can get started with a new codespace without doing any manual configuration and do not need to do continued maintenance of their developer environment. A new codespace can be created when starting a new feature. - -Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - -Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs. - -### A secure environment - -{% data variables.product.prodname_codespaces %} allows developers to develop in the cloud instead of locally. This creates one single, trackable, source of truth. 開発者は、タブレットや Chromebook など、あらゆるマシンでどこからでも貢献でき、知的財産のローカルコピーを保持する必要はありません。 Developers always have to be logged in and provided with access to both {% data variables.product.prodname_codespaces %} and specific repositories. These permissions can be revoked at any time. As soon as you revoke access, those developers will lose all access to protected resources. In addition, authenticated developers create audit trails so you know who is doing what. For more information on access and security, see "[Managing access and security for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -Using {% data variables.product.prodname_codespaces %} is the most secure when all members of your team are using it. It means that there is no need to clone the repository onto a local machine and that developers don't need to install locally as `root`. - -Developers and organization administrators can also configure settings to add encrypted secrets and enable GPG verification. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)". - -### {% data variables.product.prodname_codespaces %}の支払いについて - -{% data reusables.codespaces.about-billing-for-codespaces %} 詳細は「[{% data variables.product.prodname_codespaces %} の支払いについて](/github/developing-online-with-codespaces/about-billing-for-codespaces)」を参照してください。 - -### ベータに参加する - -限られたユーザのみがベータ参加のために招待されます。 To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup). - -### {% data variables.product.prodname_codespaces %} について問い合わせる - -{% data variables.product.prodname_codespaces %} の使用時に問題が発生した場合は、「[codespace のトラブルシューティング](/github/developing-online-with-codespaces/troubleshooting-your-codespace)」を参照してください。 - -さらにサポートをご希望の場合、または {% data variables.product.prodname_codespaces %} に関するフィードバックがある場合は、[Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) ディスカッションをご利用ください。 diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/ja-JP/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index db47ed9a9c..0000000000 --- a/translations/ja-JP/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Codespaces の支払いについて -intro: '{% data variables.product.prodname_codespaces %} が一般提供されると、ストレージとコンピューティングの使用量に対して課金されます。' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -Updates on the billing model for Codespaces will be shared in an upcoming announcement. diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index 75be9e6f73..0000000000 --- a/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Allowing your codespace to access a private image registry -intro: 'You can use secrets to allow {% data variables.product.prodname_codespaces %} to access a private image registry' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. You can create secrets in GitHub to store the access details for a private registry and use them to give your codespace access to images stored in the registry. - -When you launch a codespace, {% data variables.product.prodname_codespaces %} checks for three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -You can store secrets at the user, repository, or organization-level, allowing you to share them securely between different codespaces. When you create a set of secrets for a private image registry, you need to replace the “<*>” in the name with a consistent identifier. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" and "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)." - -For example, if you had a private image registry in Azure, you could create the following secrets: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/index.md b/translations/ja-JP/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index c03d45ed2f..0000000000 --- a/translations/ja-JP/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: リファレンス -intro: 'This section contains references that will allow you to be successful with {% data variables.product.prodname_codespaces %}' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry - - /using-the-command-palette-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/ja-JP/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index d3c63a0817..0000000000 --- a/translations/ja-JP/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: codespace のトラブルシューティング -intro: Use this guide to help you troubleshoot common issues with your codespace. -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Known Limitations - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### {% data variables.product.prodname_vscode %} troubleshooting - -Use **Issues** in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository to check for known issues or to log issues about the {% data variables.product.prodname_vscode %} experience. - - -### Configuration troubleshooting - -{% data reusables.codespaces.recovery-mode %} - -``` -This codespace is currently running in recovery mode due to a container error. -``` - -Review the creation logs, update the configuration as needed, and run **Codespaces: Rebuild Container** in the command palette to retry. 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)」を参照してください。 - -### dotfiles troubleshooting - -- Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. -- Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - - If your dotfiles were cloned, try manually re-running your install script to verify it's executable. - - If your dotfiles weren't cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. -- Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. Alternatively, you can view the `creation.log` by navigating to the command palette and entering **Codespaces: View Creation Log**. - - -### Browser troubleshooting - -Chromium ベースではないブラウザを使用しているときに問題が発生した場合は、Chromium ベースのブラウザに切り替えるか、または、[`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) や [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari) などのブラウザのラベルが付いた問題を検索して、`microsoft/vscode` リポジトリでブラウザの既知の問題を確認します。 - -Chromium ベースのブラウザの使用中に問題が発生した場合は、[`microsoft/vscode`](https://github.com/microsoft/vscode/issues) リポジトリの {% data variables.product.prodname_vscode %} で別の既知の問題が発生しているかどうかを確認できます。 - -### Container storage troubleshooting - -When you create a codespace, it has a finite amount of storage and over time it may be necessary for you to free up space. Try any of the following items to free up storage space. - -- Remove packages that are no longer by using `sudo apt autoremove` -- Clean the apt cache by using `sudo apt clean` -- Delete unneeded files like build artifacts and logs (these are very project-dependent) -- See the top 10 largest files in the codespace: `sudo find / -printf '%s %p\n'| sort -nr | head -10` - -More destructive options: -- Remove unused Docker images, networks, and containers by using `docker system prune` (append `-a` if you want to remove all images, and `--volumes` if you want to remove all volumes) -- Remove untracked files from working tree: `git clean -i` - -### 弊社にお問い合わせください - -さらなるサポートが必要な場合は、お問い合わせください。 詳しい情報については、「[{% data variables.product.prodname_codespaces %} について](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)」を参照してください。 diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index 6b755d6c3a..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: codespace を作成する -intro: リポジトリのブランチの codespace を作成して、オンラインで開発できます。 -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### codespace の作成について - -You can create a codespace on either {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %} - -Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)." - - -When you create a codespace, a number of steps happen to enable full access to your development environment. - -- Resources such as a VM and storage for your container are assigned. A new VM is created every time you create or start a codespace to ensure that you always have the latest versions and security patches. -- {% data variables.product.prodname_codespaces %} recieves information about your repository, branch, commits, your public dotfiles repository, and any secrets that you have created. -- {% data variables.product.prodname_codespaces %} executes a shallow clone of the repository. -- If you have one in your repository, {% data variables.product.prodname_codespaces %} runs the `devcontainer.json` file. 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)」を参照してください。 -- Your Docker container, `docker-compose`, or other initialization is run. -- At this point, the codespace is marked as available and you can connect. -- Once the codespace is made available, depending on the commands in the devcontainer, the codespace will continue with some set up. - - The codespace shares ports added in the `devcontainer.json` file. - - The codespace runs anything specified in `postCreateCommand`. - - {% data variables.product.prodname_codespaces %} clones your dotfiles repository to the codespaces environment and looks for an install file. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - - Finally, the codespace does a full clone of the repo so you have full access to it. - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### codespace を作成する - -{% data reusables.repositories.navigate-to-repo %} -2. リポジトリ名の下で、[Branch] ドロップダウンメニューを使用して、codespace を作成するブランチを選択します。 - - ![[Branch] ドロップダウンメニュー](/assets/images/help/codespaces/branch-drop-down.png) - -3. リポジトリ名の下で、{% octicon "download" aria-label="The download icon" %} [**Code**] ドロップダウンメニューを使用して、[**Open with Codespaces**] を選択します。 - - ![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. To create a codespace using a Standard machine type, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index e0d10bc664..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: codespace を削除する -intro: 不要になった codespace を削除することができます。 -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. Navigate to the repository where you created the codespace. Select **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** and then click {% octicon "gear" aria-label="The Settings gear" %}. This will display all {% data variables.product.prodname_codespaces %} that you have created in the repository. ![Codespaces tab](/assets/images/help/codespaces/codespaces-manage.png) - - Alternatively, you can see every codespace owned by your user account at [github.com/codespaces](https://github.com/codespaces). - -2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete** ![削除ボタン](/assets/images/help/codespaces/delete-codespace.png) - -### {% data variables.product.prodname_vscode %} で Codespaces を削除する - -For information on deleting a codespace in {% data variables.product.prodname_vscode %}, see "[Using Codespaces in Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)." diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index 578df95279..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: codespace で開発する -intro: '{% data variables.product.product_name %} で codespace を開き、{% data variables.product.prodname_vscode %} の機能を使用して開発できます。' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About development with {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} - -![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. Side Bar - By default, this area shows your project files in the Explorer. -2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. -3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it. -4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. -5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. - -For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} 詳しい情報については、「[codespace のトラブルシューティング](/github/developing-online-with-codespaces/troubleshooting-your-codespace)」を参照してください。 - -#### Personalizing your codespace - -{% data reusables.codespaces.about-personalization %} 詳しい情報については、「[アカウントの {% data variables.product.prodname_codespaces %} をパーソナライズする](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)」を参照してください。 - -{% data reusables.codespaces.apply-devcontainer-changes %}詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)」を参照してください。 - -#### Running your app from a codespace -{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." - -#### Committing your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Navigating to an existing codespace - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. 開発する codespace の名前をクリックします。 ![codespace の名前](/assets/images/help/codespaces/click-name-codespace.png) - -Alternatively, you can see any active codespaces for a repository by navigating to the repository in which it was made and selecting **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**. diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index 31d6915005..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Forwarding ports in your codespace -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About forwarded ports - -ポート転送を使用すると、Codespaces 内で実行されている TCP ポートにアクセスできます。 For example, if you're running a web application on port 4000, you can access the application from your browser to test and debug the application. - -When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards the port. You can click on the URL in the terminal to open the port in a browser. たとえば、アプリケーションが `http://127.0.0.1:4000` または `http://localhost:4000` をコンソールに出力する場合、ログは出力をポート 4000 のクリック可能な URL に自動的に変換します。 - -![Automatic port forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) - -You can also forward a port manually, label forwarded ports, share fowarded ports publicly, and add forwarded ports to the codespace configuration. - -### Forwarding a port - -You can manually forward a port that wasn't forwarded automatically. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Under the list of ports, click **Add port**. ![Add port button](/assets/images/help/codespaces/add-port-button.png) -1. Type the port number or address, then press enter. ![Text box to type port button](/assets/images/help/codespaces/port-number-text-box.png) - -### Labeling a port - -You can label a port to make the port more easily identifiable in a list. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Hover over the port you want to label, then click the label icon. ![Label icon for port](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### Sharing a port - -If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to share, then click **Make Public**. ![Option to make port public in right-click menu](/assets/images/help/codespaces/make-public-option.png) -1. To the right of the local address for the port, click the copy icon. ![Copy icon for port URL](/assets/images/help/codespaces/copy-icon-port-url.png) -1. Send the copied URL to the person you want to share the port with. - -### Adding a port to the codespace configuration - -You can add a forwarded port to the {% data variables.product.prodname_codespaces %} configuration for the repository, so the port will automatically be forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)」を参照してください。 - -You can manually configure fowarded ports in a `.devcontainer.json` file using the `forwardPorts` property, or you can use the "Ports" panel in your codespace. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to add to the codespace configuration, then click **Set Label and Update devcontainer.json**. ![Option to set label and add port to devcontainer.json in the right-click menu](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index fb2c11562a..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: codespace で開発する -intro: 'Create a codespace to get started with developing your project inside a dedicated cloud environment. You can use forwarded ports to run your application and even use codespaces inside {% data variables.product.prodname_vscode %}' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index ba5c1d5918..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Visual Studio Code で Codespaces を使用する -intro: '{% data variables.product.product_name %} のアカウントに {% data variables.product.prodname_github_codespaces %} 機能拡張を接続することにより、{% data variables.product.prodname_vscode %} で codespace を直接開発できます。' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 必要な環境 - -{% data variables.product.prodname_vscode %} の Codespaces で直接開発するには、{% data variables.product.prodname_github_codespaces %} 機能拡張にサインインする必要があります。 {% data variables.product.prodname_github_codespaces %} 機能拡張には、{% data variables.product.prodname_vscode %} October 2020 Release 1.51 以降が必要です。 - -{% data variables.product.prodname_vs %} Marketplace を使用して、[{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 機能拡張をインストールします。 詳しい情報については、{% data variables.product.prodname_vscode %} ドキュメントの「[Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery)」を参照してください。 - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [**Sign in to view {% data variables.product.prodname_dotcom %}...**] をクリックします。 ![[Signing in to view {% data variables.product.prodname_codespaces %}]](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. {% data variables.product.prodname_vscode %} からの {% data variables.product.product_name %} のアカウントへのアクセスを承認するには、[**Allow**] をクリックします。 -4. 機能拡張を承認するには、{% data variables.product.product_name %} にサインインします。 - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [REMOTE EXPLORER] ドロップダウンを使用して、[**{% data variables.product.prodname_github_codespaces %}**] をクリックします。 ![{% data variables.product.prodname_codespaces %} ヘッダ](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. [**Sign in to view {% data variables.product.prodname_codespaces %}...**] をクリックします。 ![[Signing in to view {% data variables.product.prodname_codespaces %}]](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. {% data variables.product.prodname_vscode %} からの {% data variables.product.product_name %} のアカウントへのアクセスを承認するには、[**Allow**] をクリックします。 -5. 機能拡張を承認するには、{% data variables.product.product_name %} にサインインします。 - -{% endwindows %} - -### {% data variables.product.prodname_vscode %} で Codespaces を作成する - -{% data variables.product.product_name %} アカウントを {% data variables.product.prodname_github_codespaces %} 機能拡張に接続した後、{% data variables.product.product_name %} または {% data variables.product.prodname_vscode %} で作成した Codespaces で開発できます。 - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [Add] アイコンをクリックしてから、[**Create New Codespace**] をクリックします。 ![{% data variables.product.prodname_codespaces %} の [Create New Codespace] オプション](/assets/images/help/codespaces/create-codespace-vscode.png) -3. 入力し、開発するリポジトリの名前をクリックします。 ![新しい {% data variables.product.prodname_codespaces %} を作成するためのリポジトリを検索する](/assets/images/help/codespaces/choose-repository-vscode.png) -4. 開発するブランチをクリックします。 ![新しい {% data variables.product.prodname_codespaces %} を作成するためのブランチを検索する](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Click the machine type you want to develop in. ![新しい {% data variables.product.prodname_codespaces %} のインスタンスタイプ](/assets/images/help/codespaces/choose-sku-vscode.png) -### {% data variables.product.prodname_vscode %} で codespace を開く - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. [Codespaces] で、開発するコードスペースをクリックします。 -3. [Connect to Codespace] アイコンをクリックします。 ![{% data variables.product.prodname_vscode %} の [Connect to Codespace] アイコン](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### Changing the machine type in {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.codespaces-machine-types %} - -You can change the machine type of your codespace at any time. - -1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). -2. Search for and select "Codespaces: Change Machine Type." ![新しい {% data variables.product.prodname_codespaces %} を作成するためのブランチを検索する](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Click the codespace that you want to change. ![新しい {% data variables.product.prodname_codespaces %} を作成するためのブランチを検索する](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Choose the machine type you want to use. ![新しい {% data variables.product.prodname_codespaces %} を作成するためのブランチを検索する](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. - -### {% data variables.product.prodname_vscode %} で Codespaces を削除する - -1. [Codespaces] で、削除するコードスペースを右クリックします。 -2. ドロップダウンメニューで、[**Delete Codespace**] をクリックします。 ![{% data variables.product.prodname_dotcom %} で Codespaces を削除する](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index b6603ff12a..0000000000 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Using source control in your codespace -intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository. -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About source control in {% data variables.product.prodname_codespaces %} - -You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. - -Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." - -A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: - -* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." -* In your codespace, create a new branch to work on. -* Make your changes and save them. -* Commit the change. -* Raise a pull request. - -### Creating or switching branches - -1. If the current branch is not shown in the status bar, at the bottom of your codespace, right-click the status bar and select **Source control**. -1. Click the branch name in the status bar. ![The branch in the status bar](/assets/images/help/codespaces/branch-in-status-bar.png) -1. In the drop-down, either click the branch you want to switch to, or enter the name for a new branch and click **Create new branch**. ![Choose from the branch menu](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. - -{% endtip %} - -### Pulling changes from the remote repository - -You can pull changes from the remote repository into your codespace at any time. - -{% data reusables.codespaces.source-control-display-dark %} -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. In the drop-down menu, click **Pull**. - -If a dev container has been changed since you created the codespace you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -### Setting your codespace to automatically fetch new changes - -You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. - -If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. - -1. Click the **Manage** button at the bottom of the Activity Bar. ![Manage button](/assets/images/help/codespaces/manage-button.png) -1. In the menu, slick **Settings**. -1. On the Settings page, search for: `autofetch`. ![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) -1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. ![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) -1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. - -### Committing your changes - -{% data reusables.codespaces.source-control-display-dark %} -1. To stage your changes, click **+** next to the file you've changed, or next to **Changes** if you've changed multiple files and you want to stage them all. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. Type a commit message describing the change you've made. ![Source control side bar with a commit message](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. To commit your staged changes, click the check mark at the top the source control side bar. ![Click the check mark icon](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### Raising a pull request - -1. After you've committed changes to your local copy of the repository, click the **Create Pull Request** icon. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. ** Create(作成)**をクリックしてください。 - -### Pushing changes to your remote repository - -You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. - -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. In the drop-down menu, click **Push**. diff --git a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index 05f3bb6766..0000000000 --- a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Getting started with your C# (.NET) project in Codespaces -shortTitle: Getting started with your C# (.NET) project -allowTitleToDifferFromFilename: true -intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### はじめに - -This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 必要な環境 - -- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project ](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. Click the recommended version of .NET. ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the .NET Core version that we want to use. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Dockerfile - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "dotnet restore", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - - ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via pip3. With our dependencies now installed, we can run our application. - -1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 次のステップ - -You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index 4daa52e258..0000000000 --- a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: Getting started with your Java project in Codespaces -shortTitle: Getting started with your Java project -intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### はじめに - -This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 必要な環境 - -- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Click the recommended version of Java. ![Java version selection](/assets/images/help/codespaces/add-java-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Dockerfile - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`. - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm. - -1. Run your application by pressing `F5`. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 次のステップ - -You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index 2ef0866b92..0000000000 --- a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Getting started with your Node.js project in Codespaces -shortTitle: Getting started with your Node.js project -intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### はじめに - -This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 必要な環境 - -- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Click the recommended version of Node.js. ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Dockerfile - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the {% data variables.product.prodname_vscode %} docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm. - -1. Run your start command in the terminal with`npm start`. - - ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 次のステップ - -You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index 76e42cb726..0000000000 --- a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Getting started with your Python project in Codespaces -shortTitle: Getting started with your Python project -intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### はじめに - -This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 必要な環境 - -- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgresSQL. ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Click the recommended version of Python. ![Python version selection](/assets/images/help/codespaces/add-python-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Dockerfile - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". **Codespaces: Rebuild Container**をクリックしてください。 - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - - ![Extensions list](/assets/images/help/codespaces/python-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. - -1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 次のステップ - -You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/index.md b/translations/ja-JP/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index 396851c0bb..0000000000 --- a/translations/ja-JP/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Getting Started with {% data variables.product.prodname_codespaces %}' -intro: 'Learn how to get started with {% data variables.product.prodname_codespaces %}, including set up and configuration for specific languages.' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ja-JP/content/codespaces/guides.md b/translations/ja-JP/content/codespaces/guides.md deleted file mode 100644 index 8a154aebe1..0000000000 --- a/translations/ja-JP/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Codespaces guides -shortTitle: ガイド -intro: 'Learn how to make the most of GitHub {% data reusables.gated-features.codespaces %}' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/ja-JP/content/codespaces/index.md b/translations/ja-JP/content/codespaces/index.md deleted file mode 100644 index d7c9926f2c..0000000000 --- a/translations/ja-JP/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GitHub Codespaces Documentation -beta_product: true -shortTitle: GitHub Codespaces -intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.' -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index 7d7055b862..0000000000 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Managing Codespaces for your organization -intro: 'You can manange and review how users in your organization can use {% data variables.product.prodname_github_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index 4e31f7fa17..0000000000 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Managing access and security for your organization's codespaces -shortTitle: Managing access and security for your organization -intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Organization owners can manage which repositories a codespace can access. - -By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read and write permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository where the codespace was created, or to specific repositories. 信頼するリポジトリに対してのみ、アクセスとセキュリティを有効にしてください。 - -To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. [Access and security] で、あなたの Organization の設定を選択します。 ![信頼するリポジトリを管理するラジオボタン](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. [Selected repositories] を選択した場合、ドロップダウンメニューを選択してから、あなたの Organization が所有するその他のリポジトリにアクセスを許可する、リポジトリのコードスペースをクリックします。 その他のリポジトリにコードスペースによるアクセスを許可したい、すべてのリポジトリについて同じ手順を繰り返します。 ![[Selected repositories]ドロップダウンメニュー](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index aac26610da..0000000000 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Managing encrypted secrets for your repository and organization for Codespaces -shortTitle: Managing secrets for your repository and organization -intro: 'Encrypted secrets allow you to store sensitive information in your organization, repository, or {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### About secrets - -Secrets are encrypted environment variables that you create in an organization or repository. The secrets that you create are available to use in {% data variables.product.prodname_codespaces %}. GitHub uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before they reach GitHub and only decrypts them when you use them in a codespace. - -Organization-level secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. - - {% data reusables.codespaces.secret-precedence %} - -#### シークレットの制限 - -You can store up to 100 secrets per organization and 100 secrets per repository. - -シークレットの容量は最大64 KBです。 - -### Adding secrets for a repository - -To create secrets for an organization repository, you must have administrator access. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. At the top of the page, click **New repository secret**. -1. **[Name(名前)]** 入力ボックスにシークレットの名前を入力します。 -1. シークレットの値を入力します。 -1. [**Add secret(シークレットの追加)**] をクリックします。 - -### Adding secrets for an organization - -Organizationでシークレットを作成する場合、ポリシーを使用して、そのシークレットにアクセスできるリポジトリを制限できます。 たとえば、すべてのリポジトリにアクセスを許可したり、プライベート リポジトリまたは指定したリポジトリ のリストのみにアクセスを制限したりできます。 - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. At the top of the page, click **New organization secret**. -1. **[Name(名前)]** 入力ボックスにシークレットの名前を入力します。 -1. シークレットの **Value(値)** を入力します。 -1. [ **Repository access(リポジトリアクセス)** ドロップダウン リストから、アクセス ポリシーを選択します。 ![Repository Access list with private repositories selected](/assets/images/help/codespaces/secret-repository-access.png) -1. [**Add secret(シークレットの追加)**] をクリックします。 - -### Organizationレベルのシークレットへのアクセスの確認 - -You can check which access policies are applied to a secret in your organization. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. シークレットのリストには、設定済みのアクセス許可とポリシーが含まれます。 例: ![シークレットリスト](/assets/images/help/settings/actions-org-secrets-list.png) -1. 各シークレットに設定されているアクセス許可の詳細については、[**Update(更新)**] をクリックしてください。 diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index fee663a78c..0000000000 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Managing user permissions for your organization -intro: 'You can control which users in your organization can use {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### About user permissions for {% data variables.product.prodname_codespaces %} - -Organization owners can control which users in your organization can create and use codespaces. - -To use codespaces in your organization, your users must have at least write access to the repositories where they want to use a codespace. You can enable codespaces for all users in your organization, or only specific users. - -By default, a codespace can only access the repository where it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -### Configuring which users in your organization can use {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select one of the following options: - - * **Disabled** to not allow any organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - - ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index c438a70311..0000000000 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Reviewing your organization's audit logs for Codespaces -shortTitle: Reviewing your organization's audit logs -intro: 'You can use the audit log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -When any member of your organization performs an action related to {% data variables.product.prodname_codespaces %}, you can review the actions in the audit log. For information about accessing the log, see "[Reviewing your audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)." - -![Audit log with Codespaces information](/assets/images/help/settings/codespaces-audit-log-org.png) - -The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)." diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/index.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 142e6c292d..0000000000 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing your codespaces -intro: 'You can use {% data variables.product.prodname_github_codespaces %} settings to manage information that your codespace might need.' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index 8717f53157..0000000000 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing access and security for your codespaces -intro: 'You can manage the repositories that {% data variables.product.prodname_codespaces %} can access.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read and write permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. 信頼するリポジトリに対してのみ、アクセスとセキュリティを有効にしてください。 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. [Access and security] で、あなたのユーザアカウントの設定を選択します。 ![信頼するリポジトリを管理するラジオボタン](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. [Selected repositories] を選択した場合、ドロップダウンメニューを選択してから、あなたの所有するその他のリポジトリにアクセスを許可する、リポジトリのコードスペースをクリックします。 所有するその他のリポジトリにコードスペースによるアクセスを許可したい、すべてのリポジトリについて同じ手順を繰り返します。 ![[Selected repositories]ドロップダウンメニュー](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index 0cbfa2b388..0000000000 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Managing encrypted secrets for your codespaces -intro: 環境変数を介してコードスペースにアクセスする、トークンなどの機密情報を保存できます。 -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### {% data variables.product.prodname_codespaces %} の暗号化されたシークレットについて - -コードスペースで使用するユーザアカウントに、暗号化されたシークレットを追加できます。 たとえば、次のような機密情報を暗号化されたシークレットとして保存しアクセスするとよいでしょう。 - -- クラウドサービスへの個人アクセストークン -- サービスプリンシパル -- プラン識別子 -- [Credentials for a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -各シークレットにアクセスできるリポジトリを選択できます。 そして、シークレットへのアクセス権があるリポジトリ用に作成した任意のコードスペースでそのシークレットを使用できます。 - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository. - - {% data reusables.codespaces.secret-precedence %} - -#### シークレットの制限 - -You can store up to 100 secrets for {% data variables.product.prodname_codespaces %}. - -シークレットの容量は最大64 KBです。 - -### シークレットを追加する - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. [Codespaces secrets] の右にある [**New secret**] をクリックします。 ![[New secret] ボタン](/assets/images/help/settings/codespaces-new-secret-button.png) -1. [Name] で、シークレットの名前を入力します。 ![[Name] テキストボックス](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. [**Add secret(シークレットの追加)**] をクリックします。 - -### シークレットを編集する - -既存のシークレットの値を更新したり、シークレットがアクセスできるリポジトリを変更したりすることができます。 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. [Codespaces secrets] で、編集するシークレットの右にある [**Update**] をクリックします。 ![[Update] ボタン](/assets/images/help/settings/codespaces-secret-update-button.png) -1. [Value] にある [**enter a new value**] をクリックします。 ![[enter a new value] リンク](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. リポジトリへのシークレットのアクセス権を削除する場合は、リポジトリを選択解除します。 ![リポジトリへのアクセス権を削除するチェックボックス](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. [**Save changes**] をクリックします。 - -### シークレットを削除する - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. [Codespaces secrets] で、削除するシークレットの右にある [**Delete**] をクリックします。 ![[Delete] ボタン](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. 警告を読んで、**OK**をクリックしてください。 ![シークレットの削除の確認](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index 6702951351..0000000000 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Codespaces の GPG 検証を管理する -intro: '変更が信頼できるソースからのものであることを他の人々が確信できるよう、コードスペースで作成したコミットに GPG を自動的に使用して署名するよう {% data variables.product.company_short %} に許可できます。' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -GPG 検証を有効にすると、{% data variables.product.company_short %} は {% data variables.product.prodname_codespaces %} であなたが作成したコミットに自動的に署名し、そのコミットは {% data variables.product.product_name %} で検証済みのステータスとなります。 デフォルトでは、GPG 検証は作成されたコードスペースに対して無効になっています。 GPG 検証を、すべてのリポジトリに対して許可するか特定のリポジトリに対して許可するか選択できます。 GPG 検証は、信頼するリポジトリに対してのみ有効にしてください。 {% data variables.product.product_name %} が署名したコミットに関する詳しい情報については、「[コミット署名の検証について](/github/authenticating-to-github/about-commit-signature-verification)」を参照してください。 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. [GPG verification] で、GPG 検証の設定を選択します。 ![GPG 検証を管理するラジオボタン](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. [Selected repositories] を選択した場合、ドロップダウンメニューを選択してから、GPG 検証を有効にするリポジトリをクリックします。 GPG 検証を有効にするすべてのリポジトリについて、同じ手順を繰り返します。 ![[Selected repositories]ドロップダウンメニュー](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index f7e213e258..0000000000 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Reviewing your security logs for Codespaces -shortTitle: Reviewing your security logs -intro: 'You can use the security log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### About security logs for {% data variables.product.prodname_codespaces %} - -When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your user account, you can review the actions in the security log. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." - -![security log with Codespaces information](/assets/images/help/settings/codespaces-audit-log.png) - -The security log includes details on what action occured and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". diff --git a/translations/ja-JP/content/codespaces/quickstart.md b/translations/ja-JP/content/codespaces/quickstart.md deleted file mode 100644 index 825bb68b93..0000000000 --- a/translations/ja-JP/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Quickstart for GitHub Codespaces -intro: 'Try out {% data variables.product.prodname_codespaces %} in 5 minutes or less.' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### はじめに - -In this guide, you'll create a codespace from the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces) and explore some of the essential features available to you within the codespace. - -The following example shows you how to create a codespace, connect to a forwarded port to view your running application, and personalize your setup with additional extensions and dotfiles. - -### Creating your codespace - -1. Navigate to the main page of the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces). - -2. リポジトリ名の下で、{% octicon "download" aria-label="The download icon" %} [**Code**] ドロップダウンメニューを使用して、[**Open with Codespaces**] を選択します。 - - ![[Open with Codespaces] ボタン](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. To create a codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) - -### Run the application - -With your project open in a codespace, you can now run the application and launch it in a browser. - -1. Start the application by entering `npm run dev` in the terminal. This command executes the `dev` script in the package.json file and starts up the web application defined in the sample repository. - - ![npm run dev in terminal](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. Click **Open in Browser** to view your running application in a new tab. - -### Personalize with a theme extension - -Within a codespace, you have access to the Visual Studio Code Marketplace. For this example, you'll install an extension that alters the theme but you can install any extension that is useful for your workflow. - -1. In the left sidebar, click the Extensions icon. - -2. In the search bar, enter `fairyfloss` and install the fairyfloss extension. - - ![Add an extension](/assets/images/help/codespaces/add-extension.png) - -3. Select the `fairyfloss` theme by selecting it from the list. - - ![Select the fairyfloss theme](/assets/images/help/codespaces/fairyfloss.png) - -4. Changes you make to your editor setup in the current codespace, such as theme and keyboard bindings, are synced automatically to other codespaces via [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). - -### Personalize with dotfiles - -If your user account on GitHub owns a public repository named dotfiles, GitHub automatically uses this repository to personalize your codespace environment during codespace creation. - -This example guides you through creating a dotfiles repository for your codespaces. - -1. Navigate to the sample [dotfiles repository](https://github.com/aw-test-93/dotfiles/). - -2. Fork the repository to your account and ensure it's public. - - Verify the repository created under your account is named dotfiles, for example `yourname/dotfiles`. Any other name will cause {% data variables.product.prodname_codespaces %} to ignore the repository for personalization. - -3. Create a new codespace from the [sample application repository](https://github.com/2percentsilk/haikus-for-codespaces) as dotfile updates are only applied at creation time. The sample dotfiles will change the command prompt to bold purple and blue text. - - ![Custom command prompt](/assets/images/help/codespaces/custom-prompt.png) - -### Next Steps - -You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_codespaces %}. - - "[Getting Started guides](/codespaces/getting-started-with-codespaces)" for using {% data variables.product.prodname_codespaces %} with specific languages - - [Create a custom configuration](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project) to configure {% data variables.product.prodname_codespaces %} for your project. diff --git a/translations/ja-JP/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/ja-JP/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index 57b5f640ad..0000000000 --- a/translations/ja-JP/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: プロジェクトの Codespace の設定 -intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About dev containers - -A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. When working with a dev container in {% data variables.product.prodname_codespaces %} you can either [use the default configuration](#using-the-default-configuration), [use a pre-defined configuration](#using-a-pre-defined-container-configuration), or [create your own configuration](#creating-a-custom-codespace-configuration). The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. - -{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. - -For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. - -#### Dockerfile - -A Dockerfile also lives in the `.devcontainer` folder. - -You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -You can use the `RUN` instruction to install any software and `&&` to join commands. - -Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. - -### Using the default configuration - -リポジトリで設定を定義しない場合、{% data variables.product.prodname_dotcom %} はベースの Linux イメージを使用して Codespaces を作成します。 The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. - -Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. - -The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. - - -### Using a predefined container configuration - -Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. - -Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. - -1. To access the command palette, in the upper-left corner, select the Application Menu and click **Command Palette…** from the **View** menu, then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. Click the definition you want to use. ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. Follow the prompts to customize your definition. -1. [**OK**] をクリックします。 ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) - - -### カスタム codespace 設定を作成する - -If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} - -In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. - -{% data reusables.codespaces.vscode-settings-order %} - -2 つの場所で {% data variables.product.prodname_vscode %} のデフォルトのエディタ設定を定義できます。 - -* `.vscode/settings.json` で定義されたエディタ設定は、_Workspace_ スコープの設定として codespace に適用されます。 -* `devcontainer.json` の`設定`キーで定義されたエディタ設定は、codespace の _リモート [Codespaces]_ スコープ設定として適用されます。 - -After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." - - - - -### Applying changes to your configuration - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %} -!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) - - To diagnose the error by reviewing the creation logs, click **View creation log**. - - To fix the errors identified in the logs, update your `devcontainer.json` file. - - To apply the changes, rebuild your container. {% data reusables.codespaces.rebuild-command %} diff --git a/translations/ja-JP/content/codespaces/setting-up-your-codespace/index.md b/translations/ja-JP/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index f47cc82ec3..0000000000 --- a/translations/ja-JP/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Setting up your codespace -intro: '{% data variables.product.prodname_codespaces %} is a dedicated environment for you. You can configure your codespace with a dev container to install your dependencies or you can add a dotfile to personalize the user settings.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ja-JP/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/ja-JP/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index 2543e9f4f8..0000000000 --- a/translations/ja-JP/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: アカウントの Codespaces をパーソナライズする -intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About personalizing {% data variables.product.prodname_codespaces %} - -When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces. - -- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}. -- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations. - -{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create. - -プロジェクトのメンテナは、ユーザが作成したリポジトリのすべての codespace に適用されるデフォルト設定を定義することもできます。 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)」を参照してください。 - -### Settings Sync - -Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}. - -Settings Sync is on by default. To configure any settings, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is on**. From the dialog, you can choose to configure, show settings and data, or turn off Settings Sync. - -![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode %} documentation. - -### Dotfiles - -ドットファイルは、`.` で始まる Unix ライクなシステム上のファイルとフォルダであり、システム上のアプリケーションとシェルの設定を制御します。 ドットファイルは、{% data variables.product.prodname_dotcom %} のリポジトリに保存して管理できます。 `dotfiles` リポジトリに含める内容に関するアドバイスとチュートリアルについては、「[GitHub does dotfiles](https://dotfiles.github.io/)」をご覧ください。 - -{% data variables.product.prodname_dotcom %} のユーザアカウントが `dotfiles` というパブリックリポジトリを所有している場合、{% data variables.product.prodname_dotcom %} は自動的にこのリポジトリを使用して、codespace 環境をパーソナライズします。 プライベート `dotfiles` リポジトリは現在サポートされていません。 - -`dotfiles` リポジトリには、シェルのエイリアスと設定、インストールするツール、またはその他の codespace パーソナライゼーションを含めることができます。 - -新しいコードスペースを作成すると、{% data variables.product.prodname_dotcom %} は `dotfiles` リポジトリを codespace 環境にクローンし、次のいずれかのファイルを探して環境をセットアップします。 - -* _install.sh_ -* _install_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -これらのファイルがいずれも見つからない場合、`.` で始まる `dotfiles` 内のファイルまたはフォルダは、codespace の `~` または `$HOME` ディレクトリにシンボリックリンクされます。 - -`dotfiles` リポジトリへの変更は、新しい codespace ごとにのみ適用され、既存の codespace には影響しません。 - -{% note %} - -**注釈:** 現在、{% data variables.product.prodname_codespaces %} は、`dotfiles` リポジトリを使用した {% data variables.product.prodname_vscode %} エディタの_ユーザ_設定のパーソナライズをサポートしていません。 プロジェクトのリポジトリ内の特定のプロジェクトに対して、デフォルトの _ワークスペース_および_リモート [Codespaces]_ を設定できます。 詳しい情報については、「[プロジェクトの {% data variables.product.prodname_codespaces %} を設定する](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)」を参照してください。 - -{% endnote %} - -ユーザアカウントに対し、暗号化されたシークレットを追加したり、GPG 検証を有効にしたり、Codespaces が他のリポジトリアクセスできたりするように設定することもできます。 詳しい情報については、「[{% data variables.product.prodname_codespaces %} の暗号化されたシークレットを管理する](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)」、「[{% data variables.product.prodname_codespaces %} の GPG 検証を管理する](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)」、および「[{% data variables.product.prodname_codespaces %} のアクセス権限およびセキュリティを管理する](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)」を参照してください。 " - -### 参考リンク - -* 「[新しいリポジトリを作成する](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)」 diff --git a/translations/ja-JP/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/ja-JP/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index edfafd8e2f..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %}はベータの間、無料で利用できます。 {% data variables.product.prodname_codespaces %} が一般提供されると、ストレージとコンピューティングの使用量に対して課金されます。 diff --git a/translations/ja-JP/data/reusables/codespaces/about-configuration.md b/translations/ja-JP/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 4d7fc068b5..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -リポジトリのデフォルトのcodespace設定を作成し、そのリポジトリで作成されたすべての新しいcodespaceの環境を決定できます。 この設定は、フレームワーク、ツール、機能拡張、ポートフォワーディングを含む開発コンテナを定義します。 diff --git a/translations/ja-JP/data/reusables/codespaces/about-personalization.md b/translations/ja-JP/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index bfa56b8edc..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -[dotfiles](https://dotfiles.github.io/tutorials/)リポジトリと[Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync)を使用して、作成した任意のcodespace環境の様々な面をパーソナライズすることもできます。 パーソナライズには、シェルの環境設定や追加のツールが含まれます。 diff --git a/translations/ja-JP/data/reusables/codespaces/about-port-forwarding.md b/translations/ja-JP/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index 81e2b5041c..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -アプリケーションのテストとデバッグのために、codespace中のポートをフォワードできます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/ja-JP/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index 325636d0f9..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -リポジトリのための{% data variables.product.prodname_codespaces %}の設定が変更された後、codespaceのコンテナをリビルドしてその変更を既存のcodespaceに適用できます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/beta-functionality-limited.md b/translations/ja-JP/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 7a4feb947f..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -ベータの期間中、機能は制限されています。 -- {% data reusables.codespaces.use-chrome %} -- codespaceのサイズは1つだけしか利用できません。 -- Linuxコンテナのみサポートされています。 -- codespaceは完全に再開可能ではありません。 codespaceが停止された時に実行中だったプロセスは、再開されません。 diff --git a/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index 4400acc1c9..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. {% data variables.product.prodname_vscode %}の左サイドバーで、 Remote Explorerのアイコンをクリックしてください。 ![{% data variables.product.prodname_vscode %}のRemote Explorerアイコン](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/codespace-config-order.md b/translations/ja-JP/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index f751373676..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -`dotfiles`のパーソナライゼーションは、リポジトリのデフォルトのcodespace設定よりも先に適用されます。 diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/ja-JP/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index 06d2a0b13e..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -各codespaceはリポジトリの特定ブランチと関連づけられます。 diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-are-personal.md b/translations/ja-JP/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index 3b8cd5ea26..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -各コードスペースは、作成者だけが利用できます。 他者のcodespaceで作業することはできません。 diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-machine-types.md b/translations/ja-JP/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index cd09a0cb7c..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -codespaceは、Basic、Standard、Premiumの3種類のリモートマシンから選択して実行できます。 これらはそれぞれ、異なるレベルのリソースと支払い層を持っています。{% note %} - -**注釈:** {% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -マシンタイプを切り替えることで、作業に最も適したリソースを柔軟に選択できます。 特待のタスクでは、様々なマシンタイプが必要になることがあります。 - -* ファイルの更新とPull Requestの作成に対しては**Basic** -* Webサイトの編集に対しては**Standard** -* データ分析のような高負荷のコンピューティングタスクに対しては**Premium** diff --git a/translations/ja-JP/data/reusables/codespaces/committing-link-to-procedure.md b/translations/ja-JP/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 737d91787e..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -新しいコードであれ、設定の変更であれ、codespaceに変更を加えたら、その変更をコミットしたくなるでしょう。 リポジトリに変更をコミットすれば、このリポジトリからcodespaceを作成する他の人が、同じ設定になることを保証できます。 これはまた、{% data variables.product.prodname_vscode %}機能拡張の追加など、あなたが行うすべてのカスタマイズが、すべてのユーザに対して現れるようになるということでもあります。 - -詳しい情報については「[codespaceでのソースコントロールの利用](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index e24bc48f26..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -リポジトリごと、さらにはブランチごとに1つ以上のcodespaceを作成できます。 しかし、限定パブリックベータの間は、ユーザアカウントごとに2つのcodespaceという制限があります。 この制限に達した場合に新しいcodespaceを作成したいなら、まずcodespaceを削除しなければなりません。 diff --git a/translations/ja-JP/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/ja-JP/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index c7761ac154..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_vscode %}から直接codespaceに接続できます。 詳しい情報については「[{% data variables.product.prodname_vscode %}でのCodespacesの利用](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/codespaces/devcontainer-location.md b/translations/ja-JP/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index ca21d7fe6f..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -このファイルは、リポジトリのルートもしくは`.devcontainer`というフォルダに置くことができます。 このファイルがリポジトリのルートに置かれた場合、ファイル名は`.devcontainer.json`というようにピリオドで始まらなければなりません。 diff --git a/translations/ja-JP/data/reusables/codespaces/navigate-to-codespaces.md b/translations/ja-JP/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index 46fba2d291..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. 任意のページの上部で**Codespaces**をクリックしてください。 ![ヘッダの{% data variables.product.prodname_codespaces %}リンク](/assets/images/help/codespaces/header-link.png) diff --git a/translations/ja-JP/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/ja-JP/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index f4722c8f52..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. codespaceで、テキストエディタの下で"Ports(ポート)"をクリックしてください。 ![ポートタブ](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/ja-JP/data/reusables/codespaces/rebuild-command.md b/translations/ja-JP/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index 0c6f3d536b..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -コマンドパレットにアクセス(`shift command P` / `shift control P`)し、続いて"Codespaces: Rebuild Container"と入力していってください。 **Codespaces: Rebuild Container**をクリックしてください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/recovery-mode.md b/translations/ja-JP/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index c3e876cf70..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -codespaceの設定の変更でコンテナエラーが生じた場合、codespaceはリカバリモードで動作し、エラーメッセージが表示されます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/release-stage.md b/translations/ja-JP/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 304cbc403c..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**注釈:** {% data variables.product.prodname_codespaces %} は現在限定パブリックベータであり、変更されることがあります。 ベータへの参加に関する詳しい情報については「[{% data variables.product.prodname_codespaces %}について](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)」を参照してください。 - -{% endnote %} diff --git a/translations/ja-JP/data/reusables/codespaces/secret-precedence.md b/translations/ja-JP/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index 7494d533a1..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -複数のレベルで同じ名前のシークレットが存在する場合、低いレベルのシークレットが優先されます。 たとえば、Organization レベルのシークレット名がリポジトリレベルのシークレット名と同じ場合、リポジトリレベルのシークレット名が優先されます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/secrets-naming.md b/translations/ja-JP/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index 7edc62b31f..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -シークレットの名前には次のルールが適用されます。 - -* シークレット名には、英数字(`[a-z]`、`[A-Z]`、`[0-9]`)または下線(`_`)のみを含めることができます。 スペースは使用できません。 -* シークレット名の最初を `GITHUB_` プレフィックスにすることはできません。 -* シークレット名の最初を数字にすることはできません。 -* シークレット名は大文字と小文字を区別しません。 -* シークレット名は、作成されたレベルで一意である必要があります。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/secrets-on-start.md b/translations/ja-JP/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index 6c20d574b1..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -シークレットを作成すると、新しいcodespaceを作成したり、codespaceを再起動したりすれば、利用できるようになります。 現在のcodespaeで作成したばかりのシークレットを使うには、codespeceをサスペンドして再開する必要があります。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/source-control-display-dark.md b/translations/ja-JP/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index 2a62311454..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. Activityバーで、**Source Control(ソースコントロール)**ビューをクリックしてください。 ![ソースコントロールビュー](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/source-control-display.md b/translations/ja-JP/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index 537d6acc2e..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. Activityバーで、**Source Control(ソースコントロール)**ビューをクリックしてください。 - - ![ソースコントロールビュー](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/type-port-label.md b/translations/ja-JP/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index 99b9f6faa7..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. ポートのラベルを入力し、Enterを押してください。 ![ポートのラベルを入力するためのテキストボックス](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/unsupported-repos.md b/translations/ja-JP/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index a7046ae35a..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -ベータの期間、Organizationが所有するプライベートリポジトリ、あるいはSAMLシングルサインオンを必要とするOrganizationが所有するリポジトリはサポートされません。 diff --git a/translations/ja-JP/data/reusables/codespaces/use-chrome.md b/translations/ja-JP/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index 46ce3acf0e..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %}での最善の体験のためには、Google ChromeあるいはMicrosoft EdgeのようなChromiumベースのブラウザを使うことをおすすめします。 diff --git a/translations/ja-JP/data/reusables/codespaces/use-visual-studio-features.md b/translations/ja-JP/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index 20b4c76baf..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_vscode %}でcodespace内で開発をする間に、コードを編集し、デバッグし、Gtiのコマンドを使うことができます。 詳しい情報については[{% data variables.product.prodname_vscode %}のドキュメンテーション](https://code.visualstudio.com/docs)を参照してください。 diff --git a/translations/ja-JP/data/reusables/codespaces/vscode-settings-order.md b/translations/ja-JP/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index bec24daf60..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_vscode %}のエディタ設定を行う際には、_Workspace_、_Remote [Codespaces]_、_User_という3つのスコープが利用できます。 複数のスコープ内で定義された設定については、_Workspace_の設定が優先され、次が_Remote [Codespaces]_、そして_User_となります。 diff --git a/translations/ja-JP/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/ja-JP/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index 4d6c6dd0bd..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -作成した利用可能なすべてのcodespaceは[github.com/codespaces](https://github.com/codespaces)で見ることができます。 diff --git a/translations/ja-JP/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/ja-JP/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index c2b4268878..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. {% data variables.product.product_name %}の右上で、自分のプロフィール写真をクリックし、続いて**Your codespaces(自分のcode spaces)**をクリックしてください。 - - !['自分のcodespaces'メニューオプション](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/gated-features/codespaces.md b/translations/ja-JP/data/reusables/gated-features/codespaces.md deleted file mode 100644 index a7d9ed1133..0000000000 --- a/translations/ja-JP/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Codespacesは、{% data variables.product.prodname_free_user %}もしくは{% data variables.product.prodname_pro %}を使っているユーザアカウントで利用できます。 {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/ja-JP/data/reusables/organizations/click-codespaces.md b/translations/ja-JP/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index 3c7ff3a042..0000000000 --- a/translations/ja-JP/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. 左のサイドバーで**Codespaces**をクリックしてください。 ![左のサイドバー内の"Codespaces"タブ](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/ja-JP/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/ja-JP/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index 5fbef30671..0000000000 --- a/translations/ja-JP/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. "Repository access(リポジトリアクセス)"ドロップダウンメニューを選択し、続いてシークレットへアクセスしたいリポジトリをクリックしてください。 シークレットにアクセスしたいすべてのリポジトリに対して繰り返してください。 !["リポジトリアクセス"ドロップダウンメニュー](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/user_settings/codespaces-secret-value.md b/translations/ja-JP/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index adb80f1285..0000000000 --- a/translations/ja-JP/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. "Value(値)"の下で、シークレットの値を入力してください。 !["値"テキストボックス](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/user_settings/codespaces-tab.md b/translations/ja-JP/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index 1c2363d30c..0000000000 --- a/translations/ja-JP/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. 左のサイドバーで**Codespaces**をクリックしてください。 ![ユーザ設定サイドバーのCodespacesタブ](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/translations/ko-KR/content/codespaces/about-codespaces.md b/translations/ko-KR/content/codespaces/about-codespaces.md deleted file mode 100644 index b7fc37f8ef..0000000000 --- a/translations/ko-KR/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: About Codespaces -intro: '{% data variables.product.prodname_codespaces %} is a configurable online development environment, hosted by {% data variables.product.prodname_dotcom %} and powered by {% data variables.product.prodname_vscode %}, that allows you to develop entirely in the cloud.' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### About {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} is a configurable cloud development environment available in your browser on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -![An open codespace](/assets/images/help/codespaces/codespace-overview.png) - -A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings. - -Codespaces offers many benefits to teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development. - -### A consistent environment - -You can create a single codespace configuration that defines the environment (or _dev container_) of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. A standardized environment is already available for them as soon as they create a codespace from the repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." - -For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials. - -While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -### Fast and personal onboarding - -With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**. - -![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -As a result of standardizing on a repeatable developer environment, developers can get started with a new codespace without doing any manual configuration and do not need to do continued maintenance of their developer environment. A new codespace can be created when starting a new feature. - -Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - -Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs. - -### A secure environment - -{% data variables.product.prodname_codespaces %} allows developers to develop in the cloud instead of locally. This creates one single, trackable, source of truth. Developers can contribute from anywhere, on any machine, including tablets or Chromebooks, and there is no need to maintain local copies of intellectual property. Developers always have to be logged in and provided with access to both {% data variables.product.prodname_codespaces %} and specific repositories. These permissions can be revoked at any time. As soon as you revoke access, those developers will lose all access to protected resources. In addition, authenticated developers create audit trails so you know who is doing what. For more information on access and security, see "[Managing access and security for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -Using {% data variables.product.prodname_codespaces %} is the most secure when all members of your team are using it. It means that there is no need to clone the repository onto a local machine and that developers don't need to install locally as `root`. - -Developers and organization administrators can also configure settings to add encrypted secrets and enable GPG verification. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)". - -### About billing for {% data variables.product.prodname_codespaces %} - -{% data reusables.codespaces.about-billing-for-codespaces %} For more information, see "[About billing for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)." - -### Joining the beta - -A limited number of people will be invited to join the beta. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup). - -### Contacting us about {% data variables.product.prodname_codespaces %} - -If you encounter problems using {% data variables.product.prodname_codespaces %}, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." - -If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) discussion. diff --git a/translations/ko-KR/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/ko-KR/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index f621a80494..0000000000 --- a/translations/ko-KR/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: About billing for Codespaces -intro: 'When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -Updates on the billing model for Codespaces will be shared in an upcoming announcement. diff --git a/translations/ko-KR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/ko-KR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index 75be9e6f73..0000000000 --- a/translations/ko-KR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Allowing your codespace to access a private image registry -intro: 'You can use secrets to allow {% data variables.product.prodname_codespaces %} to access a private image registry' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. You can create secrets in GitHub to store the access details for a private registry and use them to give your codespace access to images stored in the registry. - -When you launch a codespace, {% data variables.product.prodname_codespaces %} checks for three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -You can store secrets at the user, repository, or organization-level, allowing you to share them securely between different codespaces. When you create a set of secrets for a private image registry, you need to replace the “<*>” in the name with a consistent identifier. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" and "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)." - -For example, if you had a private image registry in Azure, you could create the following secrets: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/ko-KR/content/codespaces/codespaces-reference/index.md b/translations/ko-KR/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index a19771efe4..0000000000 --- a/translations/ko-KR/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Reference -intro: 'This section contains references that will allow you to be successful with {% data variables.product.prodname_codespaces %}' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry - - /using-the-command-palette-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ko-KR/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/ko-KR/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index 2e91229596..0000000000 --- a/translations/ko-KR/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Troubleshooting your codespace -intro: Use this guide to help you troubleshoot common issues with your codespace. -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Known Limitations - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### {% data variables.product.prodname_vscode %} troubleshooting - -Use **Issues** in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository to check for known issues or to log issues about the {% data variables.product.prodname_vscode %} experience. - - -### Configuration troubleshooting - -{% data reusables.codespaces.recovery-mode %} - -``` -This codespace is currently running in recovery mode due to a container error. -``` - -Review the creation logs, update the configuration as needed, and run **Codespaces: Rebuild Container** in the command palette to retry. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." - -### dotfiles troubleshooting - -- Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. -- Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - - If your dotfiles were cloned, try manually re-running your install script to verify it's executable. - - If your dotfiles weren't cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. -- Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. Alternatively, you can view the `creation.log` by navigating to the command palette and entering **Codespaces: View Creation Log**. - - -### Browser troubleshooting - -If you encounter issues while using a browser that is not Chromium-based, try switching to a Chromium-based browser, or check for known issues with your browser in the `microsoft/vscode` repository by searching for issues labeled with the name of your browser, such as[`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) or [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari). - -If you encounter issues while using a Chromium-based browser, you can check if you're experiencing another known issue with {% data variables.product.prodname_vscode %} in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository. - -### Container storage troubleshooting - -When you create a codespace, it has a finite amount of storage and over time it may be necessary for you to free up space. Try any of the following items to free up storage space. - -- Remove packages that are no longer by using `sudo apt autoremove` -- Clean the apt cache by using `sudo apt clean` -- Delete unneeded files like build artifacts and logs (these are very project-dependent) -- See the top 10 largest files in the codespace: `sudo find / -printf '%s %p\n'| sort -nr | head -10` - -More destructive options: -- Remove unused Docker images, networks, and containers by using `docker system prune` (append `-a` if you want to remove all images, and `--volumes` if you want to remove all volumes) -- Remove untracked files from working tree: `git clean -i` - -### 문의처 - -If you still need help, you can contact us. For more information, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)." diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index 19fc36dfc5..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Creating a codespace -intro: You can create a codespace for a branch in a repository to develop online. -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About codespace creation - -You can create a codespace on either {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %} - -Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)." - - -When you create a codespace, a number of steps happen to enable full access to your development environment. - -- Resources such as a VM and storage for your container are assigned. A new VM is created every time you create or start a codespace to ensure that you always have the latest versions and security patches. -- {% data variables.product.prodname_codespaces %} recieves information about your repository, branch, commits, your public dotfiles repository, and any secrets that you have created. -- {% data variables.product.prodname_codespaces %} executes a shallow clone of the repository. -- If you have one in your repository, {% data variables.product.prodname_codespaces %} runs the `devcontainer.json` file. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." -- Your Docker container, `docker-compose`, or other initialization is run. -- At this point, the codespace is marked as available and you can connect. -- Once the codespace is made available, depending on the commands in the devcontainer, the codespace will continue with some set up. - - The codespace shares ports added in the `devcontainer.json` file. - - The codespace runs anything specified in `postCreateCommand`. - - {% data variables.product.prodname_codespaces %} clones your dotfiles repository to the codespaces environment and looks for an install file. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - - Finally, the codespace does a full clone of the repo so you have full access to it. - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### Creating a codespace - -{% data reusables.repositories.navigate-to-repo %} -2. Under the repository name, use the "Branch" drop-down menu, and select the branch you want to create a codespace for. - - ![Branch drop-down menu](/assets/images/help/codespaces/branch-drop-down.png) - -3. Under the repository name, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. To create a codespace using a Standard machine type, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index e6784b3775..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Deleting a codespace -intro: You can delete a codespace you no longer need. -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. Navigate to the repository where you created the codespace. Select **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** and then click {% octicon "gear" aria-label="The Settings gear" %}. This will display all {% data variables.product.prodname_codespaces %} that you have created in the repository. ![Codespaces tab](/assets/images/help/codespaces/codespaces-manage.png) - - Alternatively, you can see every codespace owned by your user account at [github.com/codespaces](https://github.com/codespaces). - -2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete** ![Delete button](/assets/images/help/codespaces/delete-codespace.png) - -### Deleting a codespace in {% data variables.product.prodname_vscode %} - -For information on deleting a codespace in {% data variables.product.prodname_vscode %}, see "[Using Codespaces in Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)." diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index a3ae678e34..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Developing in a codespace -intro: 'You can open a codespace on {% data variables.product.product_name %}, then develop using {% data variables.product.prodname_vscode %}''s features.' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About development with {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} - -![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. Side Bar - By default, this area shows your project files in the Explorer. -2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. -3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it. -4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. -5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. - -For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." - -#### Personalizing your codespace - -{% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)." - -{% data reusables.codespaces.apply-devcontainer-changes %} For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." - -#### Running your app from a codespace -{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." - -#### Committing your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Navigating to an existing codespace - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. Click the name of the codespace you want to develop in. ![Name of codespace](/assets/images/help/codespaces/click-name-codespace.png) - -Alternatively, you can see any active codespaces for a repository by navigating to the repository in which it was made and selecting **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**. diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index 7965bfc793..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Forwarding ports in your codespace -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About forwarded ports - -Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on port 4000, you can access the application from your browser to test and debug the application. - -When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards the port. You can click on the URL in the terminal to open the port in a browser. For example, if an application outputs `http://127.0.0.1:4000` or `http://localhost:4000` to the console, the log would automatically convert the output to a clickable URL for port 4000. - -![Automatic port forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) - -You can also forward a port manually, label forwarded ports, share fowarded ports publicly, and add forwarded ports to the codespace configuration. - -### Forwarding a port - -You can manually forward a port that wasn't forwarded automatically. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Under the list of ports, click **Add port**. ![Add port button](/assets/images/help/codespaces/add-port-button.png) -1. Type the port number or address, then press enter. ![Text box to type port button](/assets/images/help/codespaces/port-number-text-box.png) - -### Labeling a port - -You can label a port to make the port more easily identifiable in a list. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Hover over the port you want to label, then click the label icon. ![Label icon for port](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### Sharing a port - -If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to share, then click **Make Public**. ![Option to make port public in right-click menu](/assets/images/help/codespaces/make-public-option.png) -1. To the right of the local address for the port, click the copy icon. ![Copy icon for port URL](/assets/images/help/codespaces/copy-icon-port-url.png) -1. Send the copied URL to the person you want to share the port with. - -### Adding a port to the codespace configuration - -You can add a forwarded port to the {% data variables.product.prodname_codespaces %} configuration for the repository, so the port will automatically be forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -You can manually configure fowarded ports in a `.devcontainer.json` file using the `forwardPorts` property, or you can use the "Ports" panel in your codespace. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to add to the codespace configuration, then click **Set Label and Update devcontainer.json**. ![Option to set label and add port to devcontainer.json in the right-click menu](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/index.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index 555995eabc..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Developing in a codespace -intro: 'Create a codespace to get started with developing your project inside a dedicated cloud environment. You can use forwarded ports to run your application and even use codespaces inside {% data variables.product.prodname_vscode %}' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index f9d0fa00c3..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Using Codespaces in Visual Studio Code -intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 빌드전 요구 사양 - -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. - -Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation. - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Click **Sign in to view {% data variables.product.prodname_dotcom %}...**. ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. -4. Sign in to {% data variables.product.product_name %} to approve the extension. - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**. ![The {% data variables.product.prodname_codespaces %} header](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**. ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. -5. Sign in to {% data variables.product.product_name %} to approve the extension. - -{% endwindows %} - -### Creating a codespace in {% data variables.product.prodname_vscode %} - -After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_github_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Click the Add icon, then click **Create New Codespace**. ![The Create new Codespace option in {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/create-codespace-vscode.png) -3. Type, then click the repository's name you want to develop in. ![Searching for repository to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-repository-vscode.png) -4. Click the branch you want to develop on. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Click the machine type you want to develop in. ![Instance types for a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-sku-vscode.png) -### Opening a codespace in {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Under "Codespaces", click the codespace you want to develop in. -3. Click the Connect to Codespace icon. ![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### Changing the machine type in {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.codespaces-machine-types %} - -You can change the machine type of your codespace at any time. - -1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). -2. Search for and select "Codespaces: Change Machine Type." ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Click the codespace that you want to change. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Choose the machine type you want to use. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. - -### Deleting a codespace in {% data variables.product.prodname_vscode %} - -1. Under "Codespaces", right-click the codespace you want to delete. -2. In the drop-down menu, click **Delete Codespace**. ![Deleting a codespace in {% data variables.product.prodname_dotcom %}](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/ko-KR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/ko-KR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index 1ef48ef4f9..0000000000 --- a/translations/ko-KR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Using source control in your codespace -intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository. -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About source control in {% data variables.product.prodname_codespaces %} - -You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. - -Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." - -A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: - -* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." -* In your codespace, create a new branch to work on. -* Make your changes and save them. -* Commit the change. -* Raise a pull request. - -### Creating or switching branches - -1. If the current branch is not shown in the status bar, at the bottom of your codespace, right-click the status bar and select **Source control**. -1. Click the branch name in the status bar. ![The branch in the status bar](/assets/images/help/codespaces/branch-in-status-bar.png) -1. In the drop-down, either click the branch you want to switch to, or enter the name for a new branch and click **Create new branch**. ![Choose from the branch menu](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. - -{% endtip %} - -### Pulling changes from the remote repository - -You can pull changes from the remote repository into your codespace at any time. - -{% data reusables.codespaces.source-control-display-dark %} -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. In the drop-down menu, click **Pull**. - -If a dev container has been changed since you created the codespace you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -### Setting your codespace to automatically fetch new changes - -You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. - -If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. - -1. Click the **Manage** button at the bottom of the Activity Bar. ![Manage button](/assets/images/help/codespaces/manage-button.png) -1. In the menu, slick **Settings**. -1. On the Settings page, search for: `autofetch`. ![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) -1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. ![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) -1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. - -### Committing your changes - -{% data reusables.codespaces.source-control-display-dark %} -1. To stage your changes, click **+** next to the file you've changed, or next to **Changes** if you've changed multiple files and you want to stage them all. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. Type a commit message describing the change you've made. ![Source control side bar with a commit message](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. To commit your staged changes, click the check mark at the top the source control side bar. ![Click the check mark icon](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### Raising a pull request - -1. After you've committed changes to your local copy of the repository, click the **Create Pull Request** icon. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. Click **Create**. - -### Pushing changes to your remote repository - -You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. - -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. In the drop-down menu, click **Push**. diff --git a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index 762b944b79..0000000000 --- a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Getting started with your C# (.NET) project in Codespaces -shortTitle: Getting started with your C# (.NET) project -allowTitleToDifferFromFilename: true -intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 빌드전 요구 사양 - -- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project ](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. Click the recommended version of .NET. ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the .NET Core version that we want to use. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Dockerfile - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "dotnet restore", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - - ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via pip3. With our dependencies now installed, we can run our application. - -1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 다음 단계 - -You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index 2416d6abaa..0000000000 --- a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: Getting started with your Java project in Codespaces -shortTitle: Getting started with your Java project -intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 빌드전 요구 사양 - -- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Click the recommended version of Java. ![Java version selection](/assets/images/help/codespaces/add-java-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Dockerfile - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`. - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm. - -1. Run your application by pressing `F5`. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 다음 단계 - -You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index 8843fe5e05..0000000000 --- a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Getting started with your Node.js project in Codespaces -shortTitle: Getting started with your Node.js project -intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 빌드전 요구 사양 - -- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Click the recommended version of Node.js. ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Dockerfile - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the {% data variables.product.prodname_vscode %} docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm. - -1. Run your start command in the terminal with`npm start`. - - ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 다음 단계 - -You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index 7af44493d7..0000000000 --- a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Getting started with your Python project in Codespaces -shortTitle: Getting started with your Python project -intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### 빌드전 요구 사양 - -- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgresSQL. ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Click the recommended version of Python. ![Python version selection](/assets/images/help/codespaces/add-python-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Dockerfile - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - - ![Extensions list](/assets/images/help/codespaces/python-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. - -1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 다음 단계 - -You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/index.md b/translations/ko-KR/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index 396851c0bb..0000000000 --- a/translations/ko-KR/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Getting Started with {% data variables.product.prodname_codespaces %}' -intro: 'Learn how to get started with {% data variables.product.prodname_codespaces %}, including set up and configuration for specific languages.' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ko-KR/content/codespaces/guides.md b/translations/ko-KR/content/codespaces/guides.md deleted file mode 100644 index 9a56c01990..0000000000 --- a/translations/ko-KR/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Codespaces guides -shortTitle: 안내서 -intro: 'Learn how to make the most of GitHub {% data reusables.gated-features.codespaces %}' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/ko-KR/content/codespaces/index.md b/translations/ko-KR/content/codespaces/index.md deleted file mode 100644 index d7c9926f2c..0000000000 --- a/translations/ko-KR/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GitHub Codespaces Documentation -beta_product: true -shortTitle: GitHub Codespaces -intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.' -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index 7d7055b862..0000000000 --- a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Managing Codespaces for your organization -intro: 'You can manange and review how users in your organization can use {% data variables.product.prodname_github_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index f3d0f9eb29..0000000000 --- a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Managing access and security for your organization's codespaces -shortTitle: Managing access and security for your organization -intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Organization owners can manage which repositories a codespace can access. - -By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read and write permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust. - -To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "Access and security", select the setting you want for your organization. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index 7f5cb98c71..0000000000 --- a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Managing encrypted secrets for your repository and organization for Codespaces -shortTitle: Managing secrets for your repository and organization -intro: 'Encrypted secrets allow you to store sensitive information in your organization, repository, or {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### About secrets - -Secrets are encrypted environment variables that you create in an organization or repository. The secrets that you create are available to use in {% data variables.product.prodname_codespaces %}. GitHub uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before they reach GitHub and only decrypts them when you use them in a codespace. - -Organization-level secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. - - {% data reusables.codespaces.secret-precedence %} - -#### Limits for secrets - -You can store up to 100 secrets per organization and 100 secrets per repository. - -Secrets are limited to 64 KB in size. - -### Adding secrets for a repository - -To create secrets for an organization repository, you must have administrator access. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. At the top of the page, click **New repository secret**. -1. Type a name for your secret in the **Name** input box. -1. Enter the value for your secret. -1. Click **Add secret**. - -### Adding secrets for an organization - -When creating a secret in an organization, you can use a policy to limit which repositories can access that secret. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories. - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. At the top of the page, click **New organization secret**. -1. Type a name for your secret in the **Name** input box. -1. Enter the **Value** for your secret. -1. From the **Repository access** dropdown list, choose an access policy. ![Repository Access list with private repositories selected](/assets/images/help/codespaces/secret-repository-access.png) -1. Click **Add secret**. - -### Reviewing access to organization-level secrets - -You can check which access policies are applied to a secret in your organization. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. The list of secrets includes any configured permissions and policies. 예시: ![Secrets list](/assets/images/help/settings/actions-org-secrets-list.png) -1. For more details on the configured permissions for each secret, click **Update**. diff --git a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index f8c2c9ac71..0000000000 --- a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Managing user permissions for your organization -intro: You can control which users in your organization can use {% data variables.product.prodname_codespaces %}. -permissions: To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner. -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### About user permissions for {% data variables.product.prodname_codespaces %} - -Organization owners can control which users in your organization can create and use codespaces. - -To use codespaces in your organization, your users must have at least write access to the repositories where they want to use a codespace. You can enable codespaces for all users in your organization, or only specific users. - -By default, a codespace can only access the repository where it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -### Configuring which users in your organization can use {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select one of the following options: - - * **Disabled** to not allow any organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - - ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index c438a70311..0000000000 --- a/translations/ko-KR/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Reviewing your organization's audit logs for Codespaces -shortTitle: Reviewing your organization's audit logs -intro: 'You can use the audit log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -When any member of your organization performs an action related to {% data variables.product.prodname_codespaces %}, you can review the actions in the audit log. For information about accessing the log, see "[Reviewing your audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)." - -![Audit log with Codespaces information](/assets/images/help/settings/codespaces-audit-log-org.png) - -The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)." diff --git a/translations/ko-KR/content/codespaces/managing-your-codespaces/index.md b/translations/ko-KR/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 142e6c292d..0000000000 --- a/translations/ko-KR/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing your codespaces -intro: 'You can use {% data variables.product.prodname_github_codespaces %} settings to manage information that your codespace might need.' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index 44504fbaa6..0000000000 --- a/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing access and security for your codespaces -intro: You can manage the repositories that {% data variables.product.prodname_codespaces %} can access. -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read and write permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Access and security", select the setting you want for your user account. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index 6ad3cdee4a..0000000000 --- a/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Managing encrypted secrets for your codespaces -intro: 'You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### About encrypted secrets for {% data variables.product.prodname_codespaces %} - -You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. - -- Personal access tokens to cloud services -- Service principals -- Subscription identifiers -- [Credentials for a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository. - - {% data reusables.codespaces.secret-precedence %} - -#### Limits for secrets - -You can store up to 100 secrets for {% data variables.product.prodname_codespaces %}. - -Secrets are limited to 64 KB in size. - -### Adding a secret - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. To the right of "Codespaces secrets", click **New secret**. !["New secret" button](/assets/images/help/settings/codespaces-new-secret-button.png) -1. Under "Name", type a name for your secret. !["Name" text box](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Click **Add secret**. - -### Editing a secret - -You can update the value of an existing secret, and you can change which repositories can access a secret. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Codespaces secrets", to the right of the secret you want to edit, click **Update**. !["Update" button](/assets/images/help/settings/codespaces-secret-update-button.png) -1. Under "Value", click **enter a new value**. !["enter a new value" link](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Optionally, to remove the secret's access to a repository, deselect the repository. ![Checkboxes to remove access to repositories](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. Click **Save changes**. - -### Deleting a secret - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Codespaces secrets", to the right of the secret you want to delete, click **Delete**. !["Delete" button](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. Read the warning, then click **OK**. ![Confirmation to delete secret](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index c9492f1760..0000000000 --- a/translations/ko-KR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Managing GPG verification for Codespaces -intro: 'You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "GPG verification", select the setting you want for GPG verification. ![Radio buttons to manage GPG verification](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository you want enable GPG verification for. Repeat for all repositories you want to enable GPG verification for. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/ko-KR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/ko-KR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index f7e213e258..0000000000 --- a/translations/ko-KR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Reviewing your security logs for Codespaces -shortTitle: Reviewing your security logs -intro: 'You can use the security log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### About security logs for {% data variables.product.prodname_codespaces %} - -When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your user account, you can review the actions in the security log. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." - -![security log with Codespaces information](/assets/images/help/settings/codespaces-audit-log.png) - -The security log includes details on what action occured and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". diff --git a/translations/ko-KR/content/codespaces/quickstart.md b/translations/ko-KR/content/codespaces/quickstart.md deleted file mode 100644 index aa93c46407..0000000000 --- a/translations/ko-KR/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Quickstart for GitHub Codespaces -intro: 'Try out {% data variables.product.prodname_codespaces %} in 5 minutes or less.' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -In this guide, you'll create a codespace from the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces) and explore some of the essential features available to you within the codespace. - -The following example shows you how to create a codespace, connect to a forwarded port to view your running application, and personalize your setup with additional extensions and dotfiles. - -### Creating your codespace - -1. Navigate to the main page of the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces). - -2. Under the repository name, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. To create a codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -### Run the application - -With your project open in a codespace, you can now run the application and launch it in a browser. - -1. Start the application by entering `npm run dev` in the terminal. This command executes the `dev` script in the package.json file and starts up the web application defined in the sample repository. - - ![npm run dev in terminal](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. Click **Open in Browser** to view your running application in a new tab. - -### Personalize with a theme extension - -Within a codespace, you have access to the Visual Studio Code Marketplace. For this example, you'll install an extension that alters the theme but you can install any extension that is useful for your workflow. - -1. In the left sidebar, click the Extensions icon. - -2. In the search bar, enter `fairyfloss` and install the fairyfloss extension. - - ![Add an extension](/assets/images/help/codespaces/add-extension.png) - -3. Select the `fairyfloss` theme by selecting it from the list. - - ![Select the fairyfloss theme](/assets/images/help/codespaces/fairyfloss.png) - -4. Changes you make to your editor setup in the current codespace, such as theme and keyboard bindings, are synced automatically to other codespaces via [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). - -### Personalize with dotfiles - -If your user account on GitHub owns a public repository named dotfiles, GitHub automatically uses this repository to personalize your codespace environment during codespace creation. - -This example guides you through creating a dotfiles repository for your codespaces. - -1. Navigate to the sample [dotfiles repository](https://github.com/aw-test-93/dotfiles/). - -2. Fork the repository to your account and ensure it's public. - - Verify the repository created under your account is named dotfiles, for example `yourname/dotfiles`. Any other name will cause {% data variables.product.prodname_codespaces %} to ignore the repository for personalization. - -3. Create a new codespace from the [sample application repository](https://github.com/2percentsilk/haikus-for-codespaces) as dotfile updates are only applied at creation time. The sample dotfiles will change the command prompt to bold purple and blue text. - - ![Custom command prompt](/assets/images/help/codespaces/custom-prompt.png) - -### Next Steps - -You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_codespaces %}. - - "[Getting Started guides](/codespaces/getting-started-with-codespaces)" for using {% data variables.product.prodname_codespaces %} with specific languages - - [Create a custom configuration](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project) to configure {% data variables.product.prodname_codespaces %} for your project. diff --git a/translations/ko-KR/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/ko-KR/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index 37ebec2c4c..0000000000 --- a/translations/ko-KR/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: Configuring Codespaces for your project -intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About dev containers - -A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. When working with a dev container in {% data variables.product.prodname_codespaces %} you can either [use the default configuration](#using-the-default-configuration), [use a pre-defined configuration](#using-a-pre-defined-container-configuration), or [create your own configuration](#creating-a-custom-codespace-configuration). The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. - -{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. - -For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. - -#### Dockerfile - -A Dockerfile also lives in the `.devcontainer` folder. - -You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -You can use the `RUN` instruction to install any software and `&&` to join commands. - -Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. - -### Using the default configuration - -If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace with a base Linux image. The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. - -Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. - -The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. - - -### Using a predefined container configuration - -Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. - -Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. - -1. To access the command palette, in the upper-left corner, select the Application Menu and click **Command Palette…** from the **View** menu, then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. Click the definition you want to use. ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. Follow the prompts to customize your definition. -1. Click **OK**. ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) - - -### Creating a custom codespace configuration - -If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} - -In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. - -{% data reusables.codespaces.vscode-settings-order %} - -You can define default editor settings for {% data variables.product.prodname_vscode %} in two places. - -* Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace. -* Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace. - -After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." - - - - -### Applying changes to your configuration - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %} -!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) - - To diagnose the error by reviewing the creation logs, click **View creation log**. - - To fix the errors identified in the logs, update your `devcontainer.json` file. - - To apply the changes, rebuild your container. {% data reusables.codespaces.rebuild-command %} diff --git a/translations/ko-KR/content/codespaces/setting-up-your-codespace/index.md b/translations/ko-KR/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index f47cc82ec3..0000000000 --- a/translations/ko-KR/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Setting up your codespace -intro: '{% data variables.product.prodname_codespaces %} is a dedicated environment for you. You can configure your codespace with a dev container to install your dependencies or you can add a dotfile to personalize the user settings.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ko-KR/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/ko-KR/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index 66cabd7dc4..0000000000 --- a/translations/ko-KR/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Personalizing Codespaces for your account -intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About personalizing {% data variables.product.prodname_codespaces %} - -When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces. - -- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}. -- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations. - -{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create. - -Project maintainers can also define a default configuration that applies to every codespace for a repository, created by anyone. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." - -### Settings Sync - -Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}. - -Settings Sync is on by default. To configure any settings, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is on**. From the dialog, you can choose to configure, show settings and data, or turn off Settings Sync. - -![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode %} documentation. - -### Dotfiles - -Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your `dotfiles` repository, see [GitHub does dotfiles](https://dotfiles.github.io/). - -If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named `dotfiles`, {% data variables.product.prodname_dotcom %} automatically uses this repository to personalize your codespace environment. Private `dotfiles` repositories are not currently supported. - -Your `dotfiles` repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make. - -When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your `dotfiles` repository to the codespace environment, and looks for one of the following files to set up the environment. - -* _install.sh_ -* _install_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. - -Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace. - -{% note %} - -**Note:** Currently, {% data variables.product.prodname_codespaces %} does not support personalizing the _User_ settings for the {% data variables.product.prodname_vscode %} editor with your `dotfiles` repository. You can set default _Workspace_ and _Remote [Codespaces]_ settings for a specific project in the project's repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)." - -{% endnote %} - -You can also configure settings for your user account to add encrypted secrets, enable GPG verification, and allow your codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." - -### 더 읽을거리 - -* "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/ko-KR/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/ko-KR/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index 8a1128db5e..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %} is free to use during the beta. When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage. diff --git a/translations/ko-KR/data/reusables/codespaces/about-configuration.md b/translations/ko-KR/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 398b2495a6..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -You can create a default codespace configuration for your repository that determines the environment of every new codespace anyone creates for that repository. The configuration defines a development container that can include frameworks, tools, extensions, and port forwarding. diff --git a/translations/ko-KR/data/reusables/codespaces/about-personalization.md b/translations/ko-KR/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index 958370ebd8..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -You can also use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. diff --git a/translations/ko-KR/data/reusables/codespaces/about-port-forwarding.md b/translations/ko-KR/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index 39b29dc4a0..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -You can forward ports in your codespace to test and debug your application. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/ko-KR/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index 8031bfb4af..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -After the {% data variables.product.prodname_codespaces %} configuration for a repository changes, you can apply the changes to an existing codespace by rebuilding the container for the codespace. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/beta-functionality-limited.md b/translations/ko-KR/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 25501d28f0..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -During the beta, functionality is limited. -- {% data reusables.codespaces.use-chrome %} -- Only a single size of codespace is available. -- Only Linux containers are supported. -- A codespace is not fully resumable. Processes that were running at the time the codespace was stopped will not be restarted. diff --git a/translations/ko-KR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/ko-KR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index 5e0618af02..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. In {% data variables.product.prodname_vscode %}, in the left sidebar, click the Remote Explorer icon. ![The Remote Explorer icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/codespace-config-order.md b/translations/ko-KR/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index e785e51c45..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -Your `dotfiles` personalization is applied before a repository's default codespace configuration. diff --git a/translations/ko-KR/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/ko-KR/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index 146beb47e8..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -Each codespace is associated with a specific branch of a repository. diff --git a/translations/ko-KR/data/reusables/codespaces/codespaces-are-personal.md b/translations/ko-KR/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index 771fe3f97c..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -Each codespace you create is only available to you. No one else can work in your codespace. diff --git a/translations/ko-KR/data/reusables/codespaces/codespaces-machine-types.md b/translations/ko-KR/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index 475114c1c5..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -You can run your codespace on a choice of three types of remote machine: Basic, Standard, or Premium. Each of these has a different level of resources and a different billing tier.{% note %} - -**Note:** {% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -Switching machine types gives you the flexibility to choose the most appropriate resources for your work. Certain tasks may require different machine types: - -* **Basic** for updating a file and raising a pull request -* **Standard** for editing a website -* **Premium** for high compute tasks such as data analysis diff --git a/translations/ko-KR/data/reusables/codespaces/committing-link-to-procedure.md b/translations/ko-KR/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 87bfa539ff..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding {% data variables.product.prodname_vscode %} extensions, will appear for all users. - -For information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)." \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/ko-KR/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index 40126da0da..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -You can create more than one codespace per repository or even per branch. However, each user account has a two-codespace limit during limited public beta. If you've reached the limit and want to create a new codespace, you must delete a codespace first. diff --git a/translations/ko-KR/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/ko-KR/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index 045387a57b..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -You can connect to your codespace directly from {% data variables.product.prodname_vscode %}. For more information, see "[Using Codespaces in {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)." diff --git a/translations/ko-KR/data/reusables/codespaces/devcontainer-location.md b/translations/ko-KR/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index 196fc006be..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -This file can be located in the root of the repository or in a folder called `.devcontainer`. If the file is located in the root of the repository, the filename must begin with a period: `.devcontainer.json`. diff --git a/translations/ko-KR/data/reusables/codespaces/navigate-to-codespaces.md b/translations/ko-KR/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index 4ba7c260e0..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. At the top of any page, click **Codespaces**. ![{% data variables.product.prodname_codespaces %} link in header](/assets/images/help/codespaces/header-link.png) diff --git a/translations/ko-KR/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/ko-KR/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index fed860897b..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In your codespace, under the text editor, click "Ports". ![Ports tab](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/ko-KR/data/reusables/codespaces/rebuild-command.md b/translations/ko-KR/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index ea9e45b032..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -Access the command palette (`shift command P` / `shift control P`), then start typing "Codespaces: Rebuild Container". Click **Codespaces: Rebuild Container**. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/recovery-mode.md b/translations/ko-KR/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index fa4e73d013..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -If changes to your codespace's configuration cause a container error, your codespace will run in recovery mode, and you will see an error message. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/release-stage.md b/translations/ko-KR/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 57e551dd72..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** {% data variables.product.prodname_codespaces %} is currently in limited public beta and subject to change. For more information about joining the beta, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)." - -{% endnote %} diff --git a/translations/ko-KR/data/reusables/codespaces/secret-precedence.md b/translations/ko-KR/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index 582b91c1aa..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/secrets-naming.md b/translations/ko-KR/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index eddb8aa7f5..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -The following rules apply to secret names: - -* Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. -* Secret names must not start with the `GITHUB_` prefix. -* Secret names must not start with a number. -* Secret names are not case-sensitive. -* Secret names must be unique at the level they are created at. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/secrets-on-start.md b/translations/ko-KR/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index c4a5bf3b41..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to suspend the codespace and resume it. \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/source-control-display-dark.md b/translations/ko-KR/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index 90b3503dcd..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. ![Source control view](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/source-control-display.md b/translations/ko-KR/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index 09917cd3c8..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. - - ![Source control view](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/type-port-label.md b/translations/ko-KR/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index 498c9eb752..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. Type a label for your port, then press enter. ![Text box to type label for port](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/codespaces/unsupported-repos.md b/translations/ko-KR/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index 03fd9189d9..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -During the beta, private repositories owned by organizations or any repositories owned by an organization that requires SAML single sign-on are not supported. diff --git a/translations/ko-KR/data/reusables/codespaces/use-chrome.md b/translations/ko-KR/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index c44bb64faf..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -For the best experience with {% data variables.product.prodname_codespaces %}, we recommend using a Chromium-based browser, like Google Chrome or Microsoft Edge. diff --git a/translations/ko-KR/data/reusables/codespaces/use-visual-studio-features.md b/translations/ko-KR/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index a5b1cf9151..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -You can edit code, debug, and use Git commands while developing in a codespace with {% data variables.product.prodname_vscode %}. For more information, see the [{% data variables.product.prodname_vscode %} documentation](https://code.visualstudio.com/docs). diff --git a/translations/ko-KR/data/reusables/codespaces/vscode-settings-order.md b/translations/ko-KR/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index fc4b840129..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -When you configure editor settings for {% data variables.product.prodname_vscode %}, there are three scopes available: _Workspace_, _Remote [Codespaces]_, and _User_. If a setting is defined in multiple scopes, _Workspace_ settings take priority, then _Remote [Codespaces]_, then _User_. diff --git a/translations/ko-KR/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/ko-KR/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index afb626e71c..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -You can see every available codespace that you have created at [github.com/codespaces](https://github.com/codespaces). diff --git a/translations/ko-KR/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/ko-KR/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index a5e98437c0..0000000000 --- a/translations/ko-KR/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the top right corner of {% data variables.product.product_name %}, click your profile photo, then click **Your codespaces**. - - !['Your codespaces' menu option](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/gated-features/codespaces.md b/translations/ko-KR/data/reusables/gated-features/codespaces.md deleted file mode 100644 index 1423451c5e..0000000000 --- a/translations/ko-KR/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Codespaces is available for user accounts using {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/ko-KR/data/reusables/organizations/click-codespaces.md b/translations/ko-KR/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index 6a15dd7757..0000000000 --- a/translations/ko-KR/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. In the left sidebar, click **Codespaces**. !["Codespaces" tab in left sidebar](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/ko-KR/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/ko-KR/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index ae43f35c1f..0000000000 --- a/translations/ko-KR/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. Select the "Repository access" drop-down menu, then click a repository you want to have access to the secret. Repeat for every repository you want to have access to the secret. !["Repository access" drop-down menu](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/user_settings/codespaces-secret-value.md b/translations/ko-KR/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index 82cb0fbffe..0000000000 --- a/translations/ko-KR/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. Under "Value", type the value of your secret. !["Value" textbox](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/ko-KR/data/reusables/user_settings/codespaces-tab.md b/translations/ko-KR/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index e4908fcf75..0000000000 --- a/translations/ko-KR/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In the left sidebar, click **Codespaces**. ![Codespaces tab in the user settings sidebar](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/translations/pt-BR/content/codespaces/about-codespaces.md b/translations/pt-BR/content/codespaces/about-codespaces.md deleted file mode 100644 index 817bcd0fef..0000000000 --- a/translations/pt-BR/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Sobre os Codespaces -intro: '{% data variables.product.prodname_codespaces %} é um ambiente de desenvolvimento on-line configurável, hospedado por {% data variables.product.prodname_dotcom %} e alimentado por {% data variables.product.prodname_vscode %}, que permite que você se desenvolva inteiramente na nuvem.' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre o {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} é um ambiente de desenvolvimento da nuvem configurável disponível no seu navegador em {% data variables.product.prodname_dotcom %} ou por meio de {% data variables.product.prodname_vscode %}. - -![Um codespace aberto](/assets/images/help/codespaces/codespace-overview.png) - -Um codespace inclui tudo o que os desenvolvedores precisam desenvolver para um repositório específico, incluindo a {% data variables.product.prodname_vscode %} experiência de edição e linguagens comuns, ferramentas e utilitários. {% data variables.product.prodname_codespaces %} é completamente configurável, permite que você crie um ambiente de desenvolvimento personalizado para seu projeto, e também que os desenvolvedores personalizem sua experiência com extensões e configurações do dotfile. - -Os codespaces oferecem muitos benefícios para as equipes, o que permite um ambiente consistente em toda a sua equipe, integração rápida e criação de um espaço seguro para o desenvolvimento. - -### Um ambiente consistente - -É possível criar uma configuração de codespace único que define o ambiente (ou o _contêiner de desenvolvimento_) de cada novo código que qualquer pessoa criar para seu repositório. Uma vez definida uma configuração, os desenvolvedores não precisam se preocupar em instalar as ferramentas certas para comentar, revisar ou contribuir. Um ambiente padronizado já está disponível para eles assim que eles criam um codespace do repositório. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)". - -Para obter ajuda para começar com configurações para linguagens específicas, consulte os tutoriais de [introdução](/codespaces/getting-started-with-codespaces). - -Embora todos os códigos criados a partir do seu repositório possuam um ambiente de desenvolvimento consistente, os desenvolvedores podem usar {% data variables.product.prodname_codespaces %} onde quiserem – em {% data variables.product.prodname_dotcom %} ou por meio de {% data variables.product.prodname_vscode %}. - -### Integração rápida e pessoal - -Com um contêiner de desenvolvimento [](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configurado no seu repositório, todos os novos desenvolvedores podem integrar rapidamente com o ambiente de desenvolvimento correto para o seu projeto usando o menu suspenso {% octicon "download" aria-label="The download icon" %} **Code**e selecionando **Abrir com os codespaces**. - -![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -Como resultado da padronização em um ambiente de desenvolvedor reproduzível. Os desenvolvedores podem começar com um novo código sem fazer qualquer configuração manual e não precisam fazer a manutenção contínua do seu ambiente de desenvolvedores. É possível criar um novo codespace ao iniciar um novo recurso. - -Os desenvolvedores também podem personalizar aspectos do seu ambiente de código usando um [dotfiles](https://dotfiles.github.io/tutorials/) repositório e [sincronização de onfigurações](https://code.visualstudio.com/docs/editor/settings-sync). A personalização pode incluir preferências shell, ferramentas adicionais, configurações de editor e extensões, como Live Share. Personalizações pessoais são armazenadas por usuário. Portanto, cada código que um desenvolvedor abrir terá seu ambiente pronto para ser usado. Para obter mais informações, consulte "[Personalizar {% data variables.product.prodname_codespaces %} para sua conta](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)". - -Como {% data variables.product.prodname_codespaces %} pode ser acessado no navegador, os desenvolvedores podem trabalhar em vários projetos, alternando entre abas. - -### Um ambiente seguro - -{% data variables.product.prodname_codespaces %} permite que os desenvolvedores façam o desenvolvimento na nuvem em vez de no local. Isso cria uma fonte única e rastreável de verdade. Os desenvolvedores podem contribuir de qualquer lugar, em qualquer máquina, incluindo tablets ou Chromebooks, e não há necessidade de manter cópias locais da propriedade intelectual. Desenvolvedores sempre precisam estar conectados e ter acesso a {% data variables.product.prodname_codespaces %} e a repositórios específicos. Estas permissões podem ser revogadas a qualquer momento. Assim que você revogar o acesso, esses desenvolvedores perderão todo o acesso a recursos protegidos. Além disso, os desenvolvedores autenticados criam trilhas de auditoria para que você saiba quem está fazendo o quê. Para obter mais informações sobre acesso e segurança, consulte "[Gerenciar o acesso e a segurança para os códigos de sua organização](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". - -Usar {% data variables.product.prodname_codespaces %} é o mais seguro quando todos os integrantes da sua equipe o estão usando. Isso significa que não há necessidade de clonar o repositório para uma máquina local e que os desenvolvedores não precisam instalar localmente como `raiz`. - -Os desenvolvedores e administradores de organização também podem definir as configurações para adicionar segredos criptografados e habilitar a verificação GPG. Para obter mais informações, consulte "[Gerenciar segredos criptografados para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Gerenciar a verificação de GPG para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)". - -### Sobre a cobrança do {% data variables.product.prodname_codespaces %} - -{% data reusables.codespaces.about-billing-for-codespaces %} Para obter mais informações, consulte "[Sobre a cobrança do {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)". - -### Juntar-se ao beta - -Um número limitado de pessoas será convidado a participar do beta. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup). - -### Entre em contato conosco com relação a {% data variables.product.prodname_codespaces %} - -Se você tiver algum problema ao usar {% data variables.product.prodname_codespaces %}, consulte "[Solucionar problemas do seu codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)". - -Se você ainda precisa de ajuda ou tem feedback sobre {% data variables.product.prodname_codespaces %}, use a discussão de [Feedback para codespaces](https://github.com/github/feedback/discussions/categories/codespaces-feedback). diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/pt-BR/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index 2ade0c66f6..0000000000 --- a/translations/pt-BR/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Sobre a cobrança para codespaces -intro: 'Quando {% data variables.product.prodname_codespaces %} se torna geralmente disponível, você será cobrado para armazenamento e uso de computação.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -As atualizações do modelo de cobrança para codespaces serão compartilhadas em um próximo anúncio. diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index 2946135002..0000000000 --- a/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Permitir que seu codespace acesse um registro de imagens privadas -intro: 'Você pode usar segredos para permitir que {% data variables.product.prodname_codespaces %} acesse um registro de imagens privada' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Um registro é um espaço seguro para armazenar e gerenciar imagens de contêineres privadas, como Azure Container Registry ou DockerHub. Você pode criar segredos no GitHub para armazenar os detalhes de acesso de um registro privado e usá-los para dar ao seu código acesso as imagens armazenadas no registro. - -Ao iniciar iniciar um código, {% data variables.product.prodname_codespaces %} verifica três segredos, que definem o nome do servidor, o nome de usuário e o token de acesso pessoal (PAT) para um registro do contêiner. Se estes segredos forem encontrados, {% data variables.product.prodname_codespaces %} disponibilizará o registro dentro do seu codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -É possível armazenar segredos a nível do usuário, repositório ou organização, permitindo que você os compartilhe de forma segura entre diferentes codespaces. Ao criar um conjunto de segredos para um registro de imagem privado, você precisa substituir o "<*>" no nome por um identificador consistente. Para mais informações, consulte "[Gerenciar segredos criptografados para seus códigos](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" e "[Gerenciar segredos criptografados para seu repositório e organização para os codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)". - -Por exemplo, se você tiver um registro de imagens privadas no Azure, você poderá criar os seguintes segredos: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Exemplo de segredo do registro de imagem](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/index.md b/translations/pt-BR/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index e974c8ed9b..0000000000 --- a/translations/pt-BR/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Referência -intro: 'Esta seção contém referências que permitirão seu sucesso com {% data variables.product.prodname_codespaces %}' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry - - /using-the-command-palette-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/pt-BR/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index 3ca3eecf87..0000000000 --- a/translations/pt-BR/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Solucionar problemas do seu codespace -intro: Use este guia para ajudá-lo a resolver problemas comuns com seu codespace. -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Limitações conhecidas - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### Solução de problemas de {% data variables.product.prodname_vscode %} - -Use **Problemas** no [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) para verificar problemas conhecidos ou registrar problemas sobre a experiência de {% data variables.product.prodname_vscode %}. - - -### Solução de problemas de configuração - -{% data reusables.codespaces.recovery-mode %} - -``` -Este codespace está em execução em modo de recuperação devido a um erro no contêiner. -``` - -Revise os registros de criação, atualize a configuração conforme necessário e execute **Codespaces: Rebuild Container** na paleta de comandos para tentar novamente. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)". - -### solução de problemas dotfiles - -- Certifique-se de que seu repositório dotfiles seja público. Se você tem segredos ou dados confidenciais que você deseja usar em seu código, use [segredos de codespaces ](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) em vez dos dotfiles privados. -- Verifique `/workspaces/.codespaces/.persistedshare/dotfiles` para ver se seus dotfiles foram clonados. - - Se seus dotfiles foram clonados, tente reexecutar manualmente seu script de instalação para verificar se ele é executável. - - Se seus dotfiles não foram clonados, verifique `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` para ver se havia um problema com a clonagem. -- Verifique `/workspaces/.codespaces/.persistedshare/creation.log` com relação a possíveis problemas. Como alternativa, você pode ver o `creation.log` acessando a paleta de comandos e inserindo os **Codespaces: View Creation Log**. - - -### Solução de problemas do navegador - -Se você encontrar problemas ao usar um navegador que não se baseie no Chromium, tente alternar para um navegador baseado no Chromium ou verifique se há problemas conhecidos com seu navegador no repositório `microsoft/vscode` procurando por problemas etiquetados com o nome do seu navegador, como, por exemplo, [`fogo-fogo`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) ou [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari). - -Se você encontrar problemas ao usar um navegador baseado em Chromium, você poderá verificar se você está tendo outro problema conhecido com {% data variables.product.prodname_vscode %} no repositório [`microsoft/vscode`](https://github.com/microsoft/vscode/issues). - -### Solução de problemas de armazenamento do contêiner - -Ao criar um codespace, ele terá uma quantidade limitada de armazenamento e, após um tempo, poderá ser necessário que você libere espaço. Experimente qualquer um dos seguintes itens para liberar espaço de armazenamento. - -- Remova pacotes que não são mais usando `sudo apt autoremove` -- Limpe o cache apt usando `sudo apt clean` -- Exclua arquivos desnecessários, como artefatos de compilação e registros (estes são muito dependentes do projeto) -- Veja os 10 principais arquivos no codespace: `sudo find / -printf '%s %p\n'├sort -nr ├head -10` - -Mais opções para exclusão: -- Remova imagens não utilizadas do Docker, redes, e contêineres utilizando o `docker system prune` (insira `-a` se desejar remover todas as imagens, e `--volumes` se desejar remover todos os volumes) -- Remova os arquivos não rastreados da árvore de trabalho: `git clean -i` - -### Entrar em contato - -Se precisar de ajuda, você poderá entrar em contato conosco. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)." diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index 4056e6b0f5..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Criar um codespace -intro: Você pode criar um codespace para uma branch em um repositório para fazer o desenvolvimento on-line. -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre a criação do codespace - -Você pode criar um codespace em {% data variables.product.prodname_dotcom_the_website %} ou em {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %} - -Os codespaces são associados a um branch específico de um repositório e o repositório não pode estar vazio. {% data reusables.codespaces.concurrent-codespace-limit %} Para obter mais informações, consulte "[Excluir um codespace](/github/developing-online-with-codespaces/deleting-a-codespace)". - - -Ao criar um codespace, várias etapas acontecem para permitir o acesso total ao seu ambiente de desenvolvimento. - -- Recursos como uma VM e armazenamento para seu contêiner foram atribuídos. Uma nova VM é criada toda vez que você criar ou iniciar um codespace para garantir que você sempre tenha as versões mais recentes e patch de segurança. -- {% data variables.product.prodname_codespaces %} recebe informações sobre o seu repositório, branch, commits, seu repositório dotfiles público e quaisquer segredos que você tenha criado. -- {% data variables.product.prodname_codespaces %} executa um clone raso do repositório. -- Se você tiver um no seu repositório, {% data variables.product.prodname_codespaces %} irá executar o arquivo `devcontainer.json`. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)". -- Seu contêiner Docker, `docker-compose`, ou outra inicialização é executada. -- Neste ponto, o codespace está marcado como disponível e você pode conectar-se. -- Assim que o codespace for disponibilizado, dependendo dos comandos no devcontainer, o codespace continuará com algumas configurações. - - O codespace compartilha as portas adicionadas no arquivodevcontainer.json.`. -
  • O codespace executa qualquer coisa especificada em postCreateCommand`. - - {% data variables.product.prodname_codespaces %} clona o repositório do dotfiles no ambiente de código e procura um arquivo de instalação. Para obter mais informações, consulte "[Personalizar {% data variables.product.prodname_codespaces %} para sua conta](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)". - - Por fim, o código do repositório faz um clone completo para que você tenha acesso total ao mesmo. - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### Criar um codespace - -{% data reusables.repositories.navigate-to-repo %} -2. No nome do repositório, use o menu suspenso "Branch", e selecione o branch para o qual você deseja criar um codespace. - - ![Menu suspenso do branch](/assets/images/help/codespaces/branch-drop-down.png) - -3. No nome do repositório, use o menu suspenso do {% octicon "download" aria-label="The download icon" %} **Código** e selecione **Abrir com os espaços de código**. - - ![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. Para criar um codespace usando um tipo de máquina padrão, clique em {% octicon "plus" aria-label="The plus icon" %} **Novo codespace**. - - ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index b994587165..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Excluir um codespace -intro: Você pode excluir um codespace de que você não precisa mais. -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. Acesse o repositório onde você criou o codespace. Selecione **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** e, em seguida, clique em {% octicon "gear" aria-label="The Settings gear" %}. Isto irá exibir todo o {% data variables.product.prodname_codespaces %} que você criou no repositório. ![Aba Codespaces](/assets/images/help/codespaces/codespaces-manage.png) - - Como alternativa, você pode ver todos os códigos existentes na sua conta de usuário em [github.com/codespaces](https://github.com/codespaces). - -2. À direita do código que você deseja excluir, clique em {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, depois em **{% octicon "trash" aria-label="The trash icon" %} Apagar** ![Botão excluir](/assets/images/help/codespaces/delete-codespace.png) - -### Excluir um codespace em {% data variables.product.prodname_vscode %} - -Para obter informações sobre como excluir um codespace em {% data variables.product.prodname_vscode %}, consulte "[Usando codespaces no Visual Studio](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)". diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index c5794bd14d..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Desenvolver em um codespace -intro: 'Você pode abrir um codespace em {% data variables.product.product_name %} e, em seguida, desenvolver usando os recursos do {% data variables.product.prodname_vscode %}.' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre o desenvolvimento com {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} fornece a você a experiência completa de desenvolvimento de {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} - -![Visão geral do codespace com anotações](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. Barra lateral - Por padrão, esta área mostra os arquivos do seu projeto no Explorador. -2. Barra de Atividades - Exibe a visualização e fornece uma maneira de alternar entre elas. Você pode reordenar as Visualizações arrastando e soltando-as. -3. Editor - É aqui que você edita seus arquivos. Você pode usar a aba para cada editor para posicioná-lo exatamente onde você precisa. -4. Painéis - É aqui que você pode visualizar as informações de saída e depuração, bem como o local padrão para o Terminal integrado. -5. Barra de Status - Esta área fornece informações úteis sobre seu codespace e projeto. Por exemplo, o nome da agência, portas configuradas e muito mais. - -Para obter mais informações sobre como usar {% data variables.product.prodname_vscode %}, consulte o [Guia da Interface do Usuário](https://code.visualstudio.com/docs/getstarted/userinterface) na documentação de {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} Para obter mais informações, consulte "[Solucionar problemas do seu codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)". - -#### Personalizando seu codespace - -{% data reusables.codespaces.about-personalization %} Para obter mais informações, consulte "[Personalizar {% data variables.product.prodname_codespaces %} para sua conta](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)". - -{% data reusables.codespaces.apply-devcontainer-changes %} Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para o seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)". - -#### Executando seu aplicativo a partir de um codespace -{% data reusables.codespaces.about-port-forwarding %} Para obter mais informações, consulte "[Encaminhar portas no seu codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)". - -#### Fazendo commit das suas alterações - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Acessar um codespace existente - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. Clique no nome do codespace em que você deseja desenvolver. ![Nome do codespace](/assets/images/help/codespaces/click-name-codespace.png) - -Como alternativa, você pode ver quaisquer codespaces ativos para um repositório, acessando o repositório no qual ele foi criado e selecionando **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**. diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index aed71274fa..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Encaminhar portas no seu código -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre as portas encaminhadas - -O redirecionamento de porta dá acesso a portas TCP que estão em execução no seu codespace. Por exemplo, se você estiver executando um aplicativo web na porta 4000, você poderá acessá-lo a partir do seu navegador para testar e depurar o aplicativo. - -Quando um aplicativo que se executa dentro de um codespace tem uma saída na porta para o console, o {% data variables.product.prodname_codespaces %} detecta o padrão do URL do host local e encaminha a porta automaticamente. Você pode clicar na URL no terminal para abrir a porta em um navegador. Por exemplo, se um aplicativo gerar `http://127.0.0.:4000` ou `http://localhost:4000` para o console, o registro irá converter automaticamente a saída em uma URL para a porta 4000 em que se pode clicar. - -![Encaminhamento de porta automático](/assets/images/help/codespaces/automatic-port-forwarding.png) - -Você também pode encaminhar uma porta manualmente, etiquetar portas encaminhadas, compartilhar portas anunciadas publicamente e adicionar portas encaminhadas para a configuração do código. - -### Encaminhar uma porta - -Você pode encaminhar manualmente uma porta que não foi encaminhada automaticamente. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Na lista de portas, clique em **Adicionar porta**. ![Botão adicionar porta](/assets/images/help/codespaces/add-port-button.png) -1. Digite o número da porta ou endereço e, em seguida, pressione enter. ![Caixa de texto para o botão digitar porta](/assets/images/help/codespaces/port-number-text-box.png) - -### Etiquetar uma porta - -Você pode etiquetar uma porta para tornar a porta mais facilmente identificável em uma lista. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta. ![Ícone da etiqueta para a porta](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### Compartilhar uma porta - -Se você quiser compartilhar uma porta encaminhada com outras pessoas, você poderá tornar a porta pública. Após tornar uma porta pública, qualquer pessoa com a URL da porta poderá ver o aplicativo em execução sem precisar efetuar a autenticação. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Clique com o botão direito na porta que você deseja compartilhar e clique em **Tornar pública**. ![Opção para tornar a porta pública no menu com o clique com o botão direito](/assets/images/help/codespaces/make-public-option.png) -1. À direita do endereço local para a porta, clique no ícone copiar. ![Copiar ícone para o URL de porta](/assets/images/help/codespaces/copy-icon-port-url.png) -1. Envie a URL copiada para a pessoa com quem você deseja compartilhar a porta. - -### Adicionar uma porta à configuração do código - -É possível adicionar uma porta encaminhada para a configuração {% data variables.product.prodname_codespaces %} do repositório para que a porta seja automaticamente encaminhada para todos os códigos criados a partir do repositório. Depois de atualizar a configuração, todos os codespaces criados anteriormente deverão ser reconstruídos para que a alteração seja aplicada. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)". - -Você pode configurar manualmente as portas predefinidas em um arquivo `.devcontainer.json` usando a propriedade `forwardPorts`, ou você pode usar o painel "Portas" no seu codespace. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Clique com o botão direito na porta que você deseja adicionar à configuração do codespace e, em seguida, clique em **Definir etiqueta e atualizar devcontainer.json**. ![Opção para definir a etiqueta e adicionar a porta ao devcontainer.json no menu com o clique no botão direito](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/index.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index 81f828b37f..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Desenvolver em um codespace -intro: 'Crie um codespace para começar a desenvolver seu projeto dentro de um ambiente de nuvem dedicado. Você pode usar portas encaminhadas para executar o seu aplicativo e até mesmo usar codespaces dentro de {% data variables.product.prodname_vscode %}' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index 39324761fc..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Usar espaços de código no Visual Studio Code -intro: 'Você pode desenvolver seu codespace diretamente em {% data variables.product.prodname_vscode %}, conectando a extensão de {% data variables.product.prodname_github_codespaces %} à sua conta no {% data variables.product.product_name %}.' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Pré-requisitos - -Para desenvolver em um código diretamente em {% data variables.product.prodname_vscode %}, você deve inscrever-se na extensão de {% data variables.product.prodname_github_codespaces %}. A extensão de {% data variables.product.prodname_github_codespaces %} exige a versão de outubro de 2020 1.51 ou posterior de {% data variables.product.prodname_vscode %}. - -Use o {% data variables.product.prodname_vs %} Marketplace para instalar a extensão [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). Para obter mais informações, consulte [Extensão do Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) na documentação do {% data variables.product.prodname_vscode %}. - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Clique em **Iniciar sessão para visualizar {% data variables.product.prodname_dotcom %}...**. ![Registrar-se para visualizar {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. Para autorizar o {% data variables.product.prodname_vscode %} a acessar sua conta no {% data variables.product.product_name %}, clique em **Permitir**. -4. Registre-se e, {% data variables.product.product_name %} para aprovar a extensão. - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Utilize o menu suspenso "EXPLORADOR REMOTO" e clique em **{% data variables.product.prodname_github_codespaces %}**. ![Cabeçalho do {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. Clique em **Iniciar sessão para visualizar {% data variables.product.prodname_codespaces %}...**. ![Registrar-se para visualizar {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. Para autorizar o {% data variables.product.prodname_vscode %} a acessar sua conta no {% data variables.product.product_name %}, clique em **Permitir**. -5. Registre-se e, {% data variables.product.product_name %} para aprovar a extensão. - -{% endwindows %} - -### Criar um codespace em {% data variables.product.prodname_vscode %} - -Depois de conectar sua conta de {% data variables.product.product_name %} à extensão de {% data variables.product.prodname_github_codespaces %}, você pode desenvolver em um codespace que você criou no {% data variables.product.product_name %} ou em {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Clique no ícone Adicionar e, em seguida, clique em **Criar novo codespace**. ![A opção "Criar novo codespace" em {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/create-codespace-vscode.png) -3. Digite e, em seguida, clique no nome do repositório no qual você deseja desenvolver. ![Pesquisar um repositório para criar um novo {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-repository-vscode.png) -4. Clique no branch que você deseja desenvolver. ![Pesquisar um branch para criar um novo {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Clique no tipo de máquina na qual você deseja desenvolver. ![Tipos de instância para um novo {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-sku-vscode.png) -### Abrir um codespace em {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Em "Codedespaces", clique no código que você deseja desenvolver. -3. Clique no ícone Conectar-se ao Codespace. ![Ícone de conectar-se a um Codespace em {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### Alterar o tipo da máquina em {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.codespaces-machine-types %} - -Você pode alterar o tipo de máquina do seu codespace a qualquer momento. - -1. Em {% data variables.product.prodname_vscode %}, abra a Paleta de Comando (`shift comando P` / `shift control P`). -2. Pesquise e selecione "Codespaces: Alterar tipo de máquina." ![Pesquisar um branch para criar um novo {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Clique no codespace que você deseja alterar. ![Pesquisar um branch para criar um novo {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Escolha o tipo de máquina que você quer usar. ![Pesquisar um branch para criar um novo {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -Se o codespace estiver sendo executado, será exibida uma mensagem perguntando se você deseja reiniciar e reconectar-se ao seu codespace agora. Clique em **Sim** se desejar mudar o tipo de máquina utilizado para este codespace imediatamente. Se você clicar em **Não**, ou se o código não estiver em execução, a alteração entrará em vigor na próxima vez que o codespace for reiniciado. - -### Excluir um codespace em {% data variables.product.prodname_vscode %} - -1. Em "Codedespaces", clique com o botão direito no código que você deseja excluir. -2. No menu suspenso, clique em **Excluir o codespace**. ![Excluir um codespace em {% data variables.product.prodname_dotcom %}](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index e569ca38b1..0000000000 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Usando controle de origem no seu codespace -intro: 'Depois de fazer alterações em um arquivo no seu código, você pode fazer um commit rápido das alterações e fazer push da sua atualização para o repositório remoto.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre o controle de origem em {% data variables.product.prodname_codespaces %} - -Você pode executar todas as ações do Git necessárias diretamente no seu codespace. Por exemplo, é possível obter alterações do repositório remoto, alternar os branches, criar um novo branch, fazer commit, fazer push e criar um pull request. Você pode usar o terminal integrado dentro do seu codespace para inserir nos comandos do Git, ou você pode clicar em ícones e opções de menu para realizar todas as tarefas mais comuns do Git. Este guia explica como usar a interface gráfica de usuário para controle de origem. - -O controle de origem em {% data variables.product.prodname_github_codespaces %} usa o mesmo fluxo de trabalho que {% data variables.product.prodname_vscode %}. Para obter mais informações, consulte a documentação {% data variables.product.prodname_vscode %}"[Usando Controle de Versão no Código VS](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)". - -Um fluxo de trabalho típico para atualizar um arquivo que usa {% data variables.product.prodname_github_codespaces %} seria: - -* A partir do branch padrão do seu repositório em {% data variables.product.prodname_dotcom %}, crie um codespace. Consulte "[Criando um codespace](/codespaces/developing-in-codespaces/creating-a-codespace)". -* No seu código, crie uma nova agência para trabalhar. -* Faça suas alterações e salve-as. -* Faça commit da alteração. -* Abra um pull request. - -### Criar ou trocar de branches - -1. Se o branch atual não for mostrado na barra de status, na parte inferior do seu codespace, clique com o botão direito na barra de status e selecione **Controle de origem**. -1. Clique no nome do branch na barra de status. ![O branch na barra de status](/assets/images/help/codespaces/branch-in-status-bar.png) -1. No menu suspenso, clique no branch para o qual você deseja alternar ou digite o nome de um novo branch e clique em **Criar novo branch**. ![Escolha no menu do branch](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**Dica**: Se alguém alterou um arquivo no repositório remoto, no branch para o qual você mudou, você não verá essas alterações até você fazer pull das alterações no seu codespace. - -{% endtip %} - -### Fazer pull das alterações do repositório remoto - -Você pode fazer pull das alterações do repositório remoto para seu codespace a qualquer momento. - -{% data reusables.codespaces.source-control-display-dark %} -1. Na parte superior da barra lateral, clique na elipse (**...**). ![Botão Elipsis para visualizar e mais ações](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. No menu suspenso, clique em **Pull**. - -Se um contêiner de desenvolvimento foi alterado desde que você criou o codespace, você poderá aplicar as alterações reconstruindo o contêiner para o codespace. Para obter mais informações, consulte "[Configurar codespaces para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)". - -### Configurar o seu codespace para buscar novas alterações automaticamente - -É possível definir seu codespace para obter automaticamente os detalhes de quaisquer novos commits que tenham sido criados no repositório remoto. Isso permite que você veja se sua cópia local do repositório está desatualizada. Nesse caso, você pode optar por fazer pull das novas alterações. - -Se a operação de busca detectarem novas alterações no repositório remoto, você verá o número de novos commits na barra de status. Você pode fazer pull das alterações para a sua cópia local. - -1. Clique no botão **Gerenciar** na parte inferior da barra de atividades. ![Botão Gerenciar](/assets/images/help/codespaces/manage-button.png) -1. No menu, clique em **Configurações**. -1. Na página de configurações, pesquise por: `Autofetch`. ![Pesquisar por busca automática](/assets/images/help/codespaces/autofetch-search.png) -1. Para buscar os detalhes das atualizações para todos os controles remotos registrados no repositório atual, defina **Git: Autofetch** como `todos`. ![Habilite a busca automática do Git](/assets/images/help/codespaces/autofetch-all.png) -1. Se você deseja alterar o número de segundos entre cada busca automática, edite o valor de **Git: Período de Autofetch**. - -### Fazendo commit das suas alterações - -{% data reusables.codespaces.source-control-display-dark %} -1. Para testar suas alterações, clique **+** ao lado do arquivo que você alterou, ou ao lado de **Alterações** se você mudou vários arquivos e quiser testar todos. ![Barra lateral de controle de origem com botão de staging destacado](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. Digite uma mensagem do commit que descreve a alteração que você fez. ![Barra lateral do controle de origem com uma mensagem de commit](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. Para fazer commit das alterações em fase de preparação, clique na marca de seleção na parte superior da barra lateral de controle de origem. ![Clique no ícone da marca de verificação](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### Abrindo um pull request - -1. Depois de realizar alterações na sua cópia local do repositório, clique no ícone **Criar Pull Request**. ![Barra lateral de controle de origem com botão de staging destacado](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Verifique se o branch local e o repositório do qual você está fazendo merge, o branch remoto e o repositório no qual você está fazendo merge estão corretos. Em seguida, dê ao pull request um título e uma descrição. ![Barra lateral de controle de origem com botão de staging destacado](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. Clique em **Criar**. - -### Fazer push das alterações para o seu repositório remoto - -Você pode fazer push das alterações que fez. Isso aplica essas alterações ao branch upstream no repositório remoto. Você pode querer fazer isso se ainda não estiver pronto para criar um pull request, ou se você preferir criar um pull request em {% data variables.product.prodname_dotcom %}. - -1. Na parte superior da barra lateral, clique na elipse (**...**). ![Botão Elipsis para visualizar e mais ações](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. No menu suspenso, clique em **Push**. diff --git a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index c7498569a5..0000000000 --- a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Primeiros passos com o seu projeto C# (.NET) em codespaces -shortTitle: Primeiros passos com o seu projeto C# (.NET) -allowTitleToDifferFromFilename: true -intro: 'Primeiros passos com o seu projeto C# (.NET) em {% data variables.product.prodname_codespaces %} criando um contêiner de desenvolvimento personalizado.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introdução - -Este guia mostra como configurar seu projeto C# (.NET) em {% data variables.product.prodname_codespaces %}. Ele irá apresentar a você um exemplo de abertura de seu projeto em um codespace e adicionar e modificar uma configuração de contêiner de desenvolvimento a partir de um modelo. - -#### Pré-requisitos - -- Você deve ter um projeto C# (.NET) existente em um repositório em {% data variables.product.prodname_dotcom_the_website %}. Se você não tiver um projeto, você poderá tentar este tutorial com o seguinte exemplo: https://github.com/2percentsilk/dotnet-quickstart. -- Você precisa ter {% data variables.product.prodname_codespaces %} habilitado para a sua organização. - -### Etapa 1: Abra o seu projeto em um codespace - -1. Acesse o repositório do seu projeto. Use o menu suspenso {% octicon "download" aria-label="The download icon" %} **Código** e selecione **Abrir com Codespaces**. Se você não vir esta opção, seu projeto não está disponível para {% data variables.product.prodname_codespaces %}. - - ![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para criar um novo codespace, clique em {% octicon "plus" aria-label="The plus icon" %} **Novo codespace**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) - -Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. Por padrão, o contêiner para o seu codespace têm várias linguagens e tempos de execução, incluindo .NET. Ele também inclui um conjunto comum de ferramentas, como git, wget, rsync, openssh e nano. - -Você pode personalizar o seu codespace ajustando a quantidade de vCPUs e RAM, [adicionando dotfiles para personalizar seu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)ou modificando as ferramentas e scripts instalados. - -{% data variables.product.prodname_codespaces %} usa um arquivo denominado `devcontainer.json` para armazenar configurações. Ao iniciar, {% data variables.product.prodname_codespaces %} usa o arquivo para instalar quaisquer ferramentas, dependências ou outro conjunto que possa ser necessário para o projeto. Para obter mais informações, consulte "[Configurar codespaces para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -### Etapa 2: Adicione um contêiner de desenvolvimento ao seu codespace a partir de um modelo - -O contêiner de codespaces padrão vem com a versão mais recente do .NET e as ferramentas mais comuns pré-instaladas. No entanto, recomendamos que você configure um contêiner personalizado para que possa personalizar as ferramentas e scripts que são executados como parte da criação do codespace para as necessidades do seu projeto e garantir um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_codespaces %} no seu repositório. - -Para configurar seu projeto com um contêiner personalizado, você deverá usar um arquivo `devcontainer.json` para definir o ambiente. Em {% data variables.product.prodname_codespaces %}, você pode adicionar isto a partir de um modelo ou você pode criar o seu próprio. Para obter mais informações sobre contêineres de desenvolvimento, consulte "[Configurar codespaces para o seu projeto ](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -1. Acesse a paleta de comandos (`shift comando P` / `shift control P`) e, em seguida, comece a digitar "dev container". Clique em **Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento...** !["Codespaces: Adicionar arquivos de configuração de Contêiner de Desenvolvimento..." na paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. Para este exemplo, clique em **C# (.NET)**. Se você precisar de funcionalidades adicionais, você poderá selecionar qualquer contêiner específico para o C# (.NET) ou uma combinação de ferramentas como C# (.NET) e MS SQL. ![Selecione a opção C# (.NET) na lista](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. Clique na versão recomendada do .NET. ![Seleção da versão .NET](/assets/images/help/codespaces/add-dotnet-version.png) -4. Aceite a opção padrão para adicionar Node.js à sua personalização. ![Adicionar seleção de Node.js](/assets/images/help/codespaces/dotnet-options.png) -5. Para reconstruir seu contêiner, acesse a paleta de comandos (`shift command P` / `shift control P`) e, em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomia do seu contêiner de desenvolvimento - -A adição do modelo de contêiner de C# (.NET) adiciona uma pasta de contêiner de desenvolvimento `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - -- `devcontainer.json` -- arquivo Docker - -O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que são descritas após a amostra. - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. Mais informações: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Nome** - Você pode dar qualquer nome ao nosso contêiner de desenvolvimento. Este é apenas o padrão. -- **Build** - As propriedades de compilação. - - **Arquivo Docker** - No objeto de compilação, `arquivo Docker` é uma referência ao arquivo arquivo Docker que também foi adicionado a partir do template. - - **Args** - - **Variante**: Este arquivo contém apenas um argumento de compilação, que é a versão do .NET Core que queremos usar. -- **Configurações** - Estas são as configurações de {% data variables.product.prodname_vscode %}. - - **Terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. -- **Extensões** - Estas são extensões incluídas por padrão. - - **ms-dotnettools.csharp** - A extensão Microsoft C# fornece amplo suporte para o desenvolvimento em C#, incluindo funcionalidades como IntelliSense, links, depuração, navegação de código, formatação de código, refatoração, explorador de variáveis, explorador de testes e muito mais. -- **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. -- **postCreateCommand** - Se você quiser executar qualquer coisa depois de parar no seu codespace, isso não estará definido no arquivo Docker como a `Dotnet restore`. Você pode fazer isso aqui. -- **remoteUser** - Por padrão, você está executando como usuário do vscode, mas, opcionalmente, você pode definir isso como root. - -##### arquivo Docker - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do OS, versões de nó ou pacotes globais que queremos que sejam incluídos no nosso contêiner. - -### Etapa 3: Modifique seu arquivo devcontainer.json - -Com o seu contêiner de desenvolvimento adicionado e um entendimento básico do que tudo faz, agora você pode fazer alterações para configurá-lo para o seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e restaurar as dependências do seu projeto quando o seu codespace for iniciado. - -1. No Explorador, expanda a pasta `.devcontainer` e selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. - - !["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Atualize a sua lista de `extensões` no seu arquivo `devcontainer.json` para adicionar algumas extensões úteis ao trabalhar com o seu projeto. - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Remova o comentário o `postCreateCommand` para restaurar as dependências como parte do processo de configuração do codespace. - - ```json{:copy} - // Use 'postCreateCommand' para executar os comandos após a criação do contêiner. - "postCreateCommand": "dotnet restore", - ``` - -4. Para reconstruir seu contêiner e aplicar as alterações do devcontainer.json, acesse a paleta de comandos (`shift comando P` / `shift control P`). Em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. - - ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - - A reconstrução dentro do seu codespace garante que as suas alterações funcionem conforme o esperado antes de realizar o commit das alterações no repositório. Se algo falhar, você será colocado em um codespace com um contêiner de recuperação que você pode reconstruir para continuar ajustando o seu contêiner. - -5. Verifique se suas alterações foram aplicadas com sucesso verificando se a extensão "Code Spell Checker" foi instalada. - - ![Lista de extensões](/assets/images/help/codespaces/dotnet-extensions.png) - -### Etapa 4: Execute o seu aplicativo - -Na seção anterior, você usou o `postCreateCommand` para instalar um conjunto de pacotes via pip3. Com nossas dependências agora instaladas, podemos executar nosso aplicativo. - -1. Execute seu aplicativo pressionando `F5` ou inserindo `dotnet watch run` no seu terminal. - -2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa. - - ![Notificação de encaminhamento de porta](/assets/images/help/codespaces/python-port-forwarding.png) - -### Etapa 5: Faça commit das suas alterações - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Próximas etapas - -Agora você deve estar pronto para começar a desenvolver seu projeto C# (.NET) em {% data variables.product.prodname_codespaces %}. Aqui estão alguns recursos adicionais para cenários mais avançados. - -- [Gerenciar segredos criptografados para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Gerenciar a verificação de GPG para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Encaminhar portas no seu código](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index 40d9a18919..0000000000 --- a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: Primeiros passos com o seu projeto Java no Codespaces -shortTitle: Primeiros passos para seu projeto Java -intro: 'Dê os primeiros passos com o seu projeto Java em {% data variables.product.prodname_codespaces %} criando um contêiner de desenvolvimento personalizado.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introdução - -Este guia mostra como configurar seu projeto Java em {% data variables.product.prodname_codespaces %}. Ele irá apresentar a você um exemplo de abertura de seu projeto em um codespace e adicionar e modificar uma configuração de contêiner de desenvolvimento a partir de um modelo. - -#### Pré-requisitos - -- Você deve ter um projeto Java existente em um repositório em {% data variables.product.prodname_dotcom_the_website %}. Se você não tiver um projeto, você poderá tentar este tutorial com o seguinte exemplo: https://github.com/microsoft/vscode-remote-try-java -- Você precisa ter {% data variables.product.prodname_codespaces %} habilitado para a sua organização. - -### Etapa 1: Abra o seu projeto em um codespace - -1. Acesse o repositório do seu projeto. Use o menu suspenso {% octicon "download" aria-label="The download icon" %} **Código** e selecione **Abrir com Codespaces**. Se você não vir esta opção, seu projeto não está disponível para {% data variables.product.prodname_codespaces %}. - - ![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para criar um novo codespace, clique em {% octicon "plus" aria-label="The plus icon" %} **Novo codespace**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) - -Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. Por padrão, o contêiner do seu código possui muitas linguagens e tempos de execução, incluindo Java, nvm, npm e yarn. Ele também inclui um conjunto comum de ferramentas, como git, wget, rsync, openssh e nano. - -Você pode personalizar o seu codespace ajustando a quantidade de vCPUs e RAM, [adicionando dotfiles para personalizar seu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)ou modificando as ferramentas e scripts instalados. - -{% data variables.product.prodname_codespaces %} usa um arquivo denominado `devcontainer.json` para armazenar configurações. Ao iniciar, {% data variables.product.prodname_codespaces %} usa o arquivo para instalar quaisquer ferramentas, dependências ou outro conjunto que possa ser necessário para o projeto. Para obter mais informações, consulte "[Configurar codespaces para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -### Etapa 2: Adicione um contêiner de desenvolvimento ao seu codespace a partir de um modelo - -O contêiner de codespaces padrão vem com a versão mais recente do Java, gerenciadores de pacotes (Maven, Gradle) e outras ferramentas comuns pré-instaladas. No entanto, recomendamos que você configure um contêiner personalizado para definir as ferramentas e scripts de que seu projeto precisa. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_codespaces %} do seu repositório. - -Para configurar seu projeto com um contêiner personalizado, você deverá usar um arquivo `devcontainer.json` para definir o ambiente. Em {% data variables.product.prodname_codespaces %}, você pode adicionar isto a partir de um modelo ou você pode criar o seu próprio. Para obter mais informações sobre contêineres de desenvolvimento, consulte "[Configurar espaços de códigos para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -1. Acesse a paleta de comandos (`shift comando P` / `shift control P`) e, em seguida, comece a digitar "dev container". Clique em **Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento...** !["Codespaces: Adicionar arquivos de configuração de Contêiner de Desenvolvimento..." na paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. Para este exemplo, clique em **Java**. Na prática, você pode selecionar qualquer contêiner específico para Java ou uma combinação de ferramentas como Java e Azure Functions. ![Selecione a opção Java na lista](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Clique na versão recomendada do Java. ![Seleção da versão Java](/assets/images/help/codespaces/add-java-version.png) -5. Para reconstruir seu contêiner, acesse a paleta de comandos (`shift command P` / `shift control P`) e, em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomia do seu contêiner de desenvolvimento - -A adição do modelo de contêiner de desenvolvimento Java adiciona uma pasta `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - -- `devcontainer.json` -- arquivo Docker - -O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que são descritas após a amostra. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. Consulte https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Nome** - Você pode dar qualquer nome ao seu contêiner de desenvolvimento. Este é apenas o padrão. -- **Build** - As propriedades de compilação. - - **Arquivo Docker** - No objeto de compilação, o arquivo Docker é uma referência ao arquivo Docker que também foi adicionado a partir do template. - - **Args** - - **Variante**: Este arquivo contém apenas um argumento de compilação, que é a versão de Java que é passada para o arquivo Docker. -- **Configurações** - Estas são configurações de {% data variables.product.prodname_vscode %} que você pode definir. - - **Terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. -- **Extensões** - Estas são extensões incluídas por padrão. - - **Vscjava.vscode-java-pack** - O pacote de extensão Java fornece extensões populares para o desenvolvimento do Java para você começar. -- **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. -- **postCreateCommand** - Se você quiser executar qualquer coisa depois de chegar ao seu codespace que não está definido no arquivo Docker, você poderá fazer isso aqui. -- **remoteUser** - Por padrão, você está executando como usuário do `vscode`, mas, opcionalmente, você pode definir isso como `root`. - -##### arquivo Docker - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -Você pode usar o arquivo arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do sistema operacional, versões do Java ou pacotes globais que queremos que sejam incluídos no nosso arquivo Docker. - -### Etapa 3: Modifique seu arquivo devcontainer.json - -Com o seu contêiner de desenvolvimento adicionado e um entendimento básico do que tudo faz, agora você pode fazer alterações para configurá-lo para o seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. - -1. No Explorer, selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. Você pode ter que sair da pasta `.devcontainer` para vê-la. - - !["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Adicione as seguintes linhas ao seu arquivo `devcontainer.json` após as `extensões`. - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - Para obter mais informações sobre as propriedades `devcontainer.json`, consulte a [referência devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) na documentação do Visual Studio Code. - -3. Para reconstruir seu contêiner, acesse a paleta de comandos (`shift command P` / `shift control P`) e, em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. - - ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - - A reconstrução dentro do seu codespace garante que as suas alterações funcionem conforme o esperado antes de realizar o commit das alterações no repositório. Se algo falhar, você será colocado em um codespace com um contêiner de recuperação que você pode reconstruir para continuar ajustando o seu contêiner. - - -### Etapa 4: Execute o seu aplicativo - -Na seção anterior, você usou o `postCreateCommand` para instalar um conjunto de pacotes via npm. Agora você pode usar isso para executar nosso aplicativo com npm. - -1. Execute o seu aplicativo pressionando `F5`. - -2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa. - - ![Notificação de encaminhamento de porta](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Etapa 5: Faça commit das suas alterações - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Próximas etapas - -Agora você deve estar pronto para começar a desenvolver seu projeto Java em {% data variables.product.prodname_codespaces %}. Aqui estão alguns recursos adicionais para cenários mais avançados. - -- [Gerenciar segredos criptografados para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Gerenciar a verificação de GPG para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Encaminhar portas no seu código](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index 45f859a5eb..0000000000 --- a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Primeiros passos com o seu projeto Node.js em Codedespaces -shortTitle: Primeiros passos para o seu projeto Node.js -intro: 'Comece com seu projeto JavaScript, Node.js ou TypeScript em {% data variables.product.prodname_codespaces %} criando um contêiner de desenvolvimento personalizado.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### Introdução - -Este guia mostra como configurar seu projeto JavaScript, Node.js ou TypeScript em {% data variables.product.prodname_codespaces %}. Ele irá apresentar a você um exemplo de abertura de seu projeto em um codespace e adicionar e modificar uma configuração de contêiner de desenvolvimento a partir de um modelo. - -#### Pré-requisitos - -- Você deve ter um projeto existente de JavaScript, Node.js ou TypeScript em um repositório em {% data variables.product.prodname_dotcom_the_website %}. Se você não tiver um projeto, você poderá tentar este tutorial com o seguinte exemplo: https://github.com/microsoft/vscode-remote-try-node -- Você precisa ter {% data variables.product.prodname_codespaces %} habilitado para a sua organização. - -### Etapa 1: Abra o seu projeto em um codespace - -1. Acesse o repositório do seu projeto. Use o menu suspenso {% octicon "download" aria-label="The download icon" %} **Código** e selecione **Abrir com Codespaces**. Se você não vir esta opção, seu projeto não está disponível para {% data variables.product.prodname_codespaces %}. - - ![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para criar um novo codespace, clique em {% octicon "plus" aria-label="The plus icon" %} **Novo codespace**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) - -Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. Por padrão, o contêiner para o seu código possui muitas linguagens e tempos de execução, incluindo Node.js, JavaScript, Typescript, nvm, npm e yarn. Ele também inclui um conjunto comum de ferramentas, como git, wget, rsync, openssh e nano. - -Você pode personalizar o seu codespace ajustando a quantidade de vCPUs e RAM, [adicionando dotfiles para personalizar seu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)ou modificando as ferramentas e scripts instalados. - -{% data variables.product.prodname_codespaces %} usa um arquivo denominado `devcontainer.json` para armazenar configurações. Ao iniciar, {% data variables.product.prodname_codespaces %} usa o arquivo para instalar quaisquer ferramentas, dependências ou outro conjunto que possa ser necessário para o projeto. Para obter mais informações, consulte "[Configurar codespaces para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -### Etapa 2: Adicione um contêiner de desenvolvimento ao seu codespace a partir de um modelo - -O contêiner de codespaces padrão será compatível com a execução de projetos de Node.js como [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) fora da caixa. Ao configurar um contêiner personalizado, você poderá personalizar as ferramentas e scripts que são executados como parte da criação de código e garantir um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_codespaces %} no seu repositório. - -Para configurar seu projeto com um contêiner personalizado, você deverá usar um arquivo `devcontainer.json` para definir o ambiente. Em {% data variables.product.prodname_codespaces %}, você pode adicionar isto a partir de um modelo ou você pode criar o seu próprio. Para obter mais informações sobre contêineres de desenvolvimento, consulte "[Configurar codespaces para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -1. Acesse a paleta de comandos (`shift comando P` / `shift control P`) e, em seguida, comece a digitar "dev container". Clique em **Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento...** !["Codespaces: Adicionar arquivos de configuração de Contêiner de Desenvolvimento..." na paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. Para este exemplo, clique em **Node.js**. Se você precisar de funcionalidades adicionais, você poderá selecionar qualquer contêiner específico para o Node ou uma combinação de ferramentas como Node e MongoDB. ![Selecione a opção Node na lista](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Clique na versão recomendada do Node.js. ![Seleção de versão do Node.js](/assets/images/help/codespaces/add-node-version.png) -5. Para reconstruir seu contêiner, acesse a paleta de comandos (`shift command P` / `shift control P`) e, em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomia do seu contêiner de desenvolvimento - -A adição do modelo de contêiner de desenvolvimento do Node.js adiciona uma pasta `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - -- `devcontainer.json` -- arquivo Docker - -O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que são descritas após a amostra. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. Mais informações: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Nome** - Você pode dar qualquer nome ao seu contêiner de desenvolvimento. Este é apenas o padrão. -- **Build** - As propriedades de compilação. - - **Arquivo Docker** - No objeto de compilação, o arquivo Docker é uma referência ao arquivo Docker que também foi adicionado a partir do modelo. - - **Args** - - **Variante**: Este arquivo contém apenas um argumento de compilação, que é a variante de nó que queremos usar e que é passada para o arquivo Docker. -- **Configurações** - Estas são configurações de {% data variables.product.prodname_vscode %} que você pode definir. - - **Terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. -- **Extensões** - Estas são extensões incluídas por padrão. - - <**Dbaeumer.vscode-eslint** - ES lint é uma ótima extensão para linting, mas para o JavaScript, há uma série de ótimas extensões do Marketplace que você também pode incluir. -- **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. -- **postCreateCommand** - Se você quiser executar qualquer coisa depois de chegar ao seu codespace que não está definido no arquivo Docker, você poderá fazer isso aqui. -- **remoteUser** - Por padrão, você está executando como usuário do vscode, mas, opcionalmente, você pode definir isso como root. - -##### arquivo Docker - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do sistema operacional, versões de nó ou pacotes globais que queremos que sejam incluídos no nosso arquivo Docker. - -### Etapa 3: Modifique seu arquivo devcontainer.json - -Com o seu contêiner de desenvolvimento adicionado e um entendimento básico do que tudo faz, agora você pode fazer alterações para configurá-lo para o seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar o npm quando seu codespace for lançado e para fazer uma lista de portas dentro do contêiner disponível localmente. - -1. No Explorer, selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. Você pode ter que sair da pasta `.devcontainer` para vê-la. - - !["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Adicione as seguintes linhas ao seu arquivo `devcontainer.json` após as `extensões`: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - Para obter mais informações sobre as propriedades `devcontainer.json`, consulte a referência de [devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) na documentação de {% data variables.product.prodname_vscode %}. - -3. Para reconstruir seu contêiner, acesse a paleta de comandos (`shift command P` / `shift control P`) e, em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. - - ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - - A reconstrução dentro do seu codespace garante que as suas alterações funcionem conforme o esperado antes de realizar o commit das alterações no repositório. Se algo falhar, você será colocado em um codespace com um contêiner de recuperação que você pode reconstruir para continuar ajustando o seu contêiner. - - -### Etapa 4: Execute o seu aplicativo - -Na seção anterior, você usou o `postCreateCommand` para instalar um conjunto de pacotes via npm. Agora você pode usar isso para executar nosso aplicativo com npm. - -1. Execute seu comando inicial no terminal com`npm start`. - - ![início do npm no terminal](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa. - - ![Notificação de encaminhamento de porta](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Etapa 5: Faça commit das suas alterações - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Próximas etapas - -Agora você deve estar pronto para começar a desenvolver seu projeto JavaScript em {% data variables.product.prodname_codespaces %}. Aqui estão alguns recursos adicionais para cenários mais avançados. - -- [Gerenciar segredos criptografados para seus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [Gerenciar a verificação de GPG para {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [Encaminhar portas no seu código](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index b18e320ba7..0000000000 --- a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Primeiros passos para seu projeto Python no Codedespaces -shortTitle: Primeiros passos para seu projeto Python -intro: 'Dê os primeiros passos com seu projeto Python em {% data variables.product.prodname_codespaces %} criando um contêiner de desenvolvimento personalizado.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### Introdução - -Este guia mostra como configurar seu projeto Python em {% data variables.product.prodname_codespaces %}. Ele irá apresentar a você um exemplo de abertura de seu projeto em um codespace e adicionar e modificar uma configuração de contêiner de desenvolvimento a partir de um modelo. - -#### Pré-requisitos - -- Você deve ter um projeto Python existente em um repositório em {% data variables.product.prodname_dotcom_the_website %}. Se você não tiver um projeto, você poderá tentar este tutorial com o seguinte exemplo: https://github.com/2percentsilk/python-quickstart. -- Você precisa ter {% data variables.product.prodname_codespaces %} habilitado para a sua organização. - -### Etapa 1: Abra o seu projeto em um codespace - -1. Acesse o repositório do seu projeto. Use o menu suspenso {% octicon "download" aria-label="The download icon" %} **Código** e selecione **Abrir com Codespaces**. Se você não vir esta opção, seu projeto não está disponível para {% data variables.product.prodname_codespaces %}. - - ![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. Para criar um novo codespace, clique em {% octicon "plus" aria-label="The plus icon" %} **Novo codespace**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) - -Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. Por padrão, o contêiner para o seu código possui muitas linguagens e tempos de execução, incluindo Node.js, JavaScript, Typescript, nvm, npm e yarn. Ele também inclui um conjunto comum de ferramentas, como git, wget, rsync, openssh e nano. - -Você pode personalizar o seu codespace ajustando a quantidade de vCPUs e RAM, [adicionando dotfiles para personalizar seu ambiente](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)ou modificando as ferramentas e scripts instalados. - -{% data variables.product.prodname_codespaces %} usa um arquivo denominado `devcontainer.json` para armazenar configurações. Ao iniciar, {% data variables.product.prodname_codespaces %} usa o arquivo para instalar quaisquer ferramentas, dependências ou outro conjunto que possa ser necessário para o projeto. Para obter mais informações, consulte "[Configurar codespaces para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -### Etapa 2: Adicione um contêiner de desenvolvimento ao seu codespace a partir de um modelo - -O contêiner de códigos padrão vem com a versão mais recente do Python, gerenciadores de pacotes (pip, Miniconda) e outras ferramentas comuns pré-instaladas. No entanto, recomendamos que você configure um contêiner personalizado para definir as ferramentas e scripts de que seu projeto precisa. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_codespaces %} do seu repositório. - -Para configurar seu projeto com um contêiner personalizado, você deverá usar um arquivo `devcontainer.json` para definir o ambiente. Em {% data variables.product.prodname_codespaces %}, você pode adicionar isto a partir de um modelo ou você pode criar o seu próprio. Para obter mais informações sobre contêineres de desenvolvimento, consulte "[Configurar espaços de códigos para o seu projeto](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - - -1. Acesse a paleta de comandos (`shift comando P` / `shift control P`) e, em seguida, comece a digitar "dev container". Clique em **Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento...** !["Codespaces: Adicionar arquivos de configuração de Contêiner de Desenvolvimento..." na paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. Para este exemplo, clique em **Python 3**. Se precisar de funcionalidades adicionais, você poderá selecionar qualquer contêiner específico para Python ou uma combinação de ferramentas como Python 3 e PostgresSQL. ![Selecione a opção Python na lista](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Clique na versão recomendada do Python. ![Seleção de versão Python](/assets/images/help/codespaces/add-python-version.png) -4. Aceite a opção padrão para adicionar Node.js à sua personalização. ![Adicionar seleção de Node.js](/assets/images/help/codespaces/add-nodejs-selection.png) -5. Para reconstruir seu contêiner, acesse a paleta de comandos (`shift command P` / `shift control P`) e, em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomia do seu contêiner de desenvolvimento - -A adição do modelo de contêiner de desenvolvimento do Python adiciona uma pasta `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - -- `devcontainer.json` -- arquivo Docker - -O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que são descritas após a amostra. - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. Mais informações: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Nome** - Você pode dar qualquer nome ao nosso contêiner de desenvolvimento. Este é apenas o padrão. -- **Build** - As propriedades de compilação. - - **Arquivo Docker** - No objeto de compilação, `arquivo Docker` é uma referência ao arquivo arquivo Docker que também foi adicionado a partir do template. - - **Args** - - **Variante**: Este arquivo contém apenas um argumento de compilação, que é a variante de nó que queremos usar e que é passada para o arquivo Docker. -- **Configurações** - Estas são as configurações de {% data variables.product.prodname_vscode %}. - - **Terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. -- **Extensões** - Estas são extensões incluídas por padrão. - - **ms-python. ython** - A extensão Microsoft Python fornece um amplo suporte para a linguagem do Python (para todas as versões ativamente compatíveis da linguagem: >=3.), incluindo recursos como IntelliSense, linting, depuração, navegação de código, formatação de código, refatoração, explorador de variáveis, explorador de teste e muito mais. -- **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. -- **postCreateCommand** - Se você quiser executar qualquer coisa depois de pousar no seu codespace, isso não está definido no arquivo Docker como `pip3 install -r requirements`. Você pode fazer isso aqui. -- **remoteUser** - Por padrão, você está executando como usuário do `vscode`, mas, opcionalmente, você pode definir isso como `root`. - -##### arquivo Docker - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do OS, versões de nó ou pacotes globais que queremos que sejam incluídos no nosso contêiner. - -### Etapa 3: Modifique seu arquivo devcontainer.json - -Com o seu contêiner de desenvolvimento adicionado e um entendimento básico do que tudo faz, agora você pode fazer alterações para configurá-lo para o seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando o seu codespace for iniciado. - -1. No Explorador, expanda a pasta `.devcontainer` e selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. - - !["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/devcontainers-options.png) - -2. Atualize a lista de extensões `` no seu arquivo `devcontainer.json` para adicionar algumas extensões que são úteis ao trabalhar com seu projeto. - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Remova o comentário o `postCreateCommand` para instalar automaticamente os requisitos como parte do processo de configuração dos codespaces. - - ```json{:copy} - // Use 'postCreateCommand' para executar os comandos após a criação do contêiner. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. Para reconstruir seu contêiner e aplicar as alterações do devcontainer.json, acesse a paleta de comandos (`shift comando P` / `shift control P`). Em seguida, comece a digitar "recriar". Click **Codespaces: Rebuild Container**. - - ![Opção de reconstruir contêiner](/assets/images/help/codespaces/codespaces-rebuild.png) - - A reconstrução dentro do seu codespace garante que as suas alterações funcionem conforme o esperado antes de realizar o commit das alterações no repositório. Se algo falhar, você será colocado em um codespace com um contêiner de recuperação que você pode reconstruir para continuar ajustando o seu contêiner. - -5. Verifique se suas alterações foram aplicadas com sucesso verificando se as extensões Code Spell Checker e Flask Snippet foram instaladas. - - ![Lista de extensões](/assets/images/help/codespaces/python-extensions.png) - -### Etapa 4: Execute o seu aplicativo - -Na seção anterior, você usou o `postCreateCommand` para instalar um conjunto de pacotes via pip3. Com suas dependências agora instaladas, você pode executar seu aplicativo. - -1. Execute seu aplicativo pressionando `F5` ou digitando `python -m Flask run` no terminal do codespace. - -2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa. - - ![Notificação de encaminhamento de porta](/assets/images/help/codespaces/python-port-forwarding.png) - -### Etapa 5: Faça commit das suas alterações - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Próximas etapas - -Agora você deve estar pronto para começar a desenvolver seu projeto Python em {% data variables.product.prodname_codespaces %}. Aqui estão alguns recursos adicionais para cenários mais avançados. - -- [Gerenciar segredos criptografados para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Gerenciar a verificação de GPG para {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Encaminhar portas no seu código](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/index.md b/translations/pt-BR/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index b2758f02e6..0000000000 --- a/translations/pt-BR/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Primeiros passos com {% data variables.product.prodname_codespaces %}' -intro: 'Aprenda como dar os primeiros passos com {% data variables.product.prodname_codespaces %}, incluindo a configuração para linguagens específicas.' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/pt-BR/content/codespaces/guides.md b/translations/pt-BR/content/codespaces/guides.md deleted file mode 100644 index b636a380bc..0000000000 --- a/translations/pt-BR/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Guias de codespaces -shortTitle: Guias -intro: 'Aprenda a aproveitar ao máximo o GitHub {% data reusables.gated-features.codespaces %}' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/pt-BR/content/codespaces/index.md b/translations/pt-BR/content/codespaces/index.md deleted file mode 100644 index f116c2d0e6..0000000000 --- a/translations/pt-BR/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Documentação do GitHub Codespaces -beta_product: true -shortTitle: GitHub Codespaces -intro: 'Crie um codespace para começar a desenvolver em um ambiente seguro, configurável e dedicado de desenvolvimento que funcione como e onde você desejar.' -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index 1f1ff2585b..0000000000 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Gerenciando codespaces para a sua organização -intro: 'Você pode gerenciar e revisar como os usuários da sua organização podem usar {% data variables.product.prodname_github_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index 5fe3cf097a..0000000000 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Gerenciar os codespaces de acesso e segurança da sua organização -shortTitle: Gerenciar o acesso e a segurança da sua organização -intro: 'Você pode gerenciar os repositórios na sua organização que {% data variables.product.prodname_codespaces %} pode acessar.' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Os proprietários da organização podem gerenciar quais repositórios um codespace pode acessar. - -Por padrão, um codespace só pode acessar o repositório onde foi criado. Ao habilitar o acesso e a segurança de um repositório pertencente à sua organização, todos os codespaces que forem criados para esse repositório também terão permissões de leitura e gravação para todos os outros repositórios que a organização possui e o criador de codespace terá permissões para acessar. Se você deseja restringir os repositórios que um codespace pode acessar, você pode limitá-lo ao repositório em que o codespace foi criado ou a repositórios específicos. Você só deve habilitar o acesso e a segurança para repositórios nos quais confia. - -Para gerenciar quais usuários na sua organização podem usar {% data variables.product.prodname_codespaces %}, consulte "[Gerenciar permissões de usuário para a sua organização](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)". - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Em "Acesso e segurança", selecione a configuração que você deseja para a sua organização. ![Botões de opção para gerenciar repositórios confiáveis](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. Se você escolheu "repositórios selecionados", selecione o menu suspenso e, em seguida, clique em um repositório para permitir que os codespaces do repositório acessem outros repositórios pertencentes à sua organização. Repita isso para todos os repositórios cujos códigos você deseja que acessem outros repositórios. ![Menu suspenso "Repositórios selecionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index 92260550e5..0000000000 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Gerenciar segredos criptografados para o seu repositório e organização para codespaces -shortTitle: Gerenciar segredos para o seu repositório e organização -intro: 'Os segredos criptografados permitem que você armazene informações confidenciais na sua organização, repositório ou {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre segredos - -Segredos são variáveis de ambiente criptografadas que você cria em uma organização ou repositório. Os segredos que você criou estão disponíveis para uso em {% data variables.product.prodname_codespaces %}. O GitHub usa uma [caixa protegida pela libsodium](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) para criptografar segredos antes que eles cheguem ao GitHub e só descriptografa quando você os usa em um codespace. - -Os segredos no nível da organização permitem que você compartilhe segredos entre vários repositórios, o que reduz a necessidade de criar segredos duplicados. Você pode usar políticas de acesso para controlar quais repositórios podem usar segredos da organização. - -{% data reusables.codespaces.secrets-on-start %} - -#### Nomeando segredos - -{% data reusables.codespaces.secrets-naming %} Por exemplo, um segredo criado no nível do repositório deve ter um nome exclusivo nesse repositório, e um segredo criado no nível da organização deve ter um nome exclusivo nesse nível. - - {% data reusables.codespaces.secret-precedence %} - -#### Limites para segredos - -Você pode armazenar até 100 segredos por organização e 100 segredos por repositório. - -Os segredos são limitados a 64 kB. - -### Adicionar segredos para um repositório - -Para criar segredos para um repositório da organização, você deve ter acesso de administrador. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Desça a barra de rolagem e, em **Segredos**, selecione **Codespaces**. ![Opção de codespace na barra lateral](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. Na parte superior da página, clique em **Novo segredo de repositório**. -1. Digite um nome para o seu segredo na caixa de entrada **Nome**. -1. Insira o valor para o seu segredo. -1. Clique em **Add secret** (Adicionar segredo). - -### Adicionar segredos para uma organização - -Ao criar um segredo em uma organização, você pode usar uma política para limitar quais repositórios podem acessar esse segredo. Por exemplo, você pode conceder acesso a todos os repositórios ou limitar o acesso a apenas repositórios privados ou a uma lista específica de repositórios. - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Desça a barra de rolagem e, em **Segredos**, selecione **Codespaces**. ![Opção de codespace na barra lateral](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. Na parte superior da página, clique em **Novo segredo de organização**. -1. Digite um nome para o seu segredo na caixa de entrada **Nome**. -1. Insira o **Valor** para o seu segredo. -1. Na lista suspensa **Acesso do repositório**, escolha uma política de acesso. ![Lista de Acesso ao Repositório com repositórios privados selecionados](/assets/images/help/codespaces/secret-repository-access.png) -1. Clique em **Add secret** (Adicionar segredo). - -### Rever o acesso para os segredos do nível da organização - -Você pode verificar quais políticas de acesso são aplicadas a um segredo na sua organização. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. A lista de segredos inclui quaisquer permissões e políticas configuradas. Por exemplo: ![Lista de segredos](/assets/images/help/settings/actions-org-secrets-list.png) -1. Para obter mais detalhes sobre as permissões configuradas para cada segredo, clique em **Atualizar**. diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index 632a2c1fcc..0000000000 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Gerenciar permissões de usuário para sua organização -intro: 'Você pode controlar quais usuários da sua organização podem usar {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre as permissões de usuário para {% data variables.product.prodname_codespaces %} - -Os proprietários da organização podem controlar quais usuários da sua organização podem criar e usar cdespaces. - -Para usar codespaces na sua organização, os usuários devem ter pelo menos acesso de gravação aos repositórios onde desejam usar o codespace. Você pode habilitar os codespaces para todos os usuários da sua organização ou apenas para usuários específicos. - -Por padrão, um codespace só pode acessar o repositório onde foi criado. Se você quiser que os codespaces na sua organização possam acessar outros repositórios da organização que o criador do codespace possa acessar, consulte "[Gerenciar acesso e segurança para {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". - -### Configurar quais usuários da sua organização podem usar {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Em "Permissões de usuário", selecione uma das seguintes opções: - - * **Desabilitado** para não permitir que nenhum integrante da organização use {% data variables.product.prodname_codespaces %}. - * **Permitir para todos os usuários** para permitir que todos os integrantes da sua organização usem {% data variables.product.prodname_codespaces %}. - * **Usuários selecionados** para selecionar integrantes específicos da organização para usar {% data variables.product.prodname_codespaces %}. - - ![Botões de opção para "Permissões do usuário"](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index f6de804a4a..0000000000 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Revisando os logs de auditoria da sua organização para os codespaces -shortTitle: Revisando os logs de auditoria da sua organização -intro: 'Você pode usar o log de auditoria para revisar todas as ações relacionadas a {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -Quando qualquer integrante da sua organização executa uma ação relacionada a {% data variables.product.prodname_codespaces %}, você poderá revisar as ações no log de auditoria. Para obter informações sobre acesso ao registro, consulte "[Revisar seu log de auditoria](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)". - -![Log de auditoria com informações sobre codespaces](/assets/images/help/settings/codespaces-audit-log-org.png) - -O log de auditoria inclui detalhes como quem realizou a ação, qual foi a ação e quando a ação foi realizada. Para obter informações sobre ações de {% data variables.product.prodname_codespaces %}, consulte "[ações de categoria de {% data variables.product.prodname_codespaces %}](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)." diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/index.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 37f45202c0..0000000000 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Gerenciar seus codespaces -intro: 'Você pode usar as configurações de {% data variables.product.prodname_github_codespaces %} para gerenciar informações que seu codespace possa precisar.' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index 9e78cc2d97..0000000000 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Gerenciar os codespaces de acesso e segurança para os seus codespaces -intro: 'Você pode gerenciar os repositórios que {% data variables.product.prodname_codespaces %} pode acessar.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Ao habilitar o acesso e a segurança de um repositório pertencente à sua conta de usuário, todos os códigos que forem criados para esse repositório terão permissões de leitura e gravação em todos os outros repositórios que você possui. Se você deseja restringir os repositórios que um código pode acessar, você pode limitá-lo tanto para o repositório no qual o código foi aberto ou para repositórios específicos. Você só deve habilitar o acesso e a segurança para repositórios nos quais confia. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Em "Acesso e segurança", selecione a configuração que deseja para sua conta de usuário. ![Botões de opção para gerenciar repositórios confiáveis](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. Se você escolher "repositórios selecionados", selecione o menu suspenso e clique em um repositório para permitir que os codespaces do repositório tenham acesso a outros repositórios dos quais você é proprietário. Repita para todos os repositórios cujos codespaces você deseja que acessem outros repositórios dos quais você é proprietário. ![Menu suspenso "Repositórios selecionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index cec02842a1..0000000000 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Gerenciar segredos criptografados para seus codespaces -intro: 'Você pode armazenar informações confidenciais, como tokens, que você deseja acessar nos seus codespaces por meio de variáveis de ambiente.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### Sobre os segredos criptografados para {% data variables.product.prodname_codespaces %} - -Você pode adicionar segredos criptografados à sua conta de usuário que deseja usar nos seus codespaces. Por exemplo, você pode querer armazenar e acessar as seguintes informações confidenciais como segredos criptografados. - -- Tokens de acesso pessoal para os serviços da nuvem -- Entidades de serviço -- Identificadores da assinatura -- [Credenciais para um registro de imagens privado](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -Você pode escolher quais repositórios devem ter acesso a cada segredo. Em seguida, você pode usar o segredo em qualquer código que criar para um repositório que tiver acesso ao segredo. - -{% data reusables.codespaces.secrets-on-start %} - -#### Nomeando segredos - -{% data reusables.codespaces.secrets-naming %} Por exemplo, um segredo criado no nível do repositório deve ter um nome exclusivo nesse repositório. - - {% data reusables.codespaces.secret-precedence %} - -#### Limites para segredos - -Você pode armazenar até 100 segredos para {% data variables.product.prodname_codespaces %}. - -Os segredos são limitados a 64 kB. - -### Adicionar um segredo - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. À direita dos "Segredos dos codespaces", clique em **Novo segredo**. ![Botão "Novo segredo"](/assets/images/help/settings/codespaces-new-secret-button.png) -1. Em "Nome", digite um nome para seu segredo. ![Caixa de texto "Nome"](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Clique em **Add secret** (Adicionar segredo). - -### Editar um segredo - -Você pode atualizar o valor de um segredo existente, bem como alterar quais repositórios podem acessar um segredo. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Em "Segredos do codespace", à direita do segredo que você deseja editar, clique em **Atualizar**. ![Botão "Atualizar"](/assets/images/help/settings/codespaces-secret-update-button.png) -1. Em "Valor", clique em **Inserir um novo valor**. ![Link "Inserir um novo valor"](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Opcionalmente, para remover o acesso do segredo a um repositório, desmarque o repositório. ![Caixas de seleção para remover acesso aos repositórios](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. Clique em **Save changes** (Salvar alterações). - -### Excluir um segredo - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Em "Segredos dos codespaces", à direita do segredo que você deseja excluir, clique em **Excluir**. ![Botão "Excluir"](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. Leia o alerta e clique em **OK**. ![Confirmação para excluir um segredo](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index 5a604802b7..0000000000 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Gerenciar a verificação de GPG de codespaces -intro: 'Você pode permitir que {% data variables.product.company_short %} use o GPG automaticamente para assinar os commits que você faz nos seus codespaces para que outras pessoas possam confiar que as alterações vêm de uma fonte de confiança.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Depois que você habilitar a verificação do GPG, {% data variables.product.company_short %} assinará automaticamente os commits que você fizer em {% data variables.product.prodname_codespaces %}, e os commits terão um status de verificado em {% data variables.product.product_name %}. Por padrão, a verificação do GPG está desabilitada para os codespaces que você criar. Você pode optar por permitir a verificação do GPG para todos os repositórios ou repositórios específicos. Habilite apenas a verificação do GPG para repositórios nos quais você confia. Para obter mais informações sobre commits assinado por {% data variables.product.product_name %}, consulte "[Sobre a verificação de assinatura do commit](/github/authenticating-to-github/about-commit-signature-verification)". - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Em "Verificação do GPG, selecione a configuração que deseja para verificação do GPG. ![Botões de opção para gerenciar a verificação do GPG](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. Se você escolheu "repositórios selecionados", selecione o menu suspenso e, em seguida, clique em um repositório para o qual deseja habilitar a verificação do GPG. Repita esse procedimento para todos os repositórios para os quais você deseja habilitar a verificação do GPG. ![Menu suspenso "Repositórios selecionados"](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index 9a65963203..0000000000 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Revisando os logs de segurança dos codespaces -shortTitle: Revisando seus logs de segurança -intro: 'Você pode usar o log de segurança para revisar todas as ações relacionadas a {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre os logs de segurança de {% data variables.product.prodname_codespaces %} - -Quando você executar uma ação relacionada a {% data variables.product.prodname_codespaces %} em repositórios pertencentes à sua conta de usuário, você poderá revisar as ações no log de segurança. Para obter informações sobre acesso ao registro, consulte "[Revisar seu log de segurança](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)". - -![log de segurança com informações de codespaces](/assets/images/help/settings/codespaces-audit-log.png) - -O log de segurança inclui detalhes sobre qual ação ocorreu e quando você a executou. Para obter informações sobre ações de {% data variables.product.prodname_codespaces %}, consulte "[ações de categoria de {% data variables.product.prodname_codespaces %}](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". diff --git a/translations/pt-BR/content/codespaces/quickstart.md b/translations/pt-BR/content/codespaces/quickstart.md deleted file mode 100644 index efc99504e0..0000000000 --- a/translations/pt-BR/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Início rápido para o GitHub Codespaces -intro: 'Experimente {% data variables.product.prodname_codespaces %} em 5 minutos ou menos.' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### Introdução - -Neste guia, você criará um codespace a partir do [repositório de amostra](https://github.com/2percentsilk/haikus-for-codespaces) e explorará algumas das funcionalidades essenciais disponíveis para você dentro do codespace. - -O exemplo a seguir mostra como criar um codespace, conectar-se a uma porta encaminhada para visualizar o seu aplicativo de execução e personalizar sua configuração com extensões e dotfiles. - -### Criando seu codespace - -1. Acesse a página principal do [repositório de amostra](https://github.com/2percentsilk/haikus-for-codespaces). - -2. No nome do repositório, use o menu suspenso do {% octicon "download" aria-label="The download icon" %} **Código** e selecione **Abrir com os espaços de código**. - - ![Botão de abrir com codespaces](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. Para criar um codespace, clique em {% octicon "plus" aria-label="The plus icon" %} **Novo codespace**. - - ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) - -### Execute o aplicativo - -Com o seu projeto aberto em um codespace, agora você pode executar o aplicativo e abri-lo em um navegador. - -1. Inicie o aplicativo digitando `npm run dev` no terminal. Este comando executa o script `dev` no arquivo package.json e inicia o aplicativo web definido no repositório de exemplo. - - ![npm run dev no terminal](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa. - - ![Notificação de encaminhamento de porta](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. Clique em **Abrir no navegador** para visualizar seu aplicativo em execução em uma nova aba. - -### Personalize com uma extensão de tema - -Dentro de um codespace, você tem acesso ao Marketplace do Visual Studio Code. Para este exemplo, você instalará uma extensão que altera o tema, mas você pode instalar qualquer extensão que seja útil para o seu fluxo de trabalho. - -1. Na barra lateral esquerda, clique no ícone Extensões. - -2. Na barra de pesquisa, digite `fairyfloss` e instale a extensão fairyfloss. - - ![Adicionar extensão](/assets/images/help/codespaces/add-extension.png) - -3. Selecione o tema `fairyfloss` selecionando-o na lista. - - ![Selecionar tema fairyfloss](/assets/images/help/codespaces/fairyfloss.png) - -4. Alterações feitas na sua configuração de editor no espaço do código atual, como ligações de tema e teclado, são sincronizadas automaticamente em outros códigos por meio de [Sincronizar configurações](https://code.visualstudio.com/docs/editor/settings-sync). - -### Personalizar com dotfiles - -Se a sua conta de usuário no GitHub possuir um dotfiles com nome de repositório público, o GitHub usará automaticamente esse repositório para personalizar seu ambiente de código durante a criação de um codespace. - -Este exemplo apresenta a você a criação de um repositório de dotfiles para os seus codespaces. - -1. Acesse a amostra do [repositório de dotfiles](https://github.com/aw-test-93/dotfiles/). - -2. Bifurque o repositório na sua conta e certifique-se de que seja público. - - Verifique se o repositório criado na sua conta tem o nome dotfiles, por exemplo `yourname/dotfiles`. Qualquer outro nome fará com que o {% data variables.product.prodname_codespaces %} ignore o repositório para personalização. - -3. Crie um novo codespace a partir do [repositório do aplicativo de amostra](https://github.com/2percentsilk/haikus-for-codespaces) já que as atualizações do dotfile só serão aplicadas no momento da criação. Os arquivos de exemplo irão alterar o prompt de comando para texto roxo e azul em negrito. - - ![Instrução de comando personalizado](/assets/images/help/codespaces/custom-prompt.png) - -### Próximos passos - -Você criou com sucesso, personalizou e executou seu primeiro aplicativo em um codespace, mas há muito mais para explorar! Aqui estão alguns recursos úteis para dar seus próximos passos com {% data variables.product.prodname_codespaces %}. - - "[Guias dos primeiros passos](/codespaces/getting-started-with-codespaces)" para usar {% data variables.product.prodname_codespaces %} com linguagens específicas - - [Crie uma configuração personalizada](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project) para configurar {% data variables.product.prodname_codespaces %} para o seu projeto. diff --git a/translations/pt-BR/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/pt-BR/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index 39e6656481..0000000000 --- a/translations/pt-BR/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: Configurar codespaces para seu projeto -intro: 'Você pode usar um arquivo `devcontainer.json` para definir um ambiente de {% data variables.product.prodname_codespaces %} para o seu repositório.' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre contêineres de desenvolvimento - -Um contêiner de desenvolvimento, ou dev container, é o ambiente que {% data variables.product.prodname_codespaces %} usa para fornecer as ferramentas e tempos de execução de que seu projeto precisa para desenvolvimento. Ao trabalhar com um contêiner de desenvolvimento em {% data variables.product.prodname_codespaces %} você pode [usar a configuração padrão](#using-the-default-configuration), [usar uma configuração pré-definida](#using-a-pre-defined-container-configuration), ou [criar sua própria configuração](#creating-a-custom-codespace-configuration). A opção escolhida depende das ferramentas, tempo de execução, dependências e fluxos de trabalho que um usuário pode precisar para ter sucesso com seu projeto. - -{% data variables.product.prodname_codespaces %} permite a personalização em uma base por projeto e por branch com um arquivo `devcontainer.json`. Este arquivo de configuração determina o ambiente de cada novo codespace que alguém criar para o repositório, definindo um contêiner de desenvolvimento que pode incluir estruturas, ferramentas, extensões e encaminhamento de porta. Um arquivo Docker também pode ser usado ao lado do arquivo `devcontainer.json` na pasta `devcontainer` para definir tudo o que é necessário para criar uma imagem de contêiner. - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -Você pode usar o seu `devcontainer.json` para definir as configurações padrão para todo o ambiente do codespace, incluindo o editor, mas você também pode definir configurações específicas do editor para áreas de trabalho individuais [](https://code.visualstudio.com/docs/editor/workspaces) em um codespace em um arquivo denominado `.vscode/settings.json`. - -Para obter informações sobre as configurações e propriedades que você pode definir em um `devcontainer.json`, consulte [referência do devcontainer.json](https://aka.ms/vscode-remote/devcontainer.json) na documentação de {% data variables.product.prodname_vscode %}. - -#### arquivo Docker - -Um arquivo Docker também mora na pasta `.devcontainer`. - -Você pode adicionar um arquivo Docker ao seu projeto para definir uma imagem de contêiner e instalar software. No arquivo Docker, você pode usar `DE` para especificar a imagem do contêiner. - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -Você pode usar a instrução `EXECUTAR` para instalar qualquer software e `&&` para unir comandos. - -Faça referência ao seu arquivo Docker no arquivo `devcontainer.json` usando a propriedade `arquivo Docker`. - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -Para obter mais informações sobre como usar um arquivo Docker em um contêiner de desenvolvimento, consulte [Criar um contêiner de desenvolvimento](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) na documentação de {% data variables.product.prodname_vscode %}. - -### Usando a configuração padrão - -Se você não definir uma configuração no repositório, o {% data variables.product.prodname_dotcom %} criará um código com uma imagem-base do Linux. A imagem de base do Linux inclui linguagens e tempos de execução como Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby e Rust. Ela também inclui outras ferramentas e utilitários para desenvolvedores como git, GitHub CLI, yarn, openssh, e vim. Para ver todas as linguagens, tempos de execução e as ferramentas que são incluídas, use o comando `devcontainer-info content-url` dentro do seu terminal de código e siga a url que o comando emite. - -Como alternativa, para obter mais informações sobre tudo o que está incluído na imagem de base do Linux, consulte o arquivo mais recente no repositório [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers). - -A configuração padrão é uma boa opção se você estiver trabalhando em um pequeno projeto que usa as linguagens e ferramentas que {% data variables.product.prodname_codespaces %} fornece. - - -### Usando uma configuração de contêiner predefinida - -Definições de contêiner predefinidas incluem uma configuração comum para um tipo específico de projeto e podem ajudar você rapidamente a dar os primeiros passos com uma configuração que já tem as opções de contêiner apropriadas, {% data variables.product.prodname_vscode %} configurações, e extensões de {% data variables.product.prodname_vscode %} que devem ser instaladas. - -Usar uma configuração predefinida é uma ótima ideia se você precisa de uma extensão adicional. Você também pode começar com uma configuração predefinida e alterá-la conforme necessário para a configuração do seu projeto. - -1. Para acessar a paleta de comando, no canto superior esquerdo, selecione o Menu de Aplicativos e clique em **Paleta de Comando…** no menu **Exibir** e, em seguida, comece a digitar "Codespaces: Adicionar arquivos de configuração do Container do Desenvolvimento...". Clique em **Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento...** !["Codespaces: Adicionar arquivos de configuração de Contêiner de Desenvolvimento..." na paleta de comandos](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. Clique na definição que você deseja usar. ![Lista de definições de contêiner predefinidas](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. Siga as instruções para personalizar sua definição. -1. Clique em **OK**. ![Botão OK](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. Para aplicar as alterações, no canto inferior direito da tela, clique em **Reconstruir agora**. Para obter mais informações sobre a reconstrução do seu contêiner, consulte "[Aplicar alterações na sua configuração](#applying-changes-to-your-configuration)". !["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/rebuild-prompt.png) - - -### Criar uma configuração personalizada de codespace - -Se nenhuma das configurações predefinidas atender às suas necessidades, você poderá criar uma configuração personalizada adicionando um arquivo `devcontainer.json`. {% data reusables.codespaces.devcontainer-location %} - -No arquivo, você pode usar [chaves de configuração compatíveis](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) para especificar aspectos do ambiente do código, como quais extensões de {% data variables.product.prodname_vscode %} serão instaladas. - -{% data reusables.codespaces.vscode-settings-order %} - -Você pode definir as configurações de editor-padrão para {% data variables.product.prodname_vscode %} em dois lugares. - -* As configurações do editor definidas em `.vscode/settings.json` são aplicadas como configurações do escopo do _espaço de trabalho_ no codespace. -* Configurações do editor definidas na chave `Configurações` no `devcontainer.json` são aplicadas como configuração de escopo _Remote [Codespaces]_ nesse codespace. - -Depois de atualizar o arquivo `devcontainer.json`, você poderá reconstruir o contêiner para o seu código aplicar as alterações. Para obter mais informações, consulte "[Aplicar alterações à sua configuração](#applying-changes-to-your-configuration)". - - - - -### Aplicando alterações à sua configuração - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %} -!["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} Corrija os erros na configuração. ![Mensagem de erro sobre modo de recuperação](/assets/images/help/codespaces/recovery-mode-error-message.png) - - Para diagnosticar o erro revisando os registros de criação, clique em **Visualizar registro de criação**. - - Para corrigir os erros identificados nos registros, atualize seu arquivo devcontainer.json..
  • -
  • Para aplicar as alterações, reconstrua seu contêiner. {% data reusables.codespaces.rebuild-command %}
  • - diff --git a/translations/pt-BR/content/codespaces/setting-up-your-codespace/index.md b/translations/pt-BR/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index a7b5422d88..0000000000 --- a/translations/pt-BR/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Configurar seu codespace -intro: '{% data variables.product.prodname_codespaces %} é um ambiente dedicado a você. Você pode configurar seu codespace com um contêiner de desenvolvimento para instalar suas dependências ou você pode adicionar um dotfile para personalizar as configurações de usuário.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/pt-BR/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/pt-BR/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index 7e26409864..0000000000 --- a/translations/pt-BR/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Personalizar os codespaces para a sua conta -intro: 'Você pode personalizar {% data variables.product.prodname_codespaces %} usando um repositório `dotfiles` em {% data variables.product.product_name %} ou usando Configurações de Sincronização.' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### Sobre a personalização de {% data variables.product.prodname_codespaces %} - -Ao usar qualquer ambiente de desenvolvimento, a personalização das configurações e ferramentas para suas preferências e fluxos de trabalho é uma etapa importante. {% data variables.product.prodname_codespaces %} permite duas formas principais de personalizar seus codespaces. - -- [Configurações de sincronização](#settings-sync) - Você pode usar e compartilhar as configurações {% data variables.product.prodname_vscode %} entre {% data variables.product.prodname_codespaces %} e outras instâncias de {% data variables.product.prodname_vscode %}. -- [Dotfiles](#dotfiles) - Você pode usar um repositório `dotfiles` público para especificar scripts, preferências do shell e outras configurações. - -A personalização de {% data variables.product.prodname_codespaces %} aplica-se a qualquer codespace que você criar. - -Os mantenedores do projeto também podem definir uma configuração-padrão que se aplica a todos os codespaces de um repositório, criados por qualquer pessoa. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)". - -### Configurações de sincronização - -A sincronização de configurações permite que você compartilhe configurações como configurações, atalhos de teclado, snippets, extensões e estado da interface de usuário entre as máquinas e instâncias de {% data variables.product.prodname_vscode %}. - -Sincronização de configurações encontra-se ativada por padrão. Para definir qualquer configuração, no canto inferior esquerdo da barra de atividades, selecione {% octicon "gear" aria-label="The gear icon" %} e clique em **As configurações de sincronização estão ativadas**. Na caixa de diálogo, você pode optar por configurar, mostrar configurações e dados ou desabilitar a sincronização de configurações. - -![Opção de configuração de sincronização no menu de gerenciamento](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -Para obter mais informações, consulte o [Guia de sincronização de configurações](https://code.visualstudio.com/docs/editor/settings-sync) na documentação de {% data variables.product.prodname_vscode %}. - -### Dotfiles - -Os Dotfiles são arquivos e pastas de sistemas de tipo Unix, que começam com `.` e controlam a configuração de aplicativos e shells no seu sistema. Você pode armazenar e gerenciar seus dotfiles em um repositório no {% data variables.product.prodname_dotcom %}. Para obter aconselhamento e tutoriais sobre o que incluir no repositório `dotfiles`, consulte [GitHub gerencia dotfiles](https://dotfiles.github.io/). - -Se sua conta de usuário no {% data variables.product.prodname_dotcom %} possui um repositório público denominado `dotfiles`, o {% data variables.product.prodname_dotcom %} usa este repositório automaticamente para personalizar seu ambiente de codespace. Atualmente, não são compatíveis os repositórios privados `dotfiles`. - -O seu repositório `dotfiles` pode incluir os alias e preferências do seu shell, quaisquer ferramentas que você deseja instalar ou qualquer outra personalização de codespace que desejar fazer. - -Ao criar um novo codespace, o {% data variables.product.prodname_dotcom %} clona seus repositórios de `dotfiles` para o ambiente do codespace e procura por um dos seguintes arquivos para configurar o ambiente. - -* _install.sh_ -* _install_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -Se nenhum desses arquivos for encontrado, quaisquer arquivos ou pastas nos `dotfiles` que comecem com `.` será vinculado simbolicamente ao diretório `~` ou `$HOME` do codespace. - -Quaisquer alterações no repositório de `dotfiles` serão aplicadas apenas a cada novo codespace e não afetarão nenhum codespace existente. - -{% note %} - -**Observação:** Atualmente, o {% data variables.product.prodname_codespaces %} não é compatível com a personalização das configurações do _Usuário_ para o editor de {% data variables.product.prodname_vscode %} com o repositório `dotfiles`. É possível definir as configurações-padrão do _espaço de trabalho_ e _Remote [Codespaces]_ para um projeto específico no repositório do projeto. Para obter mais informações, consulte "[Configurar o {% data variables.product.prodname_codespaces %} para seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)". - -{% endnote %} - -Você também pode definir as configurações para que a sua conta de usuário adicione segredos criptografados, habilitar a verificação de GPG e permitir que os seus codespaces acessem outros repositórios. Para obter mais informações, consulte "[Gerenciar segredos criptografados para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Gerenciar verificação de GPG para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)" e "[Gerenciar acesso e segurança para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)". - -### Leia mais - -* "[Criar um repositório](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/pt-BR/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/pt-BR/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index 20d799122a..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %} é grátis para usar durante a beta. Quando {% data variables.product.prodname_codespaces %} se torna geralmente disponível, você será cobrado para armazenamento e uso de computação. diff --git a/translations/pt-BR/data/reusables/codespaces/about-configuration.md b/translations/pt-BR/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 1435705ccf..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -Você pode criar uma configuração padrão de codespace para o seu repositório que determina o ambiente de cada novo codespace que alguém criar para esse repositório. A configuração define um contêiner de desenvolvimento que pode incluir estruturas, ferramentas, extensões e encaminhamento de porta. diff --git a/translations/pt-BR/data/reusables/codespaces/about-personalization.md b/translations/pt-BR/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index 067c6e3fee..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -You can also use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. A personalização pode incluir preferências de shell e ferramentas adicionais. diff --git a/translations/pt-BR/data/reusables/codespaces/about-port-forwarding.md b/translations/pt-BR/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index 39b29dc4a0..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -You can forward ports in your codespace to test and debug your application. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/pt-BR/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index 8031bfb4af..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -After the {% data variables.product.prodname_codespaces %} configuration for a repository changes, you can apply the changes to an existing codespace by rebuilding the container for the codespace. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/beta-functionality-limited.md b/translations/pt-BR/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 1dfa5d641f..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -Durante a beta, a funcionalidade é limitada. -- {% data reusables.codespaces.use-chrome %} -- Apenas um tamanho único de espaço de código está disponível. -- Somente os contêineres Linux são suportados. -- Um codespace não é totalmente recuperável. Os processos que estavam em execução no momento em que o código foi interrompido não serão reiniciados. diff --git a/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index c45d078f12..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. Em {% data variables.product.prodname_vscode %}, na barra lateral esquerda, clique no ícone Remote Explorer. ![O ícone do Remote Explorer em {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/codespace-config-order.md b/translations/pt-BR/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index 41081172b3..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -Sua personalização `dotfiles` é aplicada antes da configuração de código padrão de um repositório. diff --git a/translations/pt-BR/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/pt-BR/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index aaee1d9d17..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -Cada código é associado a um branch específico de um repositório. diff --git a/translations/pt-BR/data/reusables/codespaces/codespaces-are-personal.md b/translations/pt-BR/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index 9d77e536f7..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -Cada espaço de código que criar só está disponível para você. Ninguém mais pode trabalhar no seu espaço de código. diff --git a/translations/pt-BR/data/reusables/codespaces/codespaces-machine-types.md b/translations/pt-BR/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index b66b4193f5..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -You can run your codespace on a choice of three types of remote machine: Basic, Standard, or Premium. Cada uma delas tem um nível diferente de recursos e uma camada diferente de cobrança.{% note %} - -**Observação:** {% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -Switching machine types gives you the flexibility to choose the most appropriate resources for your work. Certain tasks may require different machine types: - -* **Basic** for updating a file and raising a pull request -* **Standard** for editing a website -* **Premium** for high compute tasks such as data analysis diff --git a/translations/pt-BR/data/reusables/codespaces/committing-link-to-procedure.md b/translations/pt-BR/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 87bfa539ff..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding {% data variables.product.prodname_vscode %} extensions, will appear for all users. - -For information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)." \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index 477b0489b1..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. No entanto, cada conta de usuário tem um limite de dois codespaces durante um beta público limitado. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. diff --git a/translations/pt-BR/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/pt-BR/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index be18129c85..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -Você pode se conectar ao seu código diretamente de {% data variables.product.prodname_vscode %}. Para obter mais informações, consulte "[Usar codespaces no {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)". diff --git a/translations/pt-BR/data/reusables/codespaces/devcontainer-location.md b/translations/pt-BR/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index 5af86ddcf1..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -Este arquivo pode ser localizado na raiz do repositório ou em uma pasta denominada `.devcontainer`. Se o arquivo estiver localizado na raiz do repositório, o nome do arquivo deve começar com um ponto: `.devcontainer.json`. diff --git a/translations/pt-BR/data/reusables/codespaces/navigate-to-codespaces.md b/translations/pt-BR/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index a85e3a30f6..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. Na parte superior da página, clique em **Codespaces**. ![{% data variables.product.prodname_codespaces %} link no cabeçalho](/assets/images/help/codespaces/header-link.png) diff --git a/translations/pt-BR/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/pt-BR/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index fed860897b..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In your codespace, under the text editor, click "Ports". ![Ports tab](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/pt-BR/data/reusables/codespaces/rebuild-command.md b/translations/pt-BR/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index ea9e45b032..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -Access the command palette (`shift command P` / `shift control P`), then start typing "Codespaces: Rebuild Container". Click **Codespaces: Rebuild Container**. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/recovery-mode.md b/translations/pt-BR/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index fa4e73d013..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -If changes to your codespace's configuration cause a container error, your codespace will run in recovery mode, and you will see an error message. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/release-stage.md b/translations/pt-BR/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 50df2085af..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Observação:** {% data variables.product.prodname_codespaces %} está atualmente em versão beta pública limitada e sujeito a alterações. Para obter mais informações sobre fontes de publicação, consulte "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)." - -{% endnote %} diff --git a/translations/pt-BR/data/reusables/codespaces/secret-precedence.md b/translations/pt-BR/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index d5102fd3fa..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -Se existir um segredo com o mesmo nome em vários níveis, o segredo no nível inferior tem prioridade. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/secrets-naming.md b/translations/pt-BR/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index 0b93679cdf..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -As regras a seguir aplicam-se aos nomes dos segredos: - -* Os nomes dos segredos podem conter apenas caracteres alfanuméricos (`[a-z]`, `[A-Z]`, `[0-9]`) or sublinhado (`_`). Não são permitidos espaços. -* Os nomes dos segredos não devem começar com o prefixo `GITHUB_`. -* Os nomes dos segredos não devem começar com um número. -* Nomes dos segredos não diferenciam maiúsculas de minúsculas. -* Os nomes dos segredos devem ser únicos no nível em que são criados. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/secrets-on-start.md b/translations/pt-BR/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index c4a5bf3b41..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to suspend the codespace and resume it. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/source-control-display-dark.md b/translations/pt-BR/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index 90b3503dcd..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. ![Source control view](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/source-control-display.md b/translations/pt-BR/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index 09917cd3c8..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. - - ![Source control view](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/type-port-label.md b/translations/pt-BR/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index 498c9eb752..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. Type a label for your port, then press enter. ![Text box to type label for port](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/unsupported-repos.md b/translations/pt-BR/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index ee7d7ce651..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -Durante o beta, repositórios privados pertencentes a organizações ou quaisquer repositórios pertencentes a uma organização que exijam um único login SAML, não são suportados. diff --git a/translations/pt-BR/data/reusables/codespaces/use-chrome.md b/translations/pt-BR/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index cc675512cc..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -Para a melhor experiência com {% data variables.product.prodname_codespaces %}, recomendamos o uso de um navegador baseado no Chromium, como o Google Chrome ou a Microsoft Edge. diff --git a/translations/pt-BR/data/reusables/codespaces/use-visual-studio-features.md b/translations/pt-BR/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index 428e0b5879..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -Você pode editar código, depurar e usar comandos do Git ao mesmo tempo que faz o desenvolvimento em um codespace com {% data variables.product.prodname_vscode %}. For more information, see the [{% data variables.product.prodname_vscode %} documentation](https://code.visualstudio.com/docs). diff --git a/translations/pt-BR/data/reusables/codespaces/vscode-settings-order.md b/translations/pt-BR/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index 56dc36a4e4..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -Ao configurar as configurações de editor para {% data variables.product.prodname_vscode %}, há três escopos disponíveis: _Workspace_, _Remote [Codespaces]_, e _User_. Se uma configuração for definida em vários escopos, as configurações do _Workspace_ têm prioridade e, em seguida _Remote [Codespaces]_, depois _User_. diff --git a/translations/pt-BR/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/pt-BR/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index afb626e71c..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -You can see every available codespace that you have created at [github.com/codespaces](https://github.com/codespaces). diff --git a/translations/pt-BR/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/pt-BR/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index a5e98437c0..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the top right corner of {% data variables.product.product_name %}, click your profile photo, then click **Your codespaces**. - - !['Your codespaces' menu option](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/gated-features/codespaces.md b/translations/pt-BR/data/reusables/gated-features/codespaces.md deleted file mode 100644 index 08708dce57..0000000000 --- a/translations/pt-BR/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Os espaços de códigos estão disponíveis para contas de usuário usando {% data variables.product.prodname_free_user %} ou {% data variables.product.prodname_pro %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/pt-BR/data/reusables/organizations/click-codespaces.md b/translations/pt-BR/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index ff78601d0b..0000000000 --- a/translations/pt-BR/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. Na barra lateral esquerda, clique em **Codespaces**. ![Aba "Codespaces" na barra lateral esquerda](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/pt-BR/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/pt-BR/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index b534205357..0000000000 --- a/translations/pt-BR/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. Selecione o menu suspenso "Acesso ao repositório" e, em seguida, clique em um repositório que você quer que tenha acesso ao segredo. Repita esse procedimento para cada repositório que você quer que tenha acesso ao segredo. ![Menu suspenso "Acesso ao repositório"](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/user_settings/codespaces-secret-value.md b/translations/pt-BR/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index 4f3a6b3291..0000000000 --- a/translations/pt-BR/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. Em "Valor", digite o valor do seu segredo. ![Caixa de texto "Valor"](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/user_settings/codespaces-tab.md b/translations/pt-BR/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index 7a99dc6de4..0000000000 --- a/translations/pt-BR/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. Na barra lateral esquerda, clique em **Codespaces**. ![Aba de codespaces na barra lateral de configurações do usuário](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/translations/ru-RU/content/codespaces/about-codespaces.md b/translations/ru-RU/content/codespaces/about-codespaces.md deleted file mode 100644 index b7fc37f8ef..0000000000 --- a/translations/ru-RU/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: About Codespaces -intro: '{% data variables.product.prodname_codespaces %} is a configurable online development environment, hosted by {% data variables.product.prodname_dotcom %} and powered by {% data variables.product.prodname_vscode %}, that allows you to develop entirely in the cloud.' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### About {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} is a configurable cloud development environment available in your browser on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -![An open codespace](/assets/images/help/codespaces/codespace-overview.png) - -A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings. - -Codespaces offers many benefits to teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development. - -### A consistent environment - -You can create a single codespace configuration that defines the environment (or _dev container_) of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. A standardized environment is already available for them as soon as they create a codespace from the repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." - -For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials. - -While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}. - -### Fast and personal onboarding - -With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**. - -![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -As a result of standardizing on a repeatable developer environment, developers can get started with a new codespace without doing any manual configuration and do not need to do continued maintenance of their developer environment. A new codespace can be created when starting a new feature. - -Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - -Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs. - -### A secure environment - -{% data variables.product.prodname_codespaces %} allows developers to develop in the cloud instead of locally. This creates one single, trackable, source of truth. Developers can contribute from anywhere, on any machine, including tablets or Chromebooks, and there is no need to maintain local copies of intellectual property. Developers always have to be logged in and provided with access to both {% data variables.product.prodname_codespaces %} and specific repositories. These permissions can be revoked at any time. As soon as you revoke access, those developers will lose all access to protected resources. In addition, authenticated developers create audit trails so you know who is doing what. For more information on access and security, see "[Managing access and security for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -Using {% data variables.product.prodname_codespaces %} is the most secure when all members of your team are using it. It means that there is no need to clone the repository onto a local machine and that developers don't need to install locally as `root`. - -Developers and organization administrators can also configure settings to add encrypted secrets and enable GPG verification. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)". - -### About billing for {% data variables.product.prodname_codespaces %} - -{% data reusables.codespaces.about-billing-for-codespaces %} For more information, see "[About billing for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)." - -### Joining the beta - -A limited number of people will be invited to join the beta. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup). - -### Contacting us about {% data variables.product.prodname_codespaces %} - -If you encounter problems using {% data variables.product.prodname_codespaces %}, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." - -If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) discussion. diff --git a/translations/ru-RU/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/ru-RU/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index f621a80494..0000000000 --- a/translations/ru-RU/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: About billing for Codespaces -intro: 'When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -Updates on the billing model for Codespaces will be shared in an upcoming announcement. diff --git a/translations/ru-RU/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/ru-RU/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index 75be9e6f73..0000000000 --- a/translations/ru-RU/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Allowing your codespace to access a private image registry -intro: 'You can use secrets to allow {% data variables.product.prodname_codespaces %} to access a private image registry' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. You can create secrets in GitHub to store the access details for a private registry and use them to give your codespace access to images stored in the registry. - -When you launch a codespace, {% data variables.product.prodname_codespaces %} checks for three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -You can store secrets at the user, repository, or organization-level, allowing you to share them securely between different codespaces. When you create a set of secrets for a private image registry, you need to replace the “<*>” in the name with a consistent identifier. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)" and "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)." - -For example, if you had a private image registry in Azure, you could create the following secrets: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/ru-RU/content/codespaces/codespaces-reference/index.md b/translations/ru-RU/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index 2aef87d83a..0000000000 --- a/translations/ru-RU/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Reference -intro: 'This section contains references that will allow you to be successful with {% data variables.product.prodname_codespaces %}' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ru-RU/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/ru-RU/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index 6284b0674a..0000000000 --- a/translations/ru-RU/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Troubleshooting your codespace -intro: Use this guide to help you troubleshoot common issues with your codespace. -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Known Limitations - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### {% data variables.product.prodname_vscode %} troubleshooting - -Use **Issues** in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository to check for known issues or to log issues about the {% data variables.product.prodname_vscode %} experience. - - -### Configuration troubleshooting - -{% data reusables.codespaces.recovery-mode %} - -``` -This codespace is currently running in recovery mode due to a container error. -``` - -Review the creation logs, update the configuration as needed, and run **Codespaces: Rebuild Container** in the command palette to retry. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." - -### dotfiles troubleshooting - -- Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. -- Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - - If your dotfiles were cloned, try manually re-running your install script to verify it's executable. - - If your dotfiles weren't cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. -- Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. Alternatively, you can view the `creation.log` by navigating to the command palette and entering **Codespaces: View Creation Log**. - - -### Browser troubleshooting - -If you encounter issues while using a browser that is not Chromium-based, try switching to a Chromium-based browser, or check for known issues with your browser in the `microsoft/vscode` repository by searching for issues labeled with the name of your browser, such as[`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) or [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari). - -If you encounter issues while using a Chromium-based browser, you can check if you're experiencing another known issue with {% data variables.product.prodname_vscode %} in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository. - -### Container storage troubleshooting - -When you create a codespace, it has a finite amount of storage and over time it may be necessary for you to free up space. Try any of the following items to free up storage space. - -- Remove packages that are no longer by using `sudo apt autoremove` -- Clean the apt cache by using `sudo apt clean` -- Delete unneeded files like build artifacts and logs (these are very project-dependent) -- See the top 10 largest files in the codespace: `sudo find / -printf '%s %p\n'| sort -nr | head -10` - -More destructive options: -- Remove unused Docker images, networks, and containers by using `docker system prune` (append `-a` if you want to remove all images, and `--volumes` if you want to remove all volumes) -- Remove untracked files from working tree: `git clean -i` - -### Contact us - -If you still need help, you can contact us. For more information, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)." diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index 19fc36dfc5..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Creating a codespace -intro: You can create a codespace for a branch in a repository to develop online. -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About codespace creation - -You can create a codespace on either {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %} - -Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)." - - -When you create a codespace, a number of steps happen to enable full access to your development environment. - -- Resources such as a VM and storage for your container are assigned. A new VM is created every time you create or start a codespace to ensure that you always have the latest versions and security patches. -- {% data variables.product.prodname_codespaces %} recieves information about your repository, branch, commits, your public dotfiles repository, and any secrets that you have created. -- {% data variables.product.prodname_codespaces %} executes a shallow clone of the repository. -- If you have one in your repository, {% data variables.product.prodname_codespaces %} runs the `devcontainer.json` file. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." -- Your Docker container, `docker-compose`, or other initialization is run. -- At this point, the codespace is marked as available and you can connect. -- Once the codespace is made available, depending on the commands in the devcontainer, the codespace will continue with some set up. - - The codespace shares ports added in the `devcontainer.json` file. - - The codespace runs anything specified in `postCreateCommand`. - - {% data variables.product.prodname_codespaces %} clones your dotfiles repository to the codespaces environment and looks for an install file. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." - - Finally, the codespace does a full clone of the repo so you have full access to it. - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### Creating a codespace - -{% data reusables.repositories.navigate-to-repo %} -2. Under the repository name, use the "Branch" drop-down menu, and select the branch you want to create a codespace for. - - ![Branch drop-down menu](/assets/images/help/codespaces/branch-drop-down.png) - -3. Under the repository name, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. To create a codespace using a Standard machine type, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index 7140114c9f..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Deleting a codespace -intro: You can delete a codespace you no longer need. -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. Navigate to the repository where you created the codespace. Select **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** and then click {% octicon "gear" aria-label="The Settings gear" %}. This will display all {% data variables.product.prodname_codespaces %} that you have created in the repository. ![Codespaces tab](/assets/images/help/codespaces/codespaces-manage.png) - - Alternatively, you can see every codespace owned by your user account at [github.com/codespaces](https://github.com/codespaces). - -2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete** ![Delete button](/assets/images/help/codespaces/delete-codespace.png) - -### Deleting a codespace in {% data variables.product.prodname_vscode %} - -For information on deleting a codespace in {% data variables.product.prodname_vscode %}, see "[Using Codespaces in Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)." \ No newline at end of file diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index a3ae678e34..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Developing in a codespace -intro: 'You can open a codespace on {% data variables.product.product_name %}, then develop using {% data variables.product.prodname_vscode %}''s features.' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About development with {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} - -![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. Side Bar - By default, this area shows your project files in the Explorer. -2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. -3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it. -4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. -5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. - -For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." - -#### Personalizing your codespace - -{% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)." - -{% data reusables.codespaces.apply-devcontainer-changes %} For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." - -#### Running your app from a codespace -{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)." - -#### Committing your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Navigating to an existing codespace - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. Click the name of the codespace you want to develop in. ![Name of codespace](/assets/images/help/codespaces/click-name-codespace.png) - -Alternatively, you can see any active codespaces for a repository by navigating to the repository in which it was made and selecting **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**. diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index 7965bfc793..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Forwarding ports in your codespace -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About forwarded ports - -Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on port 4000, you can access the application from your browser to test and debug the application. - -When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards the port. You can click on the URL in the terminal to open the port in a browser. For example, if an application outputs `http://127.0.0.1:4000` or `http://localhost:4000` to the console, the log would automatically convert the output to a clickable URL for port 4000. - -![Automatic port forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) - -You can also forward a port manually, label forwarded ports, share fowarded ports publicly, and add forwarded ports to the codespace configuration. - -### Forwarding a port - -You can manually forward a port that wasn't forwarded automatically. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Under the list of ports, click **Add port**. ![Add port button](/assets/images/help/codespaces/add-port-button.png) -1. Type the port number or address, then press enter. ![Text box to type port button](/assets/images/help/codespaces/port-number-text-box.png) - -### Labeling a port - -You can label a port to make the port more easily identifiable in a list. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Hover over the port you want to label, then click the label icon. ![Label icon for port](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### Sharing a port - -If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to share, then click **Make Public**. ![Option to make port public in right-click menu](/assets/images/help/codespaces/make-public-option.png) -1. To the right of the local address for the port, click the copy icon. ![Copy icon for port URL](/assets/images/help/codespaces/copy-icon-port-url.png) -1. Send the copied URL to the person you want to share the port with. - -### Adding a port to the codespace configuration - -You can add a forwarded port to the {% data variables.product.prodname_codespaces %} configuration for the repository, so the port will automatically be forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -You can manually configure fowarded ports in a `.devcontainer.json` file using the `forwardPorts` property, or you can use the "Ports" panel in your codespace. - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. Right click the port you want to add to the codespace configuration, then click **Set Label and Update devcontainer.json**. ![Option to set label and add port to devcontainer.json in the right-click menu](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/index.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index 555995eabc..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Developing in a codespace -intro: 'Create a codespace to get started with developing your project inside a dedicated cloud environment. You can use forwarded ports to run your application and even use codespaces inside {% data variables.product.prodname_vscode %}' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index 3cac79d040..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Using Codespaces in Visual Studio Code -intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### Требования - -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. - -Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation. - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Click **Sign in to view {% data variables.product.prodname_dotcom %}...**. ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. -4. Sign in to {% data variables.product.product_name %} to approve the extension. - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**. ![The {% data variables.product.prodname_codespaces %} header](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**. ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. -5. Sign in to {% data variables.product.product_name %} to approve the extension. - -{% endwindows %} - -### Creating a codespace in {% data variables.product.prodname_vscode %} - -After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_github_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}. - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Click the Add icon, then click **Create New Codespace**. ![The Create new Codespace option in {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/create-codespace-vscode.png) -3. Type, then click the repository's name you want to develop in. ![Searching for repository to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-repository-vscode.png) -4. Click the branch you want to develop on. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Click the machine type you want to develop in. ![Instance types for a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-sku-vscode.png) -### Opening a codespace in {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. Under "Codespaces", click the codespace you want to develop in. -3. Click the Connect to Codespace icon. ![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### Changing the machine type in {% data variables.product.prodname_vscode %} - -{% data reusables.codespaces.codespaces-machine-types %} - -You can change the machine type of your codespace at any time. - -1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). -2. Search for and select "Codespaces: Change Machine Type." ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Click the codespace that you want to change. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Choose the machine type you want to use. ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. - -### Deleting a codespace in {% data variables.product.prodname_vscode %} - -1. Under "Codespaces", right-click the codespace you want to delete. -2. In the drop-down menu, click **Delete Codespace**. ![Deleting a codespace in {% data variables.product.prodname_dotcom %}](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/ru-RU/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/ru-RU/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index 0754b0ad6d..0000000000 --- a/translations/ru-RU/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Using source control in your codespace -intro: 'After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### About source control in {% data variables.product.prodname_codespaces %} - -You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. - -Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." - -A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: - -* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." -* In your codespace, create a new branch to work on. -* Make your changes and save them. -* Commit the change. -* Raise a pull request. - -### Creating or switching branches - -1. If the current branch is not shown in the status bar, at the bottom of your codespace, right-click the status bar and select **Source control**. -1. Click the branch name in the status bar. ![The branch in the status bar](/assets/images/help/codespaces/branch-in-status-bar.png) -1. In the drop-down, either click the branch you want to switch to, or enter the name for a new branch and click **Create new branch**. ![Choose from the branch menu](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**Tip**: If someone has changed a file on the remote repository, in the branch you switched to, you will not see those changes until you pull the changes into your codespace. - -{% endtip %} - -### Pulling changes from the remote repository - -You can pull changes from the remote repository into your codespace at any time. - -{% data reusables.codespaces.source-control-display-dark %} -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. In the drop-down menu, click **Pull**. - -If a dev container has been changed since you created the codespace you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)." - -### Setting your codespace to automatically fetch new changes - -You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. - -If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. - -1. Click the **Manage** button at the bottom of the Activity Bar. ![Manage button](/assets/images/help/codespaces/manage-button.png) -1. In the menu, slick **Settings**. -1. On the Settings page, search for: `autofetch`. ![Search for autofetch](/assets/images/help/codespaces/autofetch-search.png) -1. To fetch details of updates for all remotes registered for the current repository, set **Git: Autofetch** to `all`. ![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png) -1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**. - -### Committing your changes - -{% data reusables.codespaces.source-control-display-dark %} -1. To stage your changes, click **+** next to the file you've changed, or next to **Changes** if you've changed multiple files and you want to stage them all. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. Type a commit message describing the change you've made. ![Source control side bar with a commit message](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. To commit your staged changes, click the check mark at the top the source control side bar. ![Click the check mark icon](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### Raising a pull request - -1. After you've committed changes to your local copy of the repository, click the **Create Pull Request** icon. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description. ![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. Click **Create**. - -### Pushing changes to your remote repository - -You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. - -1. At the top of the side bar, click the ellipsis (**...**). ![Ellipsis button for View and More Actions](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. In the drop-down menu, click **Push**. diff --git a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index 4b7bfcf855..0000000000 --- a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Getting started with your C# (.NET) project in Codespaces -shortTitle: Getting started with your C# (.NET) project -allowTitleToDifferFromFilename: true -intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Требования - -- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project ](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. Click the recommended version of .NET. ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Файл Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the .NET Core version that we want to use. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Файл Dockerfile - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "dotnet restore", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - - ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via pip3. With our dependencies now installed, we can run our application. - -1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Дальнейшие шаги - -You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index 8169ac2a3e..0000000000 --- a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: Getting started with your Java project in Codespaces -shortTitle: Getting started with your Java project -intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Требования - -- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. Click the recommended version of Java. ![Java version selection](/assets/images/help/codespaces/add-java-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Файл Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Файл Dockerfile - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`. - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm. - -1. Run your application by pressing `F5`. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Дальнейшие шаги - -You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index fe41bc2570..0000000000 --- a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Getting started with your Node.js project in Codespaces -shortTitle: Getting started with your Node.js project -intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Требования - -- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. Click the recommended version of Node.js. ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Файл Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Name** - You can name your dev container anything, this is just the default. -- **Build** - The build properties. - - **dockerfile** - In the build object, dockerfile is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. -- **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. - -##### Файл Dockerfile - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. - -1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to exand the `.devcontainer` folder to see it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Add the following lines to your `devcontainer.json` file after `extensions`: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) in the {% data variables.product.prodname_vscode %} docs. - -3. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm. - -1. Run your start command in the terminal with`npm start`. - - ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Дальнейшие шаги - -You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index 9df77249c6..0000000000 --- a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: Getting started with your Python project in Codespaces -shortTitle: Getting started with your Python project -intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. - -#### Требования - -- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. -- You must have {% data variables.product.prodname_codespaces %} enabled for your organization. - -### Step 1: Open your project in a codespace - -1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. - -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. - -{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -### Step 2: Add a dev container to your codespace from a template - -The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. - -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." - - -1. Access the command palette (`shift command P` / `shift control P`), then start typing "dev container". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgresSQL. ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. Click the recommended version of Python. ![Python version selection](/assets/images/help/codespaces/add-python-version.png) -4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) -5. To rebuild your container, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### Anatomy of your dev container - -Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files: - -- `devcontainer.json` -- Файл Dockerfile - -The newly added `devcontainer.json` file defines a few properties that are described after the sample. - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - You can name our dev container anything, this is just the default. -- **Build** - The build properties. - - **Dockerfile** - In the build object, `dockerfile` is a reference to the Dockerfile that was also added from the template. - - **Args** - - **Variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **Settings** - These are {% data variables.product.prodname_vscode %} settings. - - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. -- **Extensions** - These are extensions included by default. - - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. -- **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. -- **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. - -##### Файл Dockerfile - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. - -### Step 3: Modify your devcontainer.json file - -With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependancies when your codespace launches. - -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) - -2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. To rebuild your container and apply the devcontainer.json changes, access the command palette (`shift command P` / `shift control P`), then start typing "rebuild". Click **Codespaces: Rebuild Container**. - - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. - -5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - - ![Extensions list](/assets/images/help/codespaces/python-extensions.png) - -### Step 4: Run your application - -In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. - -1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - -### Step 5: Commit your changes - -{% data reusables.codespaces.committing-link-to-procedure %} - -### Дальнейшие шаги - -You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios. - -- [Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [Managing GPG verification for {% data variables.product.prodname_codespaces %}](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/index.md b/translations/ru-RU/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index 396851c0bb..0000000000 --- a/translations/ru-RU/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Getting Started with {% data variables.product.prodname_codespaces %}' -intro: 'Learn how to get started with {% data variables.product.prodname_codespaces %}, including set up and configuration for specific languages.' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ru-RU/content/codespaces/guides.md b/translations/ru-RU/content/codespaces/guides.md deleted file mode 100644 index 8c3032ac5a..0000000000 --- a/translations/ru-RU/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Codespaces guides -shortTitle: Руководства -intro: 'Learn how to make the most of GitHub {% data reusables.gated-features.codespaces %}' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/ru-RU/content/codespaces/index.md b/translations/ru-RU/content/codespaces/index.md deleted file mode 100644 index d7c9926f2c..0000000000 --- a/translations/ru-RU/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GitHub Codespaces Documentation -beta_product: true -shortTitle: GitHub Codespaces -intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.' -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index 7d7055b862..0000000000 --- a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Managing Codespaces for your organization -intro: 'You can manange and review how users in your organization can use {% data variables.product.prodname_github_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index f3d0f9eb29..0000000000 --- a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Managing access and security for your organization's codespaces -shortTitle: Managing access and security for your organization -intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -Organization owners can manage which repositories a codespace can access. - -By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read and write permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust. - -To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "Access and security", select the setting you want for your organization. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index ac148f188a..0000000000 --- a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Managing encrypted secrets for your repository and organization for Codespaces -shortTitle: Managing secrets for your repository and organization -intro: 'Encrypted secrets allow you to store sensitive information in your organization, repository, or {% data variables.product.prodname_codespaces %}.' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### About secrets - -Secrets are encrypted environment variables that you create in an organization or repository. The secrets that you create are available to use in {% data variables.product.prodname_codespaces %}. GitHub uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before they reach GitHub and only decrypts them when you use them in a codespace. - -Organization-level secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. - - {% data reusables.codespaces.secret-precedence %} - -#### Limits for secrets - -You can store up to 100 secrets per organization and 100 secrets per repository. - -Secrets are limited to 64 KB in size. - -### Adding secrets for a repository - -To create secrets for an organization repository, you must have administrator access. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. At the top of the page, click **New repository secret**. -1. Type a name for your secret in the **Name** input box. -1. Enter the value for your secret. -1. Click **Add secret**. - -### Adding secrets for an organization - -When creating a secret in an organization, you can use a policy to limit which repositories can access that secret. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories. - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. Scroll down the page and under **Secrets**, select **Codespaces**. ![Codespaces option in side bar](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. At the top of the page, click **New organization secret**. -1. Type a name for your secret in the **Name** input box. -1. Enter the **Value** for your secret. -1. From the **Repository access** dropdown list, choose an access policy. ![Repository Access list with private repositories selected](/assets/images/help/codespaces/secret-repository-access.png) -1. Click **Add secret**. - -### Reviewing access to organization-level secrets - -You can check which access policies are applied to a secret in your organization. - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. The list of secrets includes any configured permissions and policies. Например: ![Secrets list](/assets/images/help/settings/actions-org-secrets-list.png) -1. For more details on the configured permissions for each secret, click **Update**. diff --git a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index f8c2c9ac71..0000000000 --- a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Managing user permissions for your organization -intro: You can control which users in your organization can use {% data variables.product.prodname_codespaces %}. -permissions: To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner. -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### About user permissions for {% data variables.product.prodname_codespaces %} - -Organization owners can control which users in your organization can create and use codespaces. - -To use codespaces in your organization, your users must have at least write access to the repositories where they want to use a codespace. You can enable codespaces for all users in your organization, or only specific users. - -By default, a codespace can only access the repository where it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -### Configuring which users in your organization can use {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select one of the following options: - - * **Disabled** to not allow any organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - - ![Radio buttons for "User permissions"](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index c438a70311..0000000000 --- a/translations/ru-RU/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Reviewing your organization's audit logs for Codespaces -shortTitle: Reviewing your organization's audit logs -intro: 'You can use the audit log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -When any member of your organization performs an action related to {% data variables.product.prodname_codespaces %}, you can review the actions in the audit log. For information about accessing the log, see "[Reviewing your audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)." - -![Audit log with Codespaces information](/assets/images/help/settings/codespaces-audit-log-org.png) - -The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)." diff --git a/translations/ru-RU/content/codespaces/managing-your-codespaces/index.md b/translations/ru-RU/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 142e6c292d..0000000000 --- a/translations/ru-RU/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing your codespaces -intro: 'You can use {% data variables.product.prodname_github_codespaces %} settings to manage information that your codespace might need.' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index 44504fbaa6..0000000000 --- a/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing access and security for your codespaces -intro: You can manage the repositories that {% data variables.product.prodname_codespaces %} can access. -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read and write permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Access and security", select the setting you want for your user account. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index 6ad3cdee4a..0000000000 --- a/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Managing encrypted secrets for your codespaces -intro: 'You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### About encrypted secrets for {% data variables.product.prodname_codespaces %} - -You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. - -- Personal access tokens to cloud services -- Service principals -- Subscription identifiers -- [Credentials for a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret. - -{% data reusables.codespaces.secrets-on-start %} - -#### Naming secrets - -{% data reusables.codespaces.secrets-naming %} For example, a secret created at the repository level must have a unique name in that repository. - - {% data reusables.codespaces.secret-precedence %} - -#### Limits for secrets - -You can store up to 100 secrets for {% data variables.product.prodname_codespaces %}. - -Secrets are limited to 64 KB in size. - -### Adding a secret - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. To the right of "Codespaces secrets", click **New secret**. !["New secret" button](/assets/images/help/settings/codespaces-new-secret-button.png) -1. Under "Name", type a name for your secret. !["Name" text box](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Click **Add secret**. - -### Editing a secret - -You can update the value of an existing secret, and you can change which repositories can access a secret. - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Codespaces secrets", to the right of the secret you want to edit, click **Update**. !["Update" button](/assets/images/help/settings/codespaces-secret-update-button.png) -1. Under "Value", click **enter a new value**. !["enter a new value" link](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. Optionally, to remove the secret's access to a repository, deselect the repository. ![Checkboxes to remove access to repositories](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. Click **Save changes**. - -### Deleting a secret - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "Codespaces secrets", to the right of the secret you want to delete, click **Delete**. !["Delete" button](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. Read the warning, then click **OK**. ![Confirmation to delete secret](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index c9492f1760..0000000000 --- a/translations/ru-RU/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Managing GPG verification for Codespaces -intro: 'You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. Under "GPG verification", select the setting you want for GPG verification. ![Radio buttons to manage GPG verification](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. If you chose "Selected repositories", select the drop-down menu, then click a repository you want enable GPG verification for. Repeat for all repositories you want to enable GPG verification for. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/ru-RU/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/ru-RU/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index f7e213e258..0000000000 --- a/translations/ru-RU/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Reviewing your security logs for Codespaces -shortTitle: Reviewing your security logs -intro: 'You can use the security log to review all actions related to {% data variables.product.prodname_codespaces %}.' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### About security logs for {% data variables.product.prodname_codespaces %} - -When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your user account, you can review the actions in the security log. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." - -![security log with Codespaces information](/assets/images/help/settings/codespaces-audit-log.png) - -The security log includes details on what action occured and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". diff --git a/translations/ru-RU/content/codespaces/quickstart.md b/translations/ru-RU/content/codespaces/quickstart.md deleted file mode 100644 index 4fc600a396..0000000000 --- a/translations/ru-RU/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Quickstart for GitHub Codespaces -intro: 'Try out {% data variables.product.prodname_codespaces %} in 5 minutes or less.' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### Introduction - -In this guide, you'll create a codespace from the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces) and explore some of the essential features available to you within the codespace. - -The following example shows you how to create a codespace, connect to a forwarded port to view your running application, and personalize your setup with additional extensions and dotfiles. - -### Creating your codespace - -1. Navigate to the main page of the [sample repository](https://github.com/2percentsilk/haikus-for-codespaces). - -2. Under the repository name, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. - - ![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. To create a codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - -### Run the application - -With your project open in a codespace, you can now run the application and launch it in a browser. - -1. Start the application by entering `npm run dev` in the terminal. This command executes the `dev` script in the package.json file and starts up the web application defined in the sample repository. - - ![npm run dev in terminal](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. - - ![Port forwarding toast](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. Click **Open in Browser** to view your running application in a new tab. - -### Personalize with a theme extension - -Within a codespace, you have access to the Visual Studio Code Marketplace. For this example, you'll install an extension that alters the theme but you can install any extension that is useful for your workflow. - -1. In the left sidebar, click the Extensions icon. - -2. In the search bar, enter `fairyfloss` and install the fairyfloss extension. - - ![Add an extension](/assets/images/help/codespaces/add-extension.png) - -3. Select the `fairyfloss` theme by selecting it from the list. - - ![Select the fairyfloss theme](/assets/images/help/codespaces/fairyfloss.png) - -4. Changes you make to your editor setup in the current codespace, such as theme and keyboard bindings, are synced automatically to other codespaces via [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). - -### Personalize with dotfiles - -If your user account on GitHub owns a public repository named dotfiles, GitHub automatically uses this repository to personalize your codespace environment during codespace creation. - -This example guides you through creating a dotfiles repository for your codespaces. - -1. Navigate to the sample [dotfiles repository](https://github.com/aw-test-93/dotfiles/). - -2. Fork the repository to your account and ensure it's public. - - Verify the repository created under your account is named dotfiles, for example `yourname/dotfiles`. Any other name will cause {% data variables.product.prodname_codespaces %} to ignore the repository for personalization. - -3. Create a new codespace from the [sample application repository](https://github.com/2percentsilk/haikus-for-codespaces) as dotfile updates are only applied at creation time. The sample dotfiles will change the command prompt to bold purple and blue text. - - ![Custom command prompt](/assets/images/help/codespaces/custom-prompt.png) - -### Next Steps - -You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_codespaces %}. - - "[Getting Started guides](/codespaces/getting-started-with-codespaces)" for using {% data variables.product.prodname_codespaces %} with specific languages - - [Create a custom configuration](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project) to configure {% data variables.product.prodname_codespaces %} for your project. \ No newline at end of file diff --git a/translations/ru-RU/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/ru-RU/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index 9df28ebec6..0000000000 --- a/translations/ru-RU/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: Configuring Codespaces for your project -intro: 'You can use a `devcontainer.json` file to define a {% data variables.product.prodname_codespaces %} environment for your repository.' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About dev containers - -A development container, or dev container, is the environment that {% data variables.product.prodname_codespaces %} uses to provide the tools and runtimes that your project needs for development. When working with a dev container in {% data variables.product.prodname_codespaces %} you can either [use the default configuration](#using-the-default-configuration), [use a pre-defined configuration](#using-a-pre-defined-container-configuration), or [create your own configuration](#creating-a-custom-codespace-configuration). The option you choose is dependent on the tools, runtimes, dependencies, and workflows that a user might need to be successful with your project. - -{% data variables.product.prodname_codespaces %} allows for customization on a per-project and per-branch basis with a `devcontainer.json` file. This configuration file determines the environment of every new codespace anyone creates for your repository by defining a development container that can include frameworks, tools, extensions, and port forwarding. A Dockerfile can also be used alongside the `devcontainer.json` file in the `.devcontainer` folder to define everything required to create a container image. - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`. - -For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation. - -#### Файл Dockerfile - -A Dockerfile also lives in the `.devcontainer` folder. - -You can add a Dockerfile to your project to define a container image and install software. In the Dockerfile, you can use `FROM` to specify the container image. - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -You can use the `RUN` instruction to install any software and `&&` to join commands. - -Reference your Dockerfile in your `devcontainer.json` file by using the `dockerfile` property. - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -For more information on using a Dockerfile in a dev container, see [Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile) in the {% data variables.product.prodname_vscode %} documentation. - -### Using the default configuration - -If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace with a base Linux image. The base Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the url that the command outputs. - -Alternatively, for more information about everything that is included in the base Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. - -The default configuration is a good option if you're working on a small project that uses the languages and tools that {% data variables.product.prodname_codespaces %} provides. - - -### Using a predefined container configuration - -Predefined container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. - -Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup. - -1. To access the command palette, in the upper-left corner, select the Application Menu and click **Command Palette…** from the **View** menu, then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...** !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. Click the definition you want to use. ![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. Follow the prompts to customize your definition. -1. Click **OK**. ![OK button](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) - - -### Creating a custom codespace configuration - -If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %} - -In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. - -{% data reusables.codespaces.vscode-settings-order %} - -You can define default editor settings for {% data variables.product.prodname_vscode %} in two places. - -* Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace. -* Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace. - -After updating the `devcontainer.json` file, you can rebuild the container for your codespace to apply the changes. For more information, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." - - - - -### Applying changes to your configuration - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %} -!["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. ![Error message about recovery mode](/assets/images/help/codespaces/recovery-mode-error-message.png) - - To diagnose the error by reviewing the creation logs, click **View creation log**. - - To fix the errors identified in the logs, update your `devcontainer.json` file. - - To apply the changes, rebuild your container. {% data reusables.codespaces.rebuild-command %} diff --git a/translations/ru-RU/content/codespaces/setting-up-your-codespace/index.md b/translations/ru-RU/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index f47cc82ec3..0000000000 --- a/translations/ru-RU/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Setting up your codespace -intro: '{% data variables.product.prodname_codespaces %} is a dedicated environment for you. You can configure your codespace with a dev container to install your dependencies or you can add a dotfile to personalize the user settings.' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/ru-RU/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/ru-RU/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index 79c3c244d9..0000000000 --- a/translations/ru-RU/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Personalizing Codespaces for your account -intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### About personalizing {% data variables.product.prodname_codespaces %} - -When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces. - -- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}. -- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations. - -{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create. - -Project maintainers can also define a default configuration that applies to every codespace for a repository, created by anyone. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)." - -### Settings Sync - -Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}. - -Settings Sync is on by default. To configure any settings, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is on**. From the dialog, you can choose to configure, show settings and data, or turn off Settings Sync. - -![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode %} documentation. - -### Dotfiles - -Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your `dotfiles` repository, see [GitHub does dotfiles](https://dotfiles.github.io/). - -If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named `dotfiles`, {% data variables.product.prodname_dotcom %} automatically uses this repository to personalize your codespace environment. Private `dotfiles` repositories are not currently supported. - -Your `dotfiles` repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make. - -When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your `dotfiles` repository to the codespace environment, and looks for one of the following files to set up the environment. - -* _install.sh_ -* _install_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. - -Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace. - -{% note %} - -**Note:** Currently, {% data variables.product.prodname_codespaces %} does not support personalizing the _User_ settings for the {% data variables.product.prodname_vscode %} editor with your `dotfiles` repository. You can set default _Workspace_ and _Remote [Codespaces]_ settings for a specific project in the project's repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)." - -{% endnote %} - -You can also configure settings for your user account to add encrypted secrets, enable GPG verification, and allow your codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." - -### Дополнительная литература - -* "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/ru-RU/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/ru-RU/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index 8a1128db5e..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %} is free to use during the beta. When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage. diff --git a/translations/ru-RU/data/reusables/codespaces/about-configuration.md b/translations/ru-RU/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 398b2495a6..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -You can create a default codespace configuration for your repository that determines the environment of every new codespace anyone creates for that repository. The configuration defines a development container that can include frameworks, tools, extensions, and port forwarding. diff --git a/translations/ru-RU/data/reusables/codespaces/about-personalization.md b/translations/ru-RU/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index 958370ebd8..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -You can also use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. diff --git a/translations/ru-RU/data/reusables/codespaces/about-port-forwarding.md b/translations/ru-RU/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index 39b29dc4a0..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -You can forward ports in your codespace to test and debug your application. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/ru-RU/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index 8031bfb4af..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -After the {% data variables.product.prodname_codespaces %} configuration for a repository changes, you can apply the changes to an existing codespace by rebuilding the container for the codespace. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/beta-functionality-limited.md b/translations/ru-RU/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 25501d28f0..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -During the beta, functionality is limited. -- {% data reusables.codespaces.use-chrome %} -- Only a single size of codespace is available. -- Only Linux containers are supported. -- A codespace is not fully resumable. Processes that were running at the time the codespace was stopped will not be restarted. diff --git a/translations/ru-RU/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/ru-RU/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index 5e0618af02..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. In {% data variables.product.prodname_vscode %}, in the left sidebar, click the Remote Explorer icon. ![The Remote Explorer icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/codespace-config-order.md b/translations/ru-RU/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index e785e51c45..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -Your `dotfiles` personalization is applied before a repository's default codespace configuration. diff --git a/translations/ru-RU/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/ru-RU/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index 146beb47e8..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -Each codespace is associated with a specific branch of a repository. diff --git a/translations/ru-RU/data/reusables/codespaces/codespaces-are-personal.md b/translations/ru-RU/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index 771fe3f97c..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -Each codespace you create is only available to you. No one else can work in your codespace. diff --git a/translations/ru-RU/data/reusables/codespaces/codespaces-machine-types.md b/translations/ru-RU/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index 475114c1c5..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -You can run your codespace on a choice of three types of remote machine: Basic, Standard, or Premium. Each of these has a different level of resources and a different billing tier.{% note %} - -**Note:** {% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -Switching machine types gives you the flexibility to choose the most appropriate resources for your work. Certain tasks may require different machine types: - -* **Basic** for updating a file and raising a pull request -* **Standard** for editing a website -* **Premium** for high compute tasks such as data analysis diff --git a/translations/ru-RU/data/reusables/codespaces/committing-link-to-procedure.md b/translations/ru-RU/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 87bfa539ff..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding {% data variables.product.prodname_vscode %} extensions, will appear for all users. - -For information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)." \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/ru-RU/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index 40126da0da..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -You can create more than one codespace per repository or even per branch. However, each user account has a two-codespace limit during limited public beta. If you've reached the limit and want to create a new codespace, you must delete a codespace first. diff --git a/translations/ru-RU/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/ru-RU/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index 045387a57b..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -You can connect to your codespace directly from {% data variables.product.prodname_vscode %}. For more information, see "[Using Codespaces in {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)." diff --git a/translations/ru-RU/data/reusables/codespaces/devcontainer-location.md b/translations/ru-RU/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index 196fc006be..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -This file can be located in the root of the repository or in a folder called `.devcontainer`. If the file is located in the root of the repository, the filename must begin with a period: `.devcontainer.json`. diff --git a/translations/ru-RU/data/reusables/codespaces/navigate-to-codespaces.md b/translations/ru-RU/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index 4ba7c260e0..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. At the top of any page, click **Codespaces**. ![{% data variables.product.prodname_codespaces %} link in header](/assets/images/help/codespaces/header-link.png) diff --git a/translations/ru-RU/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/ru-RU/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index fed860897b..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In your codespace, under the text editor, click "Ports". ![Ports tab](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/ru-RU/data/reusables/codespaces/rebuild-command.md b/translations/ru-RU/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index ea9e45b032..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -Access the command palette (`shift command P` / `shift control P`), then start typing "Codespaces: Rebuild Container". Click **Codespaces: Rebuild Container**. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/recovery-mode.md b/translations/ru-RU/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index fa4e73d013..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -If changes to your codespace's configuration cause a container error, your codespace will run in recovery mode, and you will see an error message. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/release-stage.md b/translations/ru-RU/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 57e551dd72..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** {% data variables.product.prodname_codespaces %} is currently in limited public beta and subject to change. For more information about joining the beta, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)." - -{% endnote %} diff --git a/translations/ru-RU/data/reusables/codespaces/secret-precedence.md b/translations/ru-RU/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index 582b91c1aa..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/secrets-naming.md b/translations/ru-RU/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index eddb8aa7f5..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -The following rules apply to secret names: - -* Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. -* Secret names must not start with the `GITHUB_` prefix. -* Secret names must not start with a number. -* Secret names are not case-sensitive. -* Secret names must be unique at the level they are created at. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/secrets-on-start.md b/translations/ru-RU/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index c4a5bf3b41..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to suspend the codespace and resume it. \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/source-control-display-dark.md b/translations/ru-RU/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index 90b3503dcd..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. ![Source control view](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/source-control-display.md b/translations/ru-RU/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index 09917cd3c8..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the Activity Bar, click the **Source Control** view. - - ![Source control view](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/type-port-label.md b/translations/ru-RU/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index 498c9eb752..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. Type a label for your port, then press enter. ![Text box to type label for port](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/codespaces/unsupported-repos.md b/translations/ru-RU/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index 03fd9189d9..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -During the beta, private repositories owned by organizations or any repositories owned by an organization that requires SAML single sign-on are not supported. diff --git a/translations/ru-RU/data/reusables/codespaces/use-chrome.md b/translations/ru-RU/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index c44bb64faf..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -For the best experience with {% data variables.product.prodname_codespaces %}, we recommend using a Chromium-based browser, like Google Chrome or Microsoft Edge. diff --git a/translations/ru-RU/data/reusables/codespaces/use-visual-studio-features.md b/translations/ru-RU/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index a5b1cf9151..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -You can edit code, debug, and use Git commands while developing in a codespace with {% data variables.product.prodname_vscode %}. For more information, see the [{% data variables.product.prodname_vscode %} documentation](https://code.visualstudio.com/docs). diff --git a/translations/ru-RU/data/reusables/codespaces/vscode-settings-order.md b/translations/ru-RU/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index fc4b840129..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -When you configure editor settings for {% data variables.product.prodname_vscode %}, there are three scopes available: _Workspace_, _Remote [Codespaces]_, and _User_. If a setting is defined in multiple scopes, _Workspace_ settings take priority, then _Remote [Codespaces]_, then _User_. diff --git a/translations/ru-RU/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/ru-RU/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index afb626e71c..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -You can see every available codespace that you have created at [github.com/codespaces](https://github.com/codespaces). diff --git a/translations/ru-RU/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/ru-RU/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index a5e98437c0..0000000000 --- a/translations/ru-RU/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the top right corner of {% data variables.product.product_name %}, click your profile photo, then click **Your codespaces**. - - !['Your codespaces' menu option](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/gated-features/codespaces.md b/translations/ru-RU/data/reusables/gated-features/codespaces.md deleted file mode 100644 index 1423451c5e..0000000000 --- a/translations/ru-RU/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -Codespaces is available for user accounts using {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/ru-RU/data/reusables/organizations/click-codespaces.md b/translations/ru-RU/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index 6a15dd7757..0000000000 --- a/translations/ru-RU/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. In the left sidebar, click **Codespaces**. !["Codespaces" tab in left sidebar](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/ru-RU/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/ru-RU/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index ae43f35c1f..0000000000 --- a/translations/ru-RU/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. Select the "Repository access" drop-down menu, then click a repository you want to have access to the secret. Repeat for every repository you want to have access to the secret. !["Repository access" drop-down menu](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/user_settings/codespaces-secret-value.md b/translations/ru-RU/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index 82cb0fbffe..0000000000 --- a/translations/ru-RU/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. Under "Value", type the value of your secret. !["Value" textbox](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/ru-RU/data/reusables/user_settings/codespaces-tab.md b/translations/ru-RU/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index e4908fcf75..0000000000 --- a/translations/ru-RU/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. In the left sidebar, click **Codespaces**. ![Codespaces tab in the user settings sidebar](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/translations/zh-CN/content/codespaces/about-codespaces.md b/translations/zh-CN/content/codespaces/about-codespaces.md deleted file mode 100644 index c9322f1344..0000000000 --- a/translations/zh-CN/content/codespaces/about-codespaces.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: 关于 Codespaces -intro: '{% data variables.product.prodname_codespaces %} 是一个可配置的在线开发环境,由 {% data variables.product.prodname_dotcom %} 托管并由 {% data variables.product.prodname_vscode %} 支持,允许您完全在云端开发。' -redirect_from: - - /github/developing-online-with-github-codespaces/about-github-codespaces - - /github/developing-online-with-codespaces/about-codespaces - - /codespaces/getting-started-with-codespaces/about-codespaces -versions: - free-pro-team: '*' -type: overview -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### 关于 {% data variables.product.prodname_codespaces %} - -{% data variables.product.prodname_codespaces %} 是一个可配置的云开发环境,在 {% data variables.product.prodname_dotcom %} 上的浏览器或通过 {% data variables.product.prodname_vscode %} 提供。 - -![开放的代码空间](/assets/images/help/codespaces/codespace-overview.png) - -代码空间包括开发者为特定仓库进行开发所需的一切,包括 {% data variables.product.prodname_vscode %} 编辑体验和常见的语言、工具和实用程序。 {% data variables.product.prodname_codespaces %} 是完全可配置的,允许您为项目创建自定义开发环境,并允许开发者通过扩展和 dotfile 设置个性化他们的体验。 - -通过在整个团队中提供一致的环境、快速启动和创建安全的开发空间,代码空间可为团队提供许多好处。 - -### 一致的环境 - -您可以创建单个代码空间配置,以定义任何人为仓库创建的每个新代码空间的环境(或_开发容器_)。 一旦您完成了配置,开发者就不必担心安装合适的工具进行评论、审查或贡献。 一旦他们从仓库创建代码空间,就已经为他们提供了标准化的环境。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)”。 - -有关特定语言配置入门的帮助,请参阅[入门](/codespaces/getting-started-with-codespaces)教程。 - -虽然从仓库创建的每个代码空间都有一致的开发环境,但开发者可以在需要时在 {% data variables.product.prodname_dotcom %} 上或通过 {% data variables.product.prodname_vscode %} 使用 {% data variables.product.prodname_codespaces %}。 - -### 快速和个性化启动 - -在您的仓库中配置[开发容器](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers)后,任何新开发者都可以通过使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单并选择 **Open with Codespaces(使用代码空间打开)**,快速为项目启动正确的开发环境。 - -![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -由于标准化了可重复的开发者环境,开发者可以在不做任何手动配置的情况下开始使用新的代码空间,并且不需要继续维护其开发者环境。 启动新功能时可以创建新的代码空间。 - -开发者也可以通过使用 [dotfiles](https://dotfiles.github.io/tutorials/) 仓库和 [Settings Sync(设置同步)](https://code.visualstudio.com/docs/editor/settings-sync)来个性化其代码空间环境的各个方面。 个性化可以包括 shell 首选项、其他工具、编辑器设置和扩展,例如 Live Share。 个性化定制是按用户存储的,因此开发者打开的每个代码空间都有即时可用的环境。 更多信息请参阅“[为帐户个性化 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)”。 - -因为可以在浏览器中访问 {% data variables.product.prodname_codespaces %},所以开发者可以通过在选项卡之间切换来处理多个项目。 - -### 安全的环境 - -{% data variables.product.prodname_codespaces %} 允许开发者在云端开发,而不是本地开发。 这将创造单一、可跟踪的真相来源。 开发者可以随时随地任何机器(包括平板电脑或 Chromebooks)上参与项目开发,无需维护知识产权的本地副本。 开发人员必须始终登录并有权访问 {% data variables.product.prodname_codespaces %} 和特定仓库。 这些权限可以随时撤销。 只要您撤销访问权限,这些开发者就会失去对受保护资源的所有访问权限。 此外,经过验证的开发者创建审核跟踪,以便您知道谁在做什么。 有关访问和安全的更多信息,请参阅“[管理您组织的代码空间的访问和安全](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)”。 - -当团队的所有成员都使用它时,使用 {% data variables.product.prodname_codespaces %} 是最安全的。 这意味着没有必要将仓库克隆到本地机器上,开发者也不需要本地安装为 `root`。 - -开发者和组织管理员还可以配置设置以添加加密密码并启用 GPG 验证。 更多信息请参阅“[管理 {% data variables.product.prodname_codespaces %} 的加密密码](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)”、“[管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)”。 - -### 关于 {% data variables.product.prodname_codespaces %} 的计费 - -{% data reusables.codespaces.about-billing-for-codespaces %} 更多信息请参阅“[关于 {% data variables.product.prodname_codespaces %} 的计费](/github/developing-online-with-codespaces/about-billing-for-codespaces)”。 - -### 加入公测 - -将邀请有限数量的人加入公测。 要加入等待列表,请参阅[注册代码空间测试版](https://github.com/features/codespaces/signup)。 - -### 就 {% data variables.product.prodname_codespaces %} 联系我们 - -如果在使用 {% data variables.product.prodname_codespaces %} 时遇到问题,请参阅“[代码空间故障排除](/github/developing-online-with-codespaces/troubleshooting-your-codespace)”。 - -如果您仍需帮助或对 {% data variables.product.prodname_codespaces %} 有反馈,请使用 [Codespaces 反馈](https://github.com/github/feedback/discussions/categories/codespaces-feedback)。 diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/about-billing-for-codespaces.md b/translations/zh-CN/content/codespaces/codespaces-reference/about-billing-for-codespaces.md deleted file mode 100644 index 2ac5dc243c..0000000000 --- a/translations/zh-CN/content/codespaces/codespaces-reference/about-billing-for-codespaces.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 关于代码空间的计费 -intro: '当 {% data variables.product.prodname_codespaces %} 公开发布时,将按存储和计算使用情况计费。' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/about-billing-for-codespaces - - /codespaces/getting-started-with-codespaces/about-billing-for-codespaces -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.about-billing-for-codespaces %} - -代码空间计费模型的更新将在即将发布的公告中分享。 diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md deleted file mode 100644 index e3cfd84de3..0000000000 --- a/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: 允许代码空间访问私有映像注册表 -intro: '您可以使用密钥允许 {% data variables.product.prodname_codespaces %} 访问私有映像注册表' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -注册表是存储和管理私有容器映像(如 Azure 容器注册表或 DockerHub)的安全空间。 您可以在 GitHub 中创建密钥以存储私有注册表的访问权限信息,并使用它们授权代码空间访问存储在注册表中的映像。 - -启动代码空间时,{% data variables.product.prodname_codespaces %} 将检查三个密钥,它们定义了容器注册表的服务器名称、用户名和个人访问令牌 (PAT)。 如果找到这些密钥,{% data variables.product.prodname_codespaces %} 将在代码空间中提供注册表。 - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -您可以在用户、仓库或组织级别存储密钥,从而在不同的代码空间之间安全地共享它们。 当您为私有映像注册表创建一组密钥时,您需要用一致的标识符替换名称中的 “<*>”。 更多信息请参阅“[管理代码空间的加密密码](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)”和“[管理代码空间的仓库和组织加密密码](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)“。 - -例如,如果您在 Azure 中拥有私有映像注册表,则可以创建以下密钥: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![映像注册表密钥示例](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/index.md b/translations/zh-CN/content/codespaces/codespaces-reference/index.md deleted file mode 100644 index 8a07aab3c4..0000000000 --- a/translations/zh-CN/content/codespaces/codespaces-reference/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 参考 -intro: '本节包含帮助您成功使用 {% data variables.product.prodname_codespaces %} 的参考' -versions: - free-pro-team: '*' -children: - - /about-billing-for-codespaces - - /troubleshooting-your-codespace - - /allowing-your-codespace-to-access-a-private-image-registry - - /using-the-command-palette-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md b/translations/zh-CN/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md deleted file mode 100644 index f40de7e6f4..0000000000 --- a/translations/zh-CN/content/codespaces/codespaces-reference/troubleshooting-your-codespace.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: 代码空间疑难解答 -intro: 使用本指南帮助您解决代码空间的常见问题。 -redirect_from: - - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace - - /github/developing-online-with-codespaces/troubleshooting-your-codespace - - /codespaces/working-with-your-codespace/troubleshooting-your-codespace -versions: - free-pro-team: '*' -type: reference -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### 已知限制 - -{% data reusables.codespaces.beta-functionality-limited %} - -{% data reusables.codespaces.unsupported-repos %} - -### {% data variables.product.prodname_vscode %} 故障排除 - -在 [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) 仓库中使用**议题**来检查已知议题或记录有关 {% data variables.product.prodname_vscode %} 体验的议题。 - - -### 配置故障排除 - -{% data reusables.codespaces.recovery-mode %} - -``` -由于容器错误,这个代码空间正在恢复模式中运行。 -``` - -查看创建日志,根据需要更新配置,并在命令面板中运行 **Codespaces: Rebuild Container** 以重试。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)”。 - -### dotfiles 故障排除 - -- 确保您的 dotfiles 仓库是公开的。 如果您的代码空间中有密钥或敏感数据,请使用[代码空间密钥](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces),而不是私人 dotfiles。 -- 检查 `/workspaces/.codespaces/.persistedshare/dotfiles`,查看您的 dotfiles 是否被克隆。 - - 如果您的 dotfiles 被克隆,请尝试手动重新运行安装脚本以验证其可执行性。 - - 如果您的 dotfiles 未被克隆,请检查 `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` 是否存在克隆问题。 -- 检查 `/workspaces/.codespaces/.persistedshare/creation.log` 是否有可能的问题。 或者,您可以通过导航到命令面板并输入 **Codespaces: View Creation Log** 来查看 `creation.log`。 - - -### 浏览器故障排除 - -如果在使用非基于 Chromium 的浏览器时遇到问题,请尝试切换到基于 Chromium 的浏览器,或在 `microsoft/vscode` 仓库中搜索标有您的浏览器名称(如 [`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) 或 [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari))的议题,检查浏览器的已知问题。 - -如果您在使用基于 Chromium 的浏览器时遇到问题,您可以在e [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) 仓库中检查是否遇到 {% data variables.product.prodname_vscode %} 的另一个已知问题。 - -### 容器存储故障排除 - -创建代码空间时,存储量是有限的,随着时间的推移,可能需要释放空间。 尝试以下任何项以释放存储空间。 - -- 使用 `sudo apt autoremove` 删除不再使用的包 -- 使用 `sudo apt clean` 清理 apt 缓存 -- 删除不需要的文件,如构件和日志 (这些文件与项目的依存度很高) -- 查看代码空间中排名前 10 的大文件:`sudo find / -printf '%s %p\n'| sort -nr | head -10` - -更具破坏性的选项: -- 使用 `docker system prune`(如果要删除所有映像,请追加 `-a`;如果要删除所有卷,请追加 `--volumes`)删除不使用的 Docker 映像、网络和容器 -- 从工作树中删除不跟踪的文件:`git clear-i` - -### 联系我们 - -如果仍需帮助,请联系我们。 更多信息请参阅“[关于 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)”。 diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md deleted file mode 100644 index c58655b1a7..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: 创建代码空间 -intro: 您可以为仓库中的分支创建代码空间以便在线开发。 -permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/creating-a-codespace - - /github/developing-online-with-codespaces/creating-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 关于代码空间的创建 - -您可以在 {% data variables.product.prodname_dotcom_the_website %} 或 {% data variables.product.prodname_vscode %} 中创建代码。 {% data reusables.codespaces.codespaces-are-personal %} - -代码空间与仓库的特定分支相关联,且仓库不能为空。 {% data reusables.codespaces.concurrent-codespace-limit %} 更多信息请参阅“[删除代码空间](/github/developing-online-with-codespaces/deleting-a-codespace)”。 - - -创建代码空间时,需要执行一些步骤来实现对开发环境的完全访问。 - -- 分配了 VM 和容器存储等资源。 每次创建或启动代码空间时都会创建新的 VM,以确保您始终有最新的版本和安全补丁。 -- {% data variables.product.prodname_codespaces %} 接收有关您的仓库、分支、提交、公共 dotfiles 仓库以及您创建的所有密钥的信息。 -- {% data variables.product.prodname_codespaces %} 执行仓库的浅表克隆。 -- 如果仓库中有 `devcontainer.json` 文件,{% data variables.product.prodname_codespaces %} 将运行它。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)”。 -- Docker 容器、`docker-compose` 或其他其他初始化将运行。 -- 此时,代码空间标记为可用,您可以连接。 -- 一旦代码空间可用,根据开发容器中的命令,代码空间将继续进行一些设置。 - - 代码空间共享 `devcontainer.json` 文件中添加的端口。 - - 代码空间运行 `postCreateCommand` 中指定的任何操作。 - - {% data variables.product.prodname_codespaces %} 将 dotfiles 仓库克隆到代码空间并查找安装文件。 更多信息请参阅“[为帐户个性化 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)”。 - - 最后,代码空间对仓库进行完整克隆,使您可以完全访问它。 - - -{% data reusables.codespaces.use-visual-studio-features %} - -{% data reusables.codespaces.you-can-see-all-your-codespaces %} - -### 创建代码空间 - -{% data reusables.repositories.navigate-to-repo %} -2. 在仓库名称下,使用“Branch(分支)”下拉菜单选择您要为其创建代码的分支。 - - ![分支下拉菜单](/assets/images/help/codespaces/branch-drop-down.png) - -3. 在仓库名称下,使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单选择 **Open with Codespaces(使用 Codespaces 打开)**。 - - ![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -4. 要使用标准机器类型创建代码空间,请单击 {% octicon "plus" aria-label="The plus icon" %} **New codespace(新建代码空间)**。 - - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) - - - diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md deleted file mode 100644 index d465e9eedf..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: 删除代码空间 -intro: 您可以删除不再需要的代码空间。 -permissions: Anyone can delete a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/deleting-a-codespace - - /github/developing-online-with-codespaces/deleting-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -{% data reusables.codespaces.concurrent-codespace-limit %} - -1. 导航到您创建代码空间的仓库。 选择 **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces(代码空间)**,然后单击 {% octicon "gear" aria-label="The Settings gear" %}。 这将显示您在仓库中创建的所有 {% data variables.product.prodname_codespaces %}。 ![Codespaces 选项卡](/assets/images/help/codespaces/codespaces-manage.png) - - 您也可以在 [github.com/codespaces](https://github.com/codespaces)上查看您的用户帐户拥有的每个代码空间。 - -2. 在要删除的代码空间的右侧,单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %},然后单击 **{% octicon "trash" aria-label="The trash icon" %} Delete(删除)** ![删除按钮](/assets/images/help/codespaces/delete-codespace.png) - -### 在 {% data variables.product.prodname_vscode %} 中删除代码空间 - -有关在 {% data variables.product.prodname_vscode %} 中删除代码空间的信息,请参阅“[在 Visual Studio Code 中使用代码空间](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)”。 diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md deleted file mode 100644 index 3f739652a0..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: 在代码空间中开发 -intro: '您可以在 {% data variables.product.product_name %} 上打开代码空间,然后使用 {% data variables.product.prodname_vscode %} 的功能进行开发。' -permissions: Anyone can develop in a codespace owned by their user account. -redirect_from: - - /github/developing-online-with-github-codespaces/developing-in-a-codespace - - /github/developing-online-with-codespaces/developing-in-a-codespace -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 关于 {% data variables.product.prodname_codespaces %} 的开发 - -{% data variables.product.prodname_codespaces %} 为您提供 {% data variables.product.prodname_vscode %} 的完整开发体验。 {% data reusables.codespaces.use-visual-studio-features %} - -![带注释的代码空间概述](/assets/images/help/codespaces/codespace-overview-annotated.png) - -1. 侧栏 - 默认情况下,此区域显示您在资源管理器中的项目文件。 -2. 活动栏 - 显示视图并提供在视图之间切换的方法。 您可以通过拖放来重新排列视图。 -3. 编辑器 - 这是您编辑文件的地方。 您可以使用每个编辑器的选项卡将其准确定位到您需要的位置。 -4. 面板 - 这是您可以查看输出和调试信息的位置,以及集成终端的默认位置。 -5. 状态栏 - 此区域提供有关您的代码空间和项目的有用信息。 例如,分支名称、配置端口等。 - -有关使用 {% data variables.product.prodname_vscode %} 的更多信息,请参阅 {% data variables.product.prodname_vscode %} 文档中的[用户界面指南](https://code.visualstudio.com/docs/getstarted/userinterface)。 - -{% data reusables.codespaces.connect-to-codespace-from-vscode %} - -{% data reusables.codespaces.use-chrome %} 更多信息请参阅“[代码空间故障排除](/github/developing-online-with-codespaces/troubleshooting-your-codespace)”。 - -#### 个性化代码空间 - -{% data reusables.codespaces.about-personalization %} 更多信息请参阅“[个性化您帐户的 {% data variables.product.prodname_codespaces %}](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)”。 - -{% data reusables.codespaces.apply-devcontainer-changes %} 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)”。 - -#### 从代码空间运行应用程序 -{% data reusables.codespaces.about-port-forwarding %} 更多信息请参阅“[代码空间中的转发端口](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)”。 - -#### 提交更改 - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 导航到现有代码空间 - -1. {% data reusables.codespaces.you-can-see-all-your-codespaces %} -2. 单击您要在其中开发的代码空间的名称。 ![代码空间的名称](/assets/images/help/codespaces/click-name-codespace.png) - -或者,您可以通过导航到创建代码空间的仓库并选择 **{% octicon "codespaces" aria-label="The codespaces icon" %} 代码空间**来查看仓库的任何活动代码空间。 diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md deleted file mode 100644 index 560ee94a6a..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: 代码空间中的转发端口 -intro: '{% data reusables.codespaces.about-port-forwarding %}' -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 关于转发的端口 - -通过端口转发,您可以访问在代码空间内运行的 TCP 端口。 例如,如果您在端口 4000 上运行 Web 应用程序,您可以从浏览器访问该应用程序以测试和调试它。 - -在代码空间内运行的应用程序向控制台输出端口时,{% data variables.product.prodname_codespaces %} 将检测到 localhost URL 模式并自动转发端口。 您可以单击终端中的 URL 在浏览器中打开端口。 例如,如果应用程序向控制台输出 `http://127.0.0.1:4000` 或 `http://localhost:4000`,则日志会自动将输出转换为端口 4000 的可单击 URL。 - -![自动端口转发](/assets/images/help/codespaces/automatic-port-forwarding.png) - -您还可以手动转发端口、标记转发的端口、公开共享转发的端口以及将转发的端口添加到代码空间配置中。 - -### 转发端口 - -您可以手动转发未自动转发的端口。 - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. 在端口列表下,单击 **Add port(添加端口)**。 ![添加端口按钮](/assets/images/help/codespaces/add-port-button.png) -1. 键入端口编号或地址,然后按 Enter。 ![输入端口按钮的文本框](/assets/images/help/codespaces/port-number-text-box.png) - -### 标记端口 - -您可以标记端口,使端口更容易在列表中识别。 - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. 悬停在要标记的端口上,然后单击标签图标。 ![端口的标签图标](/assets/images/help/codespaces/label-icon.png) -{% data reusables.codespaces.type-port-label %} - -### 共享端口 - -如果您想与他人共享转发的端口,您可以公开该端口。 当您公开端口后,任何拥有端口 URL 的人都可以查看正在运行的应用程序,而无需进行身份验证。 - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. 右键单击要共享的端口,然后单击 **Make Public(公开)**。 ![右键菜单中公开端口的选项](/assets/images/help/codespaces/make-public-option.png) -1. 在端口的本地地址右侧,单击复制图标。 ![端口 URL 的复制图标](/assets/images/help/codespaces/copy-icon-port-url.png) -1. 将复制的 URL 发送给您想要与其共享端口的人。 - -### 将端口添加到代码空间配置 - -您可以将转发的端口添加到仓库的 {% data variables.product.prodname_codespaces %} 配置中,因此该端口将自动为创建自仓库的所有代码空间转发。 更新配置后,必须重建任何以前创建的代码空间以应用更改。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)”。 - -您可以使用 `forwardPorts` 属性在 `.devcontainer.json` 文件中手动配置转发的端口,也可以使用代码空间中的“端口”面板。 - -{% data reusables.codespaces.navigate-to-ports-tab %} -1. 右键单击要添加到代码空间配置的端口,然后单击 **Set Label and Update devcontainer.json(设置标签和更新 devcontainer.json)**。 ![右键菜单中设置标签并将端口添加到 devcontainer.json 的选项](/assets/images/help/codespaces/update-devcontainer-to-add-port-option.png) -{% data reusables.codespaces.type-port-label %} - diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md deleted file mode 100644 index b81102923e..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 在代码空间中开发 -intro: '创建代码空间,以便在专用云环境中开始开发您的项目。 您可以使用转发端口运行应用程序,甚至可以使用 {% data variables.product.prodname_vscode %} 内的代码空间' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /creating-a-codespace - - /developing-in-a-codespace - - /using-source-control-in-your-codespace - - /deleting-a-codespace - - /forwarding-ports-in-your-codespace - - /using-codespaces-in-visual-studio-code ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md deleted file mode 100644 index 130bbec088..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: 在 Visual Studio Code 中使用代码空间 -intro: '您可以将 {% data variables.product.prodname_github_codespaces %} 扩展连接到您在 {% data variables.product.product_name %} 上的帐户,直接在 {% data variables.product.prodname_vscode %} 代码空间中开发。' -redirect_from: - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code - - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Visual Studio Code - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 基本要求 - -要直接在 {% data variables.product.prodname_vscode %} 中开发代码空间,必须登录到 {% data variables.product.prodname_github_codespaces %} 扩展。 {% data variables.product.prodname_github_codespaces %} 扩展需要 {% data variables.product.prodname_vscode %} 2020 年 10 月 1 日版本 1.51 或更高版本。 - -使用 {% data variables.product.prodname_vs %} Marketplace 安装 [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 扩展。 更多信息请参阅 {% data variables.product.prodname_vscode %} 文档中的[扩展 Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery)。 - - -{% mac %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 单击 **Sign in to view {% data variables.product.prodname_dotcom %}...(登录以查看 Codespaces...)**。 ![登录以查看 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -3. 要授权 {% data variables.product.prodname_vscode %} 访问您在 {% data variables.product.product_name %} 上的帐户,请单击 **Allow(允许)**。 -4. 登录 {% data variables.product.product_name %} 以审批扩展。 - -{% endmac %} - -{% windows %} - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 使用“REMOTE EXPLORER(远程资源管理器)”下拉列表,然后单击 **{% data variables.product.prodname_github_codespaces %}**。 ![{% data variables.product.prodname_codespaces %} 标头](/assets/images/help/codespaces/codespaces-header-vscode.png) -3. 单击 **Sign in to view {% data variables.product.prodname_codespaces %}...(登录以查看 Codespaces...)**。 ![登录以查看 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -4. 要授权 {% data variables.product.prodname_vscode %} 访问您在 {% data variables.product.product_name %} 上的帐户,请单击 **Allow(允许)**。 -5. 登录 {% data variables.product.product_name %} 以审批扩展。 - -{% endwindows %} - -### 在 {% data variables.product.prodname_vscode %} 中创建代码空间 - -将 {% data variables.product.product_name %} 帐户连接到 {% data variables.product.prodname_github_codespaces %} 扩展后,您可以在 {% data variables.product.prodname_vscode %} 或 {% data variables.product.product_name %} 上创建的代码空间中进行开发。 - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 单击 Add(添加)图标,然后单击 **Create New Codespace(创建新代码空间)**。 ![{% data variables.product.prodname_codespaces %} 中的 Create new Codespace(创建新代码空间)选项](/assets/images/help/codespaces/create-codespace-vscode.png) -3. 键入,然后单击要在其中开发仓库的名称。 ![搜索仓库以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-repository-vscode.png) -4. 单击要在其中开发的分支。 ![搜索分支以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-branch-vscode.png) -5. Click the machine type you want to develop in. ![新 {% data variables.product.prodname_codespaces %} 的实例类型](/assets/images/help/codespaces/choose-sku-vscode.png) -### 在 {% data variables.product.prodname_vscode %} 中打开代码空间 - -{% data reusables.codespaces.click-remote-explorer-icon-vscode %} -2. 在“Codespaces(代码空间)”下,单击您要在其中开发的代码空间。 -3. 单击 Connect to Codespace(连接到代码空间)图标。 ![{% data variables.product.prodname_vscode %} 中的连接到代码空间图标](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) - -### 在 {% data variables.product.prodname_vscode %} 中更改机器类型 - -{% data reusables.codespaces.codespaces-machine-types %} - -您可以随时更改代码空间的机器类型。 - -1. 在 {% data variables.product.prodname_vscode %} 中,打开命令调色板 (`shift command P` / `shift control P`)。 -2. 搜索并选择“代码空间:更改机器类型”。 ![搜索分支以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. 单击您要更改的代码空间。 ![搜索分支以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. 选择您要使用的机器类型。 ![搜索分支以创建新的 {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -如果代码空间正在运行,则会显示一条消息,询问您现在是否要重新启动并重新连接到代码空间。 如果您想立即更改用于此代码空间的机器类型,请单击 **Yes(是)** 。 如果您单击 **No(否)**,或者代码空间当前未运行,更改将在代码空间下次重启时生效。 - -### 在 {% data variables.product.prodname_vscode %} 中删除代码空间 - -1. 在“Codespaces(代码空间)”下,右键点击您要删除的代码空间。 -2. 在下拉菜单中,单击 **Delete Codespace(删除代码空间)**。 ![在 {% data variables.product.prodname_dotcom %} 中删除代码空间](/assets/images/help/codespaces/delete-codespace-vscode.png) diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md deleted file mode 100644 index 2ff4d8b6fb..0000000000 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: 在代码空间中使用源控制 -intro: 在对代码空间中的文件进行更改后,您可以快速提交更改并将更新推送到远程仓库。 -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Fundamentals - - Developer ---- - -{% data reusables.codespaces.release-stage %} - -### 关于 {% data variables.product.prodname_codespaces %} 中的源控制 - -您可以直接在代码空间内执行所需的所有 Git 操作。 例如,您可以从远程仓库获取更改、切换分支、创建新分支、提交和推送更改,以及创建拉取请求。 您可以使用代码空间内的集成终端输入 Git 命令,也可以单击图标和菜单选项以完成所有最常见的 Git 任务。 本指南解释如何使用图形用户界面来控制源代码。 - -在 {% data variables.product.prodname_github_codespaces %} 中的源控制使用与 {% data variables.product.prodname_vscode %} 相同的工作流程。 更多信息请参阅 {% data variables.product.prodname_vscode %} 文档“[在 VS 代码中使用版本控制](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)”。 - -使用 {% data variables.product.prodname_github_codespaces %} 更新文件的典型工作流程将是: - -* 从 {% data variables.product.prodname_dotcom %} 上仓库的默认分支,创建代码空间。 请参阅“[创建代码空间](/codespaces/developing-in-codespaces/creating-a-codespace)”。 -* 在代码空间中,创建一个新的分支来操作。 -* 进行更改并保存。 -* 提交更改。 -* 提出拉取请求。 - -### 创建或切换分支 - -1. 如果当前分支未显示在状态栏中,请在代码空间的底部右键单击状态栏,然后选择 **Source control(源控制)**。 -1. 单击状态栏中的分支名称。 ![状态栏中的分支](/assets/images/help/codespaces/branch-in-status-bar.png) -1. 在下拉菜单中,单击要切换到的分支或输入新分支的名称,然后单击 **Create new branch(创建新分支)**。 ![从分支菜单中选择](/assets/images/help/codespaces/create-new-branch.png) - -{% tip %} - -**提示**:如果有人在远程仓库上更改了文件,则在您切换到的分支中,只有将更改拉入代码空间后,您才能看到这些更改。 - -{% endtip %} - -### 从远程仓库拉取更改 - -您可以随时将远程仓库的更改拉取到您的代码空间。 - -{% data reusables.codespaces.source-control-display-dark %} -1. 在侧边栏的顶部,单击省略号 (**...**)。 ![查看和更多操作的省略号按钮](/assets/images/help/codespaces/source-control-ellipsis-button.png) -1. 在下拉菜单中,单击 **Pull(拉取)**。 - -如果自创建代码空间以来开发容器已更改,则可以通过为代码空间重建容器来应用更改。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)”。 - -### 设置代码空间以自动获取新更改 - -您可以设置代码空间,以自动获取对远程仓库所做的任何新提交的详细信息。 这允许您查看仓库的本地副本是否过时,如果是,您可以选择拉取新的更改。 - -如果获取操作检测到远程仓库上的新更改,您将在状态栏中看到新提交的数量。 然后,您可以将更改拉取到本地副本。 - -1. 单击活动栏底部的 **Manage(管理)**按钮。 ![管理按钮](/assets/images/help/codespaces/manage-button.png) -1. 在菜单中,单击 **Settings(设置)**。 -1. 在 Settings(设置)页面上,搜索:`autofetch`。 ![搜索自动获取](/assets/images/help/codespaces/autofetch-search.png) -1. 要获取当前仓库注册的所有远程仓库的更新详情,请将 **Git: Autofetch** 设置为 `all`。 ![启用 Git 自动获取](/assets/images/help/codespaces/autofetch-all.png) -1. 如果要更改自动获取的间隔秒数,请编辑 **Git: Autofetch Period** 的值。 - -### 提交更改 - -{% data reusables.codespaces.source-control-display-dark %} -1. 要暂存更改,请单击已更改文件旁边的 **+**;如果您更改了多个文件并且要全部暂存,请单击 **Changes(更改)**旁边的该按钮。 ![高亮显示暂存按钮的源控制侧边栏](/assets/images/help/codespaces/codespaces-commit-stage.png) -1. 输入提交消息,描述您所做的更改。 ![带有提交消息的源控制侧栏](/assets/images/help/codespaces/codespaces-commit-commit-message.png) -1. 要提交暂存的更改,请单击源控制侧栏顶部的复选标记。 ![单击复选标记图标](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png) - -### 提出拉取请求 - -1. 将更改提交到仓库的本地副本后,请单击 **Create Pull Request(创建拉取请求)**图标。 ![高亮显示暂存按钮的源控制侧边栏](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. 检查作为合并来源的本地分支和仓库以及作为合并目标的远程分支和仓库是否正确。 然后为拉取请求提供标题和描述。 ![高亮显示暂存按钮的源控制侧边栏](/assets/images/help/codespaces/codespaces-commit-pr.png) -1. 单击 **Create(创建)**。 - -### 将更改推送到远程仓库 - -您可以推送所做的更改。 这将应用这些更改到远程仓库上的上游分支。 如果您尚未准备好创建拉取请求,或者希望在 {% data variables.product.prodname_dotcom %} 上创建拉取请求,则可能需要这样做。 - -1. 在侧边栏的顶部,单击省略号 (**...**)。 ![查看和更多操作的省略号按钮](/assets/images/help/codespaces/source-control-ellipsis-button-nochanges.png) -1. 在下拉菜单中,单击 **Push(推送)**。 diff --git a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md b/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md deleted file mode 100644 index e6256564c7..0000000000 --- a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: 开始在代码空间中使用 C# (.NET) 项目 -shortTitle: 开始使用 C# (.NET) 项目 -allowTitleToDifferFromFilename: true -intro: '通过创建自定义开发容器,开始在 {% data variables.product.prodname_codespaces %} 中使用 C# (.NET) 项目。' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### 简介 - -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 C# (.NET) 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 - -#### 基本要求 - -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 C# (.NET) 项目。 如果您没有项目,可以使用以下示例尝试本教程:https://github.com/2percentsilk/dotnet-quickstart。 -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 - -### 步骤 1:在代码空间中打开项目 - -1. 导航到项目的仓库。 在仓库名称下,使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单选择 **Open with Codespaces(使用 Codespaces 打开)**。 如果您看不到此选项,则您的项目不能用于 {% data variables.product.prodname_codespaces %}。 - - ![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. 要创建新的代码空间,请单击 {% octicon "plus" aria-label="The plus icon" %} **New codespace(新建代码空间)**。 ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) - -创建代码空间时,您的项目是在专用于您的远程 VM 上创建的。 默认情况下,代码空间的容器具有多种语言和运行时,包括 .NET。 它还包括一套常见的工具,例如 git、wget、rsync、openssh 和 nano。 - -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 - -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时, {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - - -### 步骤 2:从模板将开发容器添加到您的代码空间 - -默认代码空间容器附带最新的 .NET 版本和预安装的常用工具。 但是,我们鼓励您设置自定义容器,以便根据项目的需求定制在代码空间创建过程中运行的工具和脚本,并确保为仓库中的所有 {% data variables.product.prodname_codespaces %} 用户提供完全可复制的环境。 - -要使用自定义容器设置项目,您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中,您可以从模板添加它,也可以自己创建。 有关开发容器的更多信息,请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - - -1. 访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "dev container"。 单击 **Codespaces: Add Development Container Configuration Files...(Codespaces:添加开发容器配置文件...)** ![命令选择板中的"Codespaces:添加开发容器配置文件..."](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. 对于此示例,单击 **C# (.NET)**。 如果需要其他功能,您可以选择任何特定于 C# (.NET) 或工具(如 C# (.NET) 和 MS SQL)组合的容器。 ![从列表中选择 C# (.NET) 选项](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) -3. 单击推荐的 .NET 版本。 ![.NET 版本选择](/assets/images/help/codespaces/add-dotnet-version.png) -4. 接受默认选项,将 Node.js 添加到您的自定义中。 ![添加 Node.js 选择](/assets/images/help/codespaces/dotnet-options.png) -5. 要重建容器,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### 开发容器的剖析 - -添加 C# (.NET) 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中,其中包含以下文件: - -- `devcontainer.json` -- Dockerfile - -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 - -##### devcontainer.json - -```json -{ - "name": "C# (.NET)", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 - "VARIANT": "5.0", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*", - "INSTALL_AZURE_CLI": "false" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-dotnettools.csharp" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [5000, 5001], - - // [Optional] To reuse of your local HTTPS dev cert: - // - // 1. Export it locally using this command: - // * Windows PowerShell: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // * macOS/Linux terminal: - // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // - // 2. Uncomment these 'remoteEnv' lines: - // "remoteEnv": { - // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", - // "ASPNETCORE_Kestrel__Certificates__Default__Path": "/home/vscode/.aspnet/https/aspnetapp.pfx", - // }, - // - // 3. Do one of the following depending on your scenario: - // * When using GitHub Codespaces and/or Remote - Containers: - // 1. Start the container - // 2. Drag ~/.aspnet/https/aspnetapp.pfx into the root of the file explorer - // 3. Open a terminal in VS Code and run "mkdir -p /home/vscode/.aspnet/https && mv aspnetapp.pfx /home/vscode/.aspnet/https" - // - // * If only using Remote - Containers with a local container, uncomment this line instead: - // "mounts": [ "source=${env:HOME}${env:USERPROFILE}/.aspnet/https,target=/home/vscode/.aspnet/https,type=bind" ], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "dotnet restore", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - 您可以将开发容器命名为任何名称,这只是默认名称。 -- **Build** - 构建属性。 - - **Dockerfile** - 在构建对象中,`dockerfile` 是对 Dockerfile 的引用,该文件也是从模板中添加的。 - - **Args** - - **Variant**:此文件仅包含一个构建参数,即我们要使用的 .NET Core 版本。 -- **Settings** - 它们是 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置,但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **ms-dotnettools.csharp** - Microsoft C# 扩展为使用 C# 的开发提供丰富的支持,包括 IntelliSense、linting、调试、代码导航、代码格式化、重构、变量资源管理器、测试资源管理器等功能。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间(例如 `dotnet restore`)后执行任何操作,您可以在此处执行。 -- **remoteUser** - 默认情况下,您以 vscode 用户身份运行,但您可以选择将其设置为 root。 - -##### Dockerfile - -```bash -# [Choice] .NET version: 5.0, 3.1, 2.1 -ARG VARIANT="5.0" -FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Option] Install Azure CLI -ARG INSTALL_AZURE_CLI="false" -COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ -RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ - && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -您可以使用 Dockerfile 添加其他容器层,以指定要包含在容器中的操作系统包、节点版本或全局包。 - -### 步骤 3:修改 devcontainer.json 文件 - -添加了开发容器并基本了解所有功能之后,您现在可以进行更改以针对您的环境进行配置。 在此示例中,您将在代码空间启动时添加属性以安装扩展和恢复项目依赖项。 - -1. 在 Explorer 中,展开 `.devcontainer` 文件夹,从树中选择 `devcontainer.json` 文件并打开它。 - - ![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/devcontainers-options.png) - -2. 更新 `devcontainer.json` 文件中的 `extensions` 列表,以添加一些在处理项目时有用的扩展。 - - ```json{:copy} - "extensions": [ - "ms-dotnettools.csharp", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. 取消注释 `postCreateCommand` 以便在代码空间设置过程中恢复依赖项。 - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "dotnet restore", - ``` - -4. 要重建容器并应用 devcontainer.json 更改,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 - - ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - - 在代码空间内进行重建可确保在将更改提交到仓库之前,更改能够按预期工作。 如果某些问题导致了故障,您将进入带有恢复容器的代码空间中,您可以从该容器进行重建以继续调整容器。 - -5. 通过验证是否安装了 "Code Spell Checker" 扩展,检查更改是否成功应用。 - - ![扩展列表](/assets/images/help/codespaces/dotnet-extensions.png) - -### 步骤 4:运行应用程序 - -在上一节中,您使用 `postCreateCommand` 通过 pip3 安装了一组包。 现在安装了依赖项,我们可以运行应用程序。 - -1. 通过按 `F5` 或在终端中输入 `dotnet watch run` 来运行您的应用程序。 - -2. 项目启动时,您应该在右下角看到一个信息框,提示您连接到项目使用的端口。 - - ![端口转发信息框](/assets/images/help/codespaces/python-port-forwarding.png) - -### 步骤 5:提交更改 - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 后续步骤 - -现在,您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 C# (.NET) 项目。 以下是用于更高级场景的一些额外资源。 - -- [管理 {% data variables.product.prodname_codespaces %} 的加密密码](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md b/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md deleted file mode 100644 index eabf34d9bb..0000000000 --- a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: 开始在代码空间中使用 Java 项目 -shortTitle: 开始使用 Java 项目 -intro: '通过创建自定义开发容器,开始在 {% data variables.product.prodname_codespaces %} 中使用 Java 项目。' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### 简介 - -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 Java 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 - -#### 基本要求 - -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 Java 项目。 如果您没有项目,可以使用以下示例尝试本教程:https://github.com/microsoft/vscode-remote-try-java -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 - -### 步骤 1:在代码空间中打开项目 - -1. 导航到项目的仓库。 在仓库名称下,使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单选择 **Open with Codespaces(使用 Codespaces 打开)**。 如果您看不到此选项,则您的项目不能用于 {% data variables.product.prodname_codespaces %}。 - - ![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. 要创建新的代码空间,请单击 {% octicon "plus" aria-label="The plus icon" %} **New codespace(新建代码空间)**。 ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) - -创建代码空间时,您的项目是在专用于您的远程 VM 上创建的。 默认情况下,代码空间的容器有许多语言和运行时,包括 Java、nvm、npm 和 yarn。 它还包括一套常见的工具,例如 git、wget、rsync、openssh 和 nano。 - -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 - -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时, {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - - -### 步骤 2:从模板将开发容器添加到您的代码空间 - -默认代码空间容器附带最新的 Java 版本、包管理器(Maven、Gradle)和其他预装的常用工具。 但是,我们建议您设置一个自定义容器来定义项目所需的工具和脚本。 这将确保仓库中的所有 {% data variables.product.prodname_codespaces %} 用户都拥有完全可复制的环境。 - -要使用自定义容器设置项目,您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中,您可以从模板添加它,也可以自己创建。 有关开发容器的更多信息,请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - - -1. 访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "dev container"。 单击 **Codespaces: Add Development Container Configuration Files...(Codespaces:添加开发容器配置文件...)** ![命令选择板中的"Codespaces:添加开发容器配置文件..."](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. 对于此示例,单击 **Java**。 实际上,您可以选择任何特定于 Java 的容器或 Java 和 Azure 函数等工具的组合。 ![从列表中选择 Java 选项](/assets/images/help/codespaces/add-java-prebuilt-container.png) -4. 单击推荐的 Java 版本。 ![Java 版本选择](/assets/images/help/codespaces/add-java-version.png) -5. 要重建容器,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### 开发容器的剖析 - -添加 Java 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中,其中包含以下文件: - -- `devcontainer.json` -- Dockerfile - -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java -{ - "name": "Java", - "build": { - "dockerfile": "Dockerfile", - "args": { - // Update the VARIANT arg to pick a Java version: 11, 14 - "VARIANT": "11", - // Options - "INSTALL_MAVEN": "true", - "INSTALL_GRADLE": "false", - "INSTALL_NODE": "false", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "java.home": "/docker-java-home", - "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "vscjava.vscode-java-pack" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "java -version", - - // Uncomment to connect as a non-root user. 请参阅 https://aka.ms/vscode-remote/containers/non-root。 - "remoteUser": "vscode" -} -``` - -- **Name** - 您可以将开发容器命名为任何名称,这只是默认名称。 -- **Build** - 构建属性。 - - **Dockerfile** - 在构建对象中,dockerfile 是对 Dockerfile 的引用,该文件也是从模板中添加的。 - - **Args** - - **Variant**:此文件仅包含一个构建参数,即传递到 Dockerfile 的 Java 版本。 -- **Settings** - 它们是您可以设置的 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置,但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **Vscjava.vscode-java-pack** - Java 扩展包为 Java 开发提供了流行的扩展,以帮助您入门。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间后执行任何操作,您可以在此处执行。 -- **remoteUser** - 默认情况下,您以 `vscode` 用户身份运行,但您可以选择将其设置为 `root`。 - -##### Dockerfile - -```bash -# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile -ARG VARIANT="14" -FROM mcr.microsoft.com/vscode/devcontainers/java:0-${VARIANT} - -# [Optional] Install Maven or Gradle -ARG INSTALL_MAVEN="false" -ARG MAVEN_VERSION=3.6.3 -ARG INSTALL_GRADLE="false" -ARG GRADLE_VERSION=5.4.1 -RUN if [ "${INSTALL_MAVEN}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install maven \"${MAVEN_VERSION}\""; fi \ - && if [ "${INSTALL_GRADLE}" = "true" ]; then su vscode -c "source /usr/local/sdkman/bin/sdkman-init.sh && sdk install gradle \"${GRADLE_VERSION}\""; fi - -# [Optional] Install a version of Node.js using nvm for front end dev -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -您可以使用 Dockerfile 添加其他容器层,以指定要包含在 Dockerfile 中的操作系统包、Java 版本或全局包。 - -### 步骤 3:修改 devcontainer.json 文件 - -添加了开发容器并基本了解所有功能之后,您现在可以进行更改以针对您的环境进行配置。 在此示例中,您将在代码空间启动时添加属性以安装扩展和项目依赖项。 - -1. 在 Explorer 中,从树中选择 `devcontainer.json` 文件来打开它。 您可能需要展开 `.devcontainer` 文件夹才能看到它。 - - ![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/devcontainers-options.png) - -2. 在 `devcontainer.json` 文件中的 `extensions` 后面添加以下行。 - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - 有关 `devcontainer.json` 属性的更多信息,请参阅 Visual Studio 文档中的 [devcontainer.json 参考](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)。 - -3. 要重建容器,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 - - ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - - 在代码空间内进行重建可确保在将更改提交到仓库之前,更改能够按预期工作。 如果某些问题导致了故障,您将进入带有恢复容器的代码空间中,您可以从该容器进行重建以继续调整容器。 - - -### 步骤 4:运行应用程序 - -在上一节中,您使用 `postCreateCommand` 通过 npm 安装了一组包。 您现在可以使用它来通过 npm 运行应用程序。 - -1. 按 `F5` 运行应用程序。 - -2. 项目启动时,您应该在右下角看到一个信息框,提示您连接到项目使用的端口。 - - ![端口转发信息框](/assets/images/help/codespaces/codespaces-port-toast.png) - -### 步骤 5:提交更改 - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 后续步骤 - -现在,您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 Java 项目。 以下是用于更高级场景的一些额外资源。 - -- [管理 {% data variables.product.prodname_codespaces %} 的加密密码](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md b/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md deleted file mode 100644 index 281646ef37..0000000000 --- a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: 开始在代码空间中使用 Node.js 项目 -shortTitle: 开始使用 Node.js 项目 -intro: '通过创建自定义开发容器,开始在 {% data variables.product.prodname_codespaces %} 中使用 JavaScript、Node.js 或 TypeScript 项目。' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Node - - JavaScript ---- - -{% data reusables.codespaces.release-stage %} - -### 简介 - -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 JavaScript、Node.js 或 TypeScript 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 - -#### 基本要求 - -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 JavaScript、Node.js 或 TypeScript 项目。 如果您没有项目,可以使用以下示例尝试本教程:https://github.com/microsoft/vscode-remote-try-node -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 - -### 步骤 1:在代码空间中打开项目 - -1. 导航到项目的仓库。 在仓库名称下,使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单选择 **Open with Codespaces(使用 Codespaces 打开)**。 如果您看不到此选项,则您的项目不能用于 {% data variables.product.prodname_codespaces %}。 - - ![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. 要创建新的代码空间,请单击 {% octicon "plus" aria-label="The plus icon" %} **New codespace(新建代码空间)**。 ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) - -创建代码空间时,您的项目是在专用于您的远程 VM 上创建的。 默认情况下,代码空间的容器有许多语言和运行时,包括 Node.js、JavaScript、Typescript、nvm、npm 和 yarn。 它还包括一套常见的工具,例如 git、wget、rsync、openssh 和 nano。 - -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 - -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时, {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - -### 步骤 2:从模板将开发容器添加到您的代码空间 - -默认代码空间容器将支持运行 Node.js 项目,如开箱即用 [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node)。 通过设置自定义容器,您可以自定义在代码空间创建过程中运行的工具和脚本,并确保为仓库中的所有 {% data variables.product.prodname_codespaces %} 用户提供完全可复制的环境。 - -要使用自定义容器设置项目,您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中,您可以从模板添加它,也可以自己创建。 有关开发容器的更多信息,请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - -1. 访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "dev container"。 单击 **Codespaces: Add Development Container Configuration Files...(Codespaces:添加开发容器配置文件...)** ![命令选择板中的"Codespaces:添加开发容器配置文件..."](/assets/images/help/codespaces/add-prebuilt-container-command.png) -3. 对于此示例,单击 **Node.js**。 如果需要其他功能,您可以选择任何特定于节点或工具(如节点和 MongoDB)组合的容器。 ![从列表中选择节点选项](/assets/images/help/codespaces/add-node-prebuilt-container.png) -4. 单击推荐的 Node.js 版本。 ![Node.js 版本选择](/assets/images/help/codespaces/add-node-version.png) -5. 要重建容器,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### 开发容器的剖析 - -添加 Node.js 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中,其中包含以下文件: - -- `devcontainer.json` -- Dockerfile - -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 - -##### devcontainer.json - -```json -// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: -// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node -{ - "name": "Node.js", - "build": { - "dockerfile": "Dockerfile", - // Update 'VARIANT' to pick a Node version: 10, 12, 14 - "args": { "VARIANT": "14" } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "dbaeumer.vscode-eslint" - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "yarn install", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node" -} -``` - -- **Name** - 您可以将开发容器命名为任何名称,这只是默认名称。 -- **Build** - 构建属性。 - - **dockerfile** - 在构建对象中,dockerfile 是对 Dockerfile 的引用,该文件也是从模板中添加的。 - - **Args** - - **Variant**:此文件仅包含一个构建参数,即我们要用于传递到 Dockerfile 的节点变量。 -- **Settings** - 它们是您可以设置的 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置,但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **Dbaeumer.vscode-eslint** - ES lint 是 linting 的良好扩展,但是对于 JavaScript,您还可以包括许多出色的 Marketplace 扩展。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间后执行任何操作,您可以在此处执行。 -- **remoteUser** - 默认情况下,您以 vscode 用户身份运行,但您可以选择将其设置为 root。 - -##### Dockerfile - -```bash -# [Choice] Node.js version: 14, 12, 10 -ARG VARIANT="14-buster" -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment if you want to install an additional version of node using nvm -# ARG EXTRA_NODE_VERSION=10 -# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}" - -# [Optional] Uncomment if you want to install more global node modules -# RUN su node -c "npm install -g " -``` - -您可以使用 Dockerfile 添加其他容器层,以指定要包含在 Dockerfile 中的操作系统包、节点版本或全局包。 - -### 步骤 3:修改 devcontainer.json 文件 - -添加了开发容器并基本了解所有功能之后,您现在可以进行更改以针对您的环境进行配置。 在此示例中,您将添加属性以在代码空间启动时安装 npm,并使容器内的端口列表在本地可用。 - -1. 在 Explorer 中,从树中选择 `devcontainer.json` 文件来打开它。 您可能需要展开 `.devcontainer` 文件夹才能看到它。 - - ![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/devcontainers-options.png) - -2. 在 `devcontainer.json` 文件中的 `extensions` 后面添加以下行: - - ```json{:copy} - "postCreateCommand": "npm install", - "forwardPorts": [4000], - ``` - - 有关 `devcontainer.json` 属性的更多信息,请参阅 {% data variables.product.prodname_vscode %} 文档中的 [devcontainer.json 参考](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)。 - -3. 要重建容器,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 - - ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - - 在代码空间内进行重建可确保在将更改提交到仓库之前,更改能够按预期工作。 如果某些问题导致了故障,您将进入带有恢复容器的代码空间中,您可以从该容器进行重建以继续调整容器。 - - -### 步骤 4:运行应用程序 - -在上一节中,您使用 `postCreateCommand` 通过 npm 安装了一组包。 您现在可以使用它来通过 npm 运行应用程序。 - -1. 在终端中使用 `npm start` 运行启动命令。 - - ![终端的 npm 启动](/assets/images/help/codespaces/codespaces-npmstart.png) - -2. 项目启动时,您应该在右下角看到一个信息框,提示您连接到项目使用的端口。 - - ![端口转发信息框](/assets/images/help/codespaces/codespaces-port-toast.png) - -### 步骤 5:提交更改 - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 后续步骤 - -现在,您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 JavaScript 项目。 以下是用于更高级场景的一些额外资源。 - -- [管理代码空间的加密密码](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md b/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md deleted file mode 100644 index 0cc1b6635c..0000000000 --- a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: 开始在代码空间中使用 Python 项目 -shortTitle: 开始使用 Python 项目 -intro: '通过创建自定义开发容器,开始在 {% data variables.product.prodname_codespaces %} 中使用 Python 项目。' -versions: - free-pro-team: '*' -type: tutorial -topics: - - Codespaces - - Developer - - Python ---- - -{% data reusables.codespaces.release-stage %} - -### 简介 - -本指南介绍如何在 {% data variables.product.prodname_codespaces %} 中设置 Python 项目。 它将演示在代码空间中打开项目以及从模板添加和修改开发容器配置的示例。 - -#### 基本要求 - -- 您应该在 {% data variables.product.prodname_dotcom_the_website %} 的仓库中有现有的 Python 项目。 如果您没有项目,可以使用以下示例尝试本教程:https://github.com/2percentsilk/python-quickstart. -- 您必须为组织启用 {% data variables.product.prodname_codespaces %} 。 - -### 步骤 1:在代码空间中打开项目 - -1. 导航到项目的仓库。 在仓库名称下,使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单选择 **Open with Codespaces(使用 Codespaces 打开)**。 如果您看不到此选项,则您的项目不能用于 {% data variables.product.prodname_codespaces %}。 - - ![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -2. 要创建新的代码空间,请单击 {% octicon "plus" aria-label="The plus icon" %} **New codespace(新建代码空间)**。 ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) - -创建代码空间时,您的项目是在专用于您的远程 VM 上创建的。 默认情况下,代码空间的容器有许多语言和运行时,包括 Node.js、JavaScript、Typescript、nvm、npm 和 yarn。 它还包括一套常见的工具,例如 git、wget、rsync、openssh 和 nano。 - -您可以通过调整 vCPU 和 RAM 的数量、[添加 dotfiles 以个性化环境](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)或者修改安装的工具和脚本来自定义代码空间。 - -{% data variables.product.prodname_codespaces %} 使用名为 `devcontainer.json` 的文件来存储配置。 在启动时, {% data variables.product.prodname_codespaces %} 使用文件安装项目可能需要的任何工具、依赖项或其他设置。 更多信息请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - - -### 步骤 2:从模板将开发容器添加到您的代码空间 - -默认代码空间容器附带最新的 Python 版本、包管理器(pip、Miniconda)和其他预装的常用工具。 但是,我们建议您设置一个自定义容器来定义项目所需的工具和脚本。 这将确保仓库中的所有 {% data variables.product.prodname_codespaces %} 用户都拥有完全可复制的环境。 - -要使用自定义容器设置项目,您需要使用 `devcontainer.json` 文件来定义环境。 在 {% data variables.product.prodname_codespaces %} 中,您可以从模板添加它,也可以自己创建。 有关开发容器的更多信息,请参阅“[为项目配置代码空间](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)”。 - - -1. 访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "dev container"。 单击 **Codespaces: Add Development Container Configuration Files...(Codespaces:添加开发容器配置文件...)** ![命令选择板中的"Codespaces:添加开发容器配置文件..."](/assets/images/help/codespaces/add-prebuilt-container-command.png) -2. 对于此示例,单击 **Python 3**。 如果需要其他功能,您可以选择任何特定于 Python 或工具(如 Python 3 和 PostgresSQL)组合的容器。 ![从列表中选择 Python 选项](/assets/images/help/codespaces/add-python-prebuilt-container.png) -3. 单击推荐的 Python 版本。 ![Python 版本选择](/assets/images/help/codespaces/add-python-version.png) -4. 接受默认选项,将 Node.js 添加到您的自定义中。 ![添加 Node.js 选择](/assets/images/help/codespaces/add-nodejs-selection.png) -5. 要重建容器,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - -#### 开发容器的剖析 - -添加 Python 开发容器模板会将 `.devcontainer` 文件夹添加到项目仓库的根目录中,其中包含以下文件: - -- `devcontainer.json` -- Dockerfile - -新添加的 `devcontainer.json` 文件定义了几个在样本之后描述的属性。 - -##### devcontainer.json - -```json -{ - "name": "Python 3", - "build": { - "dockerfile": "Dockerfile", - "context": "..", - "args": { - // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 - "VARIANT": "3", - // Options - "INSTALL_NODE": "true", - "NODE_VERSION": "lts/*" - } - }, - - // Set *default* container specific settings.json values on container create. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.linting.enabled": true, - "python.linting.pylintEnabled": true, - "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", - "python.formatting.blackPath": "/usr/local/py-utils/bin/black", - "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", - "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", - "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", - "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", - "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", - "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", - "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint" - }, - - // Add the IDs of extensions you want installed when the container is created. - "extensions": [ - "ms-python.python", - ], - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "pip3 install --user -r requirements.txt", - - // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "vscode" -} -``` - -- **Name** - 您可以将开发容器命名为任何名称,这只是默认名称。 -- **Build** - 构建属性。 - - **Dockerfile** - 在构建对象中,`dockerfile` 是对 Dockerfile 的引用,该文件也是从模板中添加的。 - - **Args** - - **Variant**:此文件仅包含一个构建参数,即我们要用于传递到 Dockerfile 的节点变量。 -- **Settings** - 它们是 {% data variables.product.prodname_vscode %} 设置。 - - **Terminal.integrated.shell.linux** - 虽然 bash 是此处的默认设置,但您可以通过修改它来使用其他终端 shell。 -- **Extensions** - 它们是默认包含的扩展名。 - - **ms-python.python** - Microsoft Python 扩展为 Python 语言提供丰富的支持(对于所有积极支持的语言版本:>=3.6),包括 IntelliSense、linting、调试、代码导航、代码格式化、重构、变量资源管理器、测试资源管理器等功能。 -- **forwardPorts** - 此处列出的任何端口都将自动转发。 -- **postCreateCommand** - 如果您要在进入 Dockerfile 中未定义的代码空间(例如 `pip3 install -r requirements`)后执行任何操作,您可以在此处执行。 -- **remoteUser** - 默认情况下,您以 `vscode` 用户身份运行,但您可以选择将其设置为 `root`。 - -##### Dockerfile - -```bash -# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6 -ARG VARIANT="3" -FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} - -# [Option] Install Node.js -ARG INSTALL_NODE="true" -ARG NODE_VERSION="lts/*" -RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi - -# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image. -# COPY requirements.txt /tmp/pip-tmp/ -# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ -# && rm -rf /tmp/pip-tmp - -# [Optional] Uncomment this section to install additional OS packages. -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends - -# [Optional] Uncomment this line to install global node packages. -# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 -``` - -您可以使用 Dockerfile 添加其他容器层,以指定要包含在容器中的操作系统包、节点版本或全局包。 - -### 步骤 3:修改 devcontainer.json 文件 - -添加了开发容器并基本了解所有功能之后,您现在可以进行更改以针对您的环境进行配置。 在此示例中,您将在代码空间启动时添加属性以安装扩展和项目依赖项。 - -1. 在 Explorer 中,展开 `.devcontainer` 文件夹,从树中选择 `devcontainer.json` 文件并打开它。 - - ![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/devcontainers-options.png) - -2. 更新 `devcontainer.json` 文件中的 `extensions` 列表,以添加一些在处理项目时有用的扩展。 - - ```json{:copy} - "extensions": [ - "ms-python.python", - "cstrap.flask-snippets", - "streetsidesoftware.code-spell-checker", - ], - ``` - -3. 取消注释 `postCreateCommand` 以自动安装要求,作为代码空间设置过程的一部分。 - - ```json{:copy} - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "pip3 install --user -r requirements.txt", - ``` - -4. 要重建容器并应用 devcontainer.json 更改,请访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "rebuild"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 - - ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - - 在代码空间内进行重建可确保在将更改提交到仓库之前,更改能够按预期工作。 如果某些问题导致了故障,您将进入带有恢复容器的代码空间中,您可以从该容器进行重建以继续调整容器。 - -5. 通过验证是否安装了 Code Spell Checker 和 Flask Snippet 扩展,检查更改是否成功应用。 - - ![扩展列表](/assets/images/help/codespaces/python-extensions.png) - -### 步骤 4:运行应用程序 - -在上一节中,您使用 `postCreateCommand` 通过 pip3 安装了一组包。 现已安装您的依赖项,您可以运行应用程序。 - -1. 通过按 `F5` 或在代码空间终端中输入 `python -m flask run` 来运行您的应用程序。 - -2. 项目启动时,您应该在右下角看到一个信息框,提示您连接到项目使用的端口。 - - ![端口转发信息框](/assets/images/help/codespaces/python-port-forwarding.png) - -### 步骤 5:提交更改 - -{% data reusables.codespaces.committing-link-to-procedure %} - -### 后续步骤 - -现在,您应该准备开始在 {% data variables.product.prodname_codespaces %} 中开发您的 Python 项目。 以下是用于更高级场景的一些额外资源。 - -- [管理 {% data variables.product.prodname_codespaces %} 的加密密码](/codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces) -- [管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces) -- [代码空间中的转发端口](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/index.md b/translations/zh-CN/content/codespaces/getting-started-with-codespaces/index.md deleted file mode 100644 index 90420f650f..0000000000 --- a/translations/zh-CN/content/codespaces/getting-started-with-codespaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: '开始使用 {% data variables.product.prodname_codespaces %}' -intro: '了解如何开始使用 {% data variables.product.prodname_codespaces %},包括特定语言的设置和配置。' -versions: - free-pro-team: '*' -children: - - /getting-started-with-your-nodejs-project-in-codespaces - - /getting-started-with-your-dotnet-project - - /getting-started-with-your-java-project-in-codespaces - - /getting-started-with-your-python-project-in-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/zh-CN/content/codespaces/guides.md b/translations/zh-CN/content/codespaces/guides.md deleted file mode 100644 index 19e5d5d63c..0000000000 --- a/translations/zh-CN/content/codespaces/guides.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: 代码空间指南 -shortTitle: 指南 -intro: '了解如何充分利用 GitHub {% data reusables.gated-features.codespaces %}' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /codespaces/quickstart - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/deleting-a-codespace - - /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace - - /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces - - /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces ---- - diff --git a/translations/zh-CN/content/codespaces/index.md b/translations/zh-CN/content/codespaces/index.md deleted file mode 100644 index d66f816e63..0000000000 --- a/translations/zh-CN/content/codespaces/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GitHub 代码空间文档 -beta_product: true -shortTitle: GitHub Codespaces -intro: 创建一个代码空间,在一个安全、可配置、专用的开发环境中开始开发,该环境可以按照您希望的方式和位置工作。 -introLinks: - quickstart: /codespaces/quickstart - overview: /codespaces/about-codespaces -featuredLinks: - guides: - - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces - - /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project - guideCards: - - /codespaces/developing-in-codespaces/creating-a-codespace - - /codespaces/developing-in-codespaces/developing-in-a-codespace - - /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code - - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - popular: - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - - /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces - - /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces - popularHeading: Managing GitHub Codespaces -product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc' -redirect_from: - - /github/developing-online-with-github-codespaces - - /github/developing-online-with-codespaces -layout: product-landing -versions: - free-pro-team: '*' -children: - - /about-codespaces - - /quickstart - - /getting-started-with-codespaces - - /setting-up-your-codespace - - /developing-in-codespaces - - /managing-your-codespaces - - /managing-codespaces-for-your-organization - - /codespaces-reference - - /guides ---- - diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/index.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/index.md deleted file mode 100644 index b318354a5b..0000000000 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 管理组织的代码空间 -intro: '您可以管理和审查您组织中的用户如何使用 {% data variables.product.prodname_github_codespaces %}。' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /managing-access-and-security-for-your-organizations-codespaces - - /managing-user-permissions-for-your-organization - - /reviewing-your-organizations-audit-logs-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md deleted file mode 100644 index fde2f9896e..0000000000 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: 管理组织代码空间的访问和安全 -shortTitle: 管理组织的访问和安全 -intro: '您可以管理 {% data variables.product.prodname_codespaces %} 可以访问的组织仓库。' -permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator -redirect_from: - - /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces - - /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -组织所有者可以管理代码空间有权访问哪些仓库。 - -默认情况下,代码空间只能访问创建它的仓库。 为组织拥有的仓库启用访问和安全后,则为该仓库创建的任何代码空间都将对该组织拥有的和代码空间创建者有权访问的所有其他仓库具有读取和写入权限。 如果要限制代码空间可以访问的仓库,您可以将其限制为创建代码空间的仓库或特定仓库。 您应该只对您信任的仓库启用访问和安全。 - -要管理组织中的哪些用户可以使用 {% data variables.product.prodname_codespaces %},请参阅“[管理组织的用户权限](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)”。 - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. 在“Access and security(访问和安全)”下,为组织选择所需的设置。 ![管理信任仓库的单选按钮](/assets/images/help/settings/codespaces-org-access-and-security-radio-buttons.png) -1. 如果您选择了“Selected repositories(所选仓库)”,请选择下拉菜单,然后单击一个仓库,以允许该仓库的代码空间访问组织拥有的其他仓库。 对于您要允许其代码空间访问其他仓库的所有仓库重复此操作。 !["所选仓库" 下拉菜单](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md deleted file mode 100644 index 8c4f220e2d..0000000000 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: 为您的仓库和代码空间组织管理加密的密钥 -shortTitle: 管理仓库和组织的密钥 -intro: '加密密钥允许您将敏感信息存储在您的组织、仓库或 {% data variables.product.prodname_codespaces %} 中。' -permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -### 关于密钥 - -密钥是您在组织或仓库中创建的加密环境变量。 您创建的密钥可用于 {% data variables.product.prodname_codespaces %}。 GitHub 在密钥到达 GitHub 之前使用 [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) 对其加密,并且仅当您在代码空间中使用它们时才予以解密。 - -组织级密钥允许在多个仓库之间共享密钥,从而减少创建重复密钥的需要。 您可以使用访问策略来控制哪些仓库可以使用组织密钥。 - -{% data reusables.codespaces.secrets-on-start %} - -#### 命名密钥 - -{% data reusables.codespaces.secrets-naming %} 例如,在仓库级别创建的密钥必须在该仓库中具有唯一的名称, 而在组织级创建的密钥必须在该级别有独特的名称。 - - {% data reusables.codespaces.secret-precedence %} - -#### 密码的限制 - -每个组织最多可存储 100 个密钥,每个仓库最多可存储 100 个密钥。 - -密码大小限于 64 KB。 - -### 为仓库添加密钥 - -要为组织仓库创建密码,您必须具有管理员访问权限。 - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.github-actions.sidebar-secret %} -1. 向下滚动页面并在 **Secrets(密钥)**下选择 **Codespaces**。 ![侧栏中的代码空间选项](/assets/images/help/codespaces/codespaces-option-secrets.png) -1. 在页面顶部,单击 **New repository secret(新仓库密钥)**。 -1. 在 **Name(名称)**输入框中键入密码的名称。 -1. 输入密码的值。 -1. 单击 **Add secret(添加密码)**。 - -### 为组织添加密钥 - -在组织中创建密码时,可以使用策略来限制可以访问该密码的仓库。 例如,您可以将访问权限授予所有仓库,也可以限制仅私有仓库或指定的仓库列表拥有访问权限。 - -{% data reusables.github-actions.permissions-statement-secrets-organization %} - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. 向下滚动页面并在 **Secrets(密钥)**下选择 **Codespaces**。 ![侧栏中的代码空间选项](/assets/images/help/codespaces/codespaces-option-secrets-org.png) -1. 在页面顶部,单击 **New organization secret(新组织密钥)**。 -1. 在 **Name(名称)**输入框中键入密码的名称。 -1. 输入密码的 **Value(值)**。 -1. 从 **Repository access(仓库访问权限)**下拉列表,选择访问策略。 ![已选定私有仓库的仓库访问列表](/assets/images/help/codespaces/secret-repository-access.png) -1. 单击 **Add secret(添加密码)**。 - -### 审查对组织级别密码的访问权限 - -您可以检查哪些访问策略应用于组织中的密钥。 - -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.github-actions.sidebar-secret %} -1. 密码列表包括任何已配置的权限和策略。 例如: ![密码列表](/assets/images/help/settings/actions-org-secrets-list.png) -1. 有关已为每个密码配置的权限的更多信息,请单击 **Update(更新)**。 diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md deleted file mode 100644 index f65da25405..0000000000 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: 管理组织的用户权限 -intro: '您可以控制组织中的哪些用户可以使用 {% data variables.product.prodname_codespaces %}。' -permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Permissions - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -### 关于 {% data variables.product.prodname_codespaces %} 的用户权限 - -组织所有者可以控制组织中的哪些用户可以创建和使用代码空间。 - -要使用组织中的代码空间,用户必须对他们要使用代码空间的仓库至少具有写入权限。 您可以对组织中的所有用户启用代码空间,也可以仅对特定用户启用。 - -默认情况下,代码空间只能访问创建它的仓库。 如果您希望组织中的代码空间能够访问代码空间创建者可以访问的其他组织仓库,请参阅“[管理 {% data variables.product.prodname_codespaces %} 的访问和安全](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)”。 - -### 配置组织中的哪些用户可以使用 {% data variables.product.prodname_codespaces %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.organizations.click-codespaces %} -1. 在“User permissions(用户权限)”下,选择以下选项之一: - - * **Disabled(禁用)**不允许任何组织成员使用 {% data variables.product.prodname_codespaces %}。 - * **Allow for all users(允许所有用户)**允许所有组织成员使用 {% data variables.product.prodname_codespaces %}。 - * **Selected users(所选用户)**选择特定组织成员使用 {% data variables.product.prodname_codespaces %}。 - - !["用户权限"单选按钮](/assets/images/help/codespaces/organization-user-permission-settings.png) diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md deleted file mode 100644 index fd55789c2a..0000000000 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 查看组织的代码空间审核日志 -shortTitle: 查看组织的审核日志 -intro: '您可以使用审核日志查看与 {% data variables.product.prodname_codespaces %} 相关的所有操作。' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Security - - Administrator ---- - -{% data reusables.codespaces.release-stage %} - -当组织的任何成员执行与 {% data variables.product.prodname_codespaces %} 相关的操作时,您可以在审核日志中查看这些操作。 有关访问日志的信息,请参阅“[查看您的审核日志](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)”。 - -![包含代码空间信息的审核日志](/assets/images/help/settings/codespaces-audit-log-org.png) - -审核日志包含操作执行人、操作内容和执行时间等详细信息。 有关 {% data variables.product.prodname_codespaces %} 操作的信息,请参阅“[{% data variables.product.prodname_codespaces %} 类别操作](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)”。 diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/index.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/index.md deleted file mode 100644 index 979fe8be5e..0000000000 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 管理代码空间 -intro: '您可以使用 {% data variables.product.prodname_github_codespaces %} 设置来管理代码空间可能需要的信息。' -versions: - free-pro-team: '*' -topics: - - Codespaces -redirect_from: - - /codespaces/working-with-your-codespace -children: - - /managing-encrypted-secrets-for-your-codespaces - - /managing-access-and-security-for-your-codespaces - - /reviewing-your-security-logs-for-codespaces - - /managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md deleted file mode 100644 index b008248c15..0000000000 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 管理代码空间的访问和安全 -intro: '您可以管理 {% data variables.product.prodname_codespaces %} 可以访问的仓库。' -versions: - free-pro-team: '*' -topics: - - Codespaces ---- - -{% data reusables.codespaces.release-stage %} - -为用户帐户拥有的仓库启用访问和安全后,为该仓库创建的任何代码空间都将对您拥有的所有其他仓库具有读取和写入权限。 如果要限制代码空间可以访问的仓库,您可以将其限制为代码空间打开的仓库或特定仓库。 您应该只对您信任的仓库启用访问和安全。 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. 在“Access and security(访问和安全)”下,为用户帐户选择所需的设置。 ![管理信任仓库的单选按钮](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) -1. 如果您选择了“Selected repositories(所选仓库)”,请选择下拉菜单,然后单击一个仓库,以允许该仓库的代码空间访问您拥有的其他仓库。 对于您要允许其代码空间访问您拥有的其他仓库的所有仓库重复此操作。 !["所选仓库" 下拉菜单](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md deleted file mode 100644 index c06f352d13..0000000000 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: 管理代码空间的加密密码 -intro: 您可以在代码空间中存储要通过环境变量访问的敏感信息(如令牌)。 -versions: - free-pro-team: '*' -redirect_from: - - /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces - - /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces -type: how_to -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - - -### 关于 {% data variables.product.prodname_codespaces %} 的加密密码 - -您可以将要在代码空间中使用的加密密码添加到您的用户帐户。 例如,您可能想要存储和访问以下敏感信息作为加密密码。 - -- 对云服务的个人访问令牌 -- 服务主体 -- 订阅标识符 -- [私人映像注册表的凭据](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry) - -您可以选择哪些仓库应有权访问每个密码。 然后,您可以在为有权访问密码的仓库创建的任何代码空间中使用该密码。 - -{% data reusables.codespaces.secrets-on-start %} - -#### 命名密钥 - -{% data reusables.codespaces.secrets-naming %} 例如,在仓库级别创建的密钥必须在该仓库中具有唯一的名称。 - - {% data reusables.codespaces.secret-precedence %} - -#### 密码的限制 - -您最多可以为 {% data variables.product.prodname_codespaces %} 存储 100 个密钥。 - -密码大小限于 64 KB。 - -### 添加密码 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. 在“Codespaces secrets(代码空间密码)”的右侧,单击 **New secret(新建密码)**。 !["新建密码"按钮](/assets/images/help/settings/codespaces-new-secret-button.png) -1. 在“Name(名称)”下,输入密码的名称。 !["名称"文本框](/assets/images/help/settings/codespaces-secret-name-field.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. 单击 **Add secret(添加密码)**。 - -### 编辑密码 - -您可以更新现有密码的值,也可以更改哪些仓库可以访问密码。 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. 在“Codespaces secrets(代码空间密码)”下您要编辑的密码右侧,单击 **Update(更新)**。 !["更新" 按钮](/assets/images/help/settings/codespaces-secret-update-button.png) -1. 在“Value(值)”下,单击 **enter a new value(输入新值)**。 !["输入新值" 链接](/assets/images/help/settings/codespaces-secret-update-value-text.png) -{% data reusables.user_settings.codespaces-secret-value %} -{% data reusables.user_settings.codespaces-secret-repository-access %} -1. (可选)要删除密码对仓库的访问权限,请取消选择仓库。 ![删除对仓库访问权限的复选框](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) -1. 单击 **Save changes(保存更改)**。 - -### 删除密码 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. 在“Codespaces secrets(代码空间密码)”下您要删除的密码右侧,单击 **Delete(删除)**。 !["删除" 按钮](/assets/images/help/settings/codespaces-secret-delete-button.png) -1. 阅读警告,然后单击 **OK(确定)**。 ![确认删除密码](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md deleted file mode 100644 index 4e86415536..0000000000 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: 管理代码空间的 GPG 验证 -intro: '您可以允许 {% data variables.product.company_short %} 自动使用 GPG 对在代码空间中所做的提交进行签名,以便其他人可以确信更改来自受信任的源。' -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Developer - - Security -redirect_from: - - /github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces - - /codespaces/working-with-your-codespace/managing-gpg-verification-for-codespaces ---- - -{% data reusables.codespaces.release-stage %} - -启用 GPG 验证后,{% data variables.product.company_short %} 将自动对您在 {% data variables.product.prodname_codespaces %} 中所做的提交进行签名,并且该提交在 {% data variables.product.product_name %} 上具有已验证状态。 默认情况下,GPG 验证对您创建的代码空间禁用。 您可以选择对所有仓库或特定仓库允许 GPG 验证。 仅对您信任的仓库启用 GPG 验证。 有关 {% data variables.product.product_name %} 签名提交的更多信息,请参阅“[关于提交签名验证](/github/authenticating-to-github/about-commit-signature-verification)”。 - -{% data reusables.user_settings.access_settings %} -{% data reusables.user_settings.codespaces-tab %} -1. 在“GPG verification(GPG 验证)”下,选择您想要的 GPG 验证设置。 ![管理 GPG 验证的单选按钮](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) -1. 如果您选择了“Selected repositories(所选仓库)”,请选择下拉菜单,然后单击想要启用 GPG 验证的仓库。 对您要启用 GPG 验证的所有仓库重复此操作。 !["所选仓库" 下拉菜单](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md deleted file mode 100644 index eff0c29401..0000000000 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: 查看代码空间的安全日志 -shortTitle: 审查您的安全日志 -intro: '您可以使用安全日志查看与 {% data variables.product.prodname_codespaces %} 相关的所有操作。' -versions: - free-pro-team: '*' -topics: - - Codespaces - - Developer - - Security ---- - -{% data reusables.codespaces.release-stage %} - -### 关于 {% data variables.product.prodname_codespaces %} 的安全日志 - -当您在用户帐户拥有的仓库中执行与 {% data variables.product.prodname_codespaces %} 相关的操作时,您可以查看安全日志中的操作。 有关访问日志的信息,请参阅“[查看您的安全日志](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)”。 - -![包含代码空间信息的安全日志](/assets/images/help/settings/codespaces-audit-log.png) - -安全日志包括发生了什么操作以及何时执行的操作等详细信息。 有关 {% data variables.product.prodname_codespaces %} 操作的信息,请参阅“[{% data variables.product.prodname_codespaces %} 类别操作](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)”。 diff --git a/translations/zh-CN/content/codespaces/quickstart.md b/translations/zh-CN/content/codespaces/quickstart.md deleted file mode 100644 index 54fbd6fb46..0000000000 --- a/translations/zh-CN/content/codespaces/quickstart.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Codespaces 快速入门 -intro: '在 5 分钟或更短的时间内尝试 {% data variables.product.prodname_codespaces %}。' -allowTitleToDifferFromFilename: true -versions: - free-pro-team: '*' -type: quick_start -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-quickstart ---- - -{% data reusables.codespaces.release-stage %} - -### 简介 - -在本指南中, 您将从[样本仓库](https://github.com/2percentsilk/haikus-for-codespaces)创建一个代码空间,并探索代码空间中您可以使用的一些基本功能。 - -以下示例显示如何创建代码空间、连接到转发端口以查看您的运行应用程序,以及如何通过额外的扩展和 dotfile 个性化您的设置。 - -### 创建代码空间 - -1. 导航到[样本仓库](https://github.com/2percentsilk/haikus-for-codespaces)的主页。 - -2. 在仓库名称下,使用 {% octicon "download" aria-label="The download icon" %} **Code(代码)**下拉菜单选择 **Open with Codespaces(使用 Codespaces 打开)**。 - - ![使用 Codespaces 打开按钮](/assets/images/help/codespaces/open-with-codespaces-button.png) - -3. 要创建代码空间,请单击 {% octicon "plus" aria-label="The plus icon" %} **New codespace(新建代码空间)**。 - - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) - -### 运行应用程序 - -在代码空间中打开项目后,您现在可以运行应用程序并在浏览器中启动它。 - -1. 通过在终端中输入 `npm run dev` 来启动应用程序。 此命令执行 package.json 文件中的 `dev` 脚本,并启动样本仓库中定义的 web 应用程序。 - - ![终端中的 npm run dev](/assets/images/help/codespaces/codespaces-npm-run-dev.png) - -2. 项目启动时,您应该在右下角看到一个信息框,提示您连接到项目使用的端口。 - - ![端口转发信息框](/assets/images/help/codespaces/quickstart-port-toast.png) - -3. 单击 **Open in Browser(在浏览器中打开)**,在新选项卡中查看正在运行的应用程序。 - -### 使用主题扩展进行个性化 - -在代码空间内,您可以访问 Visual Studio Code Marketplace。 在本示例中,您将安装可更改主题的扩展,但您可以安装对工作流程有用的任何扩展。 - -1. 在左侧栏中,单击扩展图标。 - -2. 在搜索栏中,输入 `fairyfloss` 并安装 fairyfloss 扩展。 - - ![添加扩展](/assets/images/help/codespaces/add-extension.png) - -3. 从列表中选择 `fairyfloss` 主题。 - - ![选择 fairyfloss 主题](/assets/images/help/codespaces/fairyfloss.png) - -4. 您在当前代码空间中对编辑器设置(如主题和键盘绑定)的更改通过 [Settings Sync(设置同步)](https://code.visualstudio.com/docs/editor/settings-sync)自动同步到其他代码空间。 - -### 使用 dotfile 个性化 - -如果您在 GitHub 上的用户帐户拥有名为 dotfiles 的公共仓库,GitHub 会在代码空间创建过程中自动使用此仓库来个性化您的代码空间环境。 - -此示例引导您为代码空间创建 dotfile 仓库。 - -1. 导航到样本 [dotfiles 仓库](https://github.com/aw-test-93/dotfiles/)。 - -2. 将仓库复刻到您的帐户,并确保它是公开的。 - - 验证在您的帐户下创建的仓库是否名为 dotfiles,例如 `yourname/dotfiles`。 任何其他名称将导致 {% data variables.product.prodname_codespaces %} 忽略个性化仓库。 - -3. 从[样本应用程序仓库](https://github.com/2percentsilk/haikus-for-codespaces)创建新的代码空间,因为 dotfile 更新仅在创建时应用。 样本 dotfiles 将命令提示符更改为粗体紫色和蓝色文本。 - - ![自定义命令提示符](/assets/images/help/codespaces/custom-prompt.png) - -### 后续步骤 - -您已经成功创建、个性化并在代码空间中运行了第一个应用程序,但还有很多需要探索的地方! 以下是一些帮助您对 {% data variables.product.prodname_codespaces %} 执行后续操作的有用资源: - - 使用带有特定语言的 {% data variables.product.prodname_codespaces %} 的“[入门指南](/codespaces/getting-started-with-codespaces)” - - [创建自定义配置](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)以配置项目的 {% data variables.product.prodname_codespaces %}。 diff --git a/translations/zh-CN/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md b/translations/zh-CN/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md deleted file mode 100644 index 66db1f03a9..0000000000 --- a/translations/zh-CN/content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: 为项目配置 Codespaces -intro: '您可以使用 `devcontainer.json` 文件来定义仓库的 {% data variables.product.prodname_codespaces %} 环境。' -permissions: People with write permissions to a repository can create or edit the codespace configuration. -redirect_from: - - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project - - /github/developing-online-with-codespaces/configuring-codespaces-for-your-project -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### 关于开发容器 - -开发容器是 {% data variables.product.prodname_codespaces %} 用于提供项目开发所需的工具和运行时的环境。 在 {% data variables.product.prodname_codespaces %} 中使用开发容器时,您可以[使用默认配置](#using-the-default-configuration)、[使用预先定义的配置](#using-a-pre-defined-container-configuration)或[创建自己的配置](#creating-a-custom-codespace-configuration)。 您选择的选项取决于用户在项目中取得成功可能需要使用的工具、运行时、依赖项和工作流程。 - -{% data variables.product.prodname_codespaces %} 允许使用 `devcontainer.json` 文件针对每个项目和每个分支进行自定义。 此配置文件通过定义可包括框架、工具、扩展和端口转发的开发容器,确定任何人为仓库创建的每个新代码空间的环境。 Dockerfile 还可与 `.devcontainer` 文件夹中的 `devcontainer.json` 文件一起使用,以定义创建容器映像所需的所有要素。 - -#### devcontainer.json - -{% data reusables.codespaces.devcontainer-location %} - -您可以使用 `devcontainer.json` 为整个代码空间环境设置默认设置,包括编辑器,但您也可以在 `.vscode/set.json` 文件中设置代码空间中单个[工作空间](https://code.visualstudio.com/docs/editor/workspaces)的编辑器特定设置。 - -有关在 `devcontainer.json` 中可以设置的设置和属性,请参阅 {% data variables.product.prodname_vscode %} 文档中的 [devcontainer.json 参考](https://aka.ms/vscode-remote/devcontainer.json)。 - -#### Dockerfile - -Dockerfile 也存在于 `.devcontainer` 文件夹中。 - -您可以将 Dockerfile 添加到项目中来定义容器映像和安装软件。 在 Dockerfile 中,您可以使用 `FROM` 来指定容器映像。 - -```Dockerfile -FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-14 - -# ** [Optional] Uncomment this section to install additional packages. ** -# USER root -# -# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ -# && apt-get -y install --no-install-recommends -# -# USER codespace -``` - -您可以使用 `RUN` 指令安装任何软件并使用 `&&` 加入命令。 - -使用 `dockerfile` 属性,在您的 `devcontainer.json` 文件中引用 Dockerfile。 - -```json -{ - ... - "build": { "dockerfile": "Dockerfile" }, - ... -} -``` - -有关在开发容器中使用 Dockerfile 的更多信息,请参阅 {% data variables.product.prodname_vscode %} 文档中的[创建开发容器](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile)。 - -### 使用默认配置 - -如果您没有在仓库中定义配置,{% data variables.product.prodname_dotcom %} 将创建一个具有基本 Linux 映像的代码空间。 基本 Linux 映像包括语言和运行时,例如 Python、Node.js、JavaScript、TypeScript、C++、Java、.NET、PHP、PowerShell、Go、Ruby 和 Rust。 它还包括其他开发工具和实用程序,例如 git、GitHub CLI、yarn、openssh 和 vim。 要查看包含的所有语言、运行时和工具,请在代码空间终端内使用 `devcontainer-info content-url` 命令,然后遵循命令输出的 url。 - -或者,要详细了解基本 Linux 映像中包含的所有内容,请参阅 [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) 仓库中的最新文件。 - -如果您要处理使用 {% data variables.product.prodname_codespaces %} 提供的语言和工具的小型项目,默认配置是个不错的选择。 - - -### 使用预定义的容器配置 - -预定义容器定义包括特定项目类型的共同配置,可帮助您利用现有的配置快速开始使用,配置中已经有适当的容器选项、{% data variables.product.prodname_vscode %} 设置和应该安装的 {% data variables.product.prodname_vscode %} 扩展。 - -如果您需要一些额外的扩展性,使用预先定义的配置是一个好主意。 您也可以从预定义的配置开始,然后根据项目的设置对其进行修改。 - -1. 要访问命令面板,请在左上角选择应用程序菜单,从 **View(视图)**菜单中单击 **Command Palette…(命令面板…)**,然后开始输入 "Codespaces: Add Development Container Configuration Files..."。 单击 **Codespaces: Add Development Container Configuration Files...(Codespaces:添加开发容器配置文件...)** ![命令选择板中的"Codespaces:添加开发容器配置文件..."](/assets/images/help/codespaces/add-prebuilt-container-command.png) -1. 单击要使用的定义。 ![预定义容器定义列表](/assets/images/help/codespaces/predefined-container-definitions-list.png) -1. 按照提示自定义您的定义。 -1. 单击 **OK(确定)**。 ![确定按钮](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. 要应用更改,请在屏幕右下角单击 **Rebuild now(立即重建)**。 有关重建容器的更多信息,请参阅“[应用对配置的更改](#applying-changes-to-your-configuration)”。 ![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/rebuild-prompt.png) - - -### 创建自定义代码空间配置 - -如果任何预定义的配置都不能满足您的需要,您可以通过添加 `devcontainer.json` 文件来创建自定义配置。 {% data reusables.codespaces.devcontainer-location %} - -在该文件中,您可以使用[支持的配置键](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)来指定代码空间环境的各个方面,例如要安装哪些 {% data variables.product.prodname_vscode %} 扩展。 - -{% data reusables.codespaces.vscode-settings-order %} - -您可以在两个地方定义 {% data variables.product.prodname_vscode %} 的默认编辑器设置。 - -* `.vscode/settings.json` 中定义的编辑器设置在代码空间中用作 _Workspace_ 范围的设置。 -* `devcontainer.json` 的 `settings` 键中定义的编辑器设置在代码空间中用作 _Remote [Codespaces]_ 范围的设置。 - -在更新 `devcontainer.json` 文件后,您可以重建代码空间的容器来应用更改。 更多信息请参阅“[应用对配置的更改](#applying-changes-to-your-configuration)”。 - - - - -### 应用对配置的更改 - -{% data reusables.codespaces.apply-devcontainer-changes %} - -1. {% data reusables.codespaces.rebuild-command %} -![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/rebuild-container-command.png) -1. {% data reusables.codespaces.recovery-mode %} 修复配置中的错误。 ![有关恢复模式的错误消息](/assets/images/help/codespaces/recovery-mode-error-message.png) - - 要通过查看创建日志来诊断错误,请单击 **View creation log(查看创建日志)**。 - - 要修复日志中发现的错误,请更新您的 `devcontainer.json` 文件。 - - 要应用更改,请重建容器。 {% data reusables.codespaces.rebuild-command %} diff --git a/translations/zh-CN/content/codespaces/setting-up-your-codespace/index.md b/translations/zh-CN/content/codespaces/setting-up-your-codespace/index.md deleted file mode 100644 index a9469721fb..0000000000 --- a/translations/zh-CN/content/codespaces/setting-up-your-codespace/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 设置代码空间 -intro: '{% data variables.product.prodname_codespaces %} 是您专用的环境。 您可以使用开发容器配置代码空间以安装依赖项,也可以添加 dotfile 以个性化用户设置。' -versions: - free-pro-team: '*' -topics: - - Codespaces -children: - - /configuring-codespaces-for-your-project - - /personalizing-codespaces-for-your-account ---- - -{% data reusables.codespaces.release-stage %} diff --git a/translations/zh-CN/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/translations/zh-CN/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md deleted file mode 100644 index fe2191be7e..0000000000 --- a/translations/zh-CN/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: 个性化您账户的 Codespaces -intro: '您可以通过使用 {% data variables.product.product_name %} 上的 `dotfiles` 仓库或使用设置同步来个性化 {% data variables.product.prodname_codespaces %}。' -permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.' -redirect_from: - - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account - - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account -versions: - free-pro-team: '*' -type: how_to -topics: - - Codespaces - - Set up - - Fundamentals ---- - -{% data reusables.codespaces.release-stage %} - -### 关于个性化 {% data variables.product.prodname_codespaces %} - -在使用任何开发环境时,根据您的喜好和工作流程自定义设置和工具是一个重要步骤。 {% data variables.product.prodname_codespaces %} 允许两种主要方法个性化您的代码空间。 - -- [设置同步](#settings-sync) - 您可以在 {% data variables.product.prodname_codespaces %} 与其他 {% data variables.product.prodname_vscode %}实例之间使用和共享 {% data variables.product.prodname_vscode %} 设置。 -- [Dotfiles](#dotfiles) - 您可以使用公共 `dotfiles` 仓库来指定脚本、shell 首选项和其他配置。 - -{% data variables.product.prodname_codespaces %} 个性化适用于您创建的任何代码空间。 - -项目维护员还可以定义默认配置,将应用到任何人创建的仓库的每个代码空间。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)”。 - -### 设置同步 - -设置同步允许您在机器和 {% data variables.product.prodname_vscode %} 实例中共享配置,如设置、键盘快捷方式、片段、扩展和 UI 状态。 - -设置同步默认打开。 要配置任何设置,在活动栏的左下角,选择 {% octicon "gear" aria-label="The gear icon" %} 并单击 **Settings Sync is on(设置同步打开)**。 从对话框中,您可以选择配置、显示设置和数据,或关闭设置同步。 - -![在管理菜单中设置同步选项](/assets/images/help/codespaces/codespaces-manage-settings-sync.png) - -更多信息请参阅 {% data variables.product.prodname_vscode %} 文档中的[设置同步指南](https://code.visualstudio.com/docs/editor/settings-sync)。 - -### Dotfiles - -Dotfiles 是类似 Unix 的系统上以 `.` 开头的文件和文件夹,用于控制系统上应用程序和 shell 的配置。 您可以在 {% data variables.product.prodname_dotcom %} 上的仓库中存储和管理 dotfiles。 有关 `dotfiles` 仓库中所含内容的建议和教程,请参阅 [GitHub 执行 dotfiles](https://dotfiles.github.io/)。 - -如果您在 {% data variables.product.prodname_dotcom %} 上的用户帐户拥有名为 `dotfiles` 的公共仓库,{% data variables.product.prodname_dotcom %} 会自动使用这个仓库来个性化设置您的代码空间环境。 私有 `dotfiles` 仓库目前不支持。 - -`dotfiles` 仓库可能包括 shell 别名和首选项、您想要安装的任何工具或您想要执行的任何其他代码个性化。 - -创建新的代码空间时,{% data variables.product.prodname_dotcom %} 会将 `dotfile` 仓库克隆到代码空间环境,并查找以下文件之一来设置环境。 - -* _install.sh_ -* _安装_ -* _bootstrap.sh_ -* _bootstrap_ -* _script/bootstrap_ -* _setup.sh_ -* _setup_ -* _script/setup_ - -如果未找到这些文件,则 `dotfiles` 中以 `.` 开头的文件或文件夹通过符号链接到代码空间的 `~` 或 `$HOME` 目录。 - -对 `dotfile` 仓库所做的任何更改只会应用到每个新的代码空间,而不影响任何现有的代码空间。 - -{% note %} - -**注:**目前,{% data variables.product.prodname_codespaces %} 不支持使用 `dotfiles` 仓库个性化 {% data variables.product.prodname_vscode %} 编辑器的_用户_设置。 您可以为项目仓库中的特定项目设置默认的 _Workspace_ 和 _Remote [Codespaces]_ 设置。 更多信息请参阅“[为项目配置 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)”。 - -{% endnote %} - -您还可以配置用户帐户的设置以添加加密密码、启用 GPG 验证以及允许代码空间访问其他仓库。 更多信息请参阅“[管理 {% data variables.product.prodname_codespaces %} 的加密密码](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)”、“[管理 {% data variables.product.prodname_codespaces %} 的 GPG 验证](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)”以及“[管理 {% data variables.product.prodname_codespaces %} 的访问权限和设置](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)”。 - -### 延伸阅读 - -* "[创建新仓库](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)" diff --git a/translations/zh-CN/data/reusables/codespaces/about-billing-for-codespaces.md b/translations/zh-CN/data/reusables/codespaces/about-billing-for-codespaces.md deleted file mode 100644 index 72c8cd8a84..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/about-billing-for-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_codespaces %} 在测试期间可免费使用。 当 {% data variables.product.prodname_codespaces %} 公开发布时,将按存储和计算使用情况计费。 diff --git a/translations/zh-CN/data/reusables/codespaces/about-configuration.md b/translations/zh-CN/data/reusables/codespaces/about-configuration.md deleted file mode 100644 index 2ce7536153..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/about-configuration.md +++ /dev/null @@ -1 +0,0 @@ -您可以为仓库创建默认代码空间配置,以确定任何人员为该仓库创建的每个新代码空间的环境。 配置定义一个可以包含框架、工具、扩展和端口转发的开发容器。 diff --git a/translations/zh-CN/data/reusables/codespaces/about-personalization.md b/translations/zh-CN/data/reusables/codespaces/about-personalization.md deleted file mode 100644 index d761204b51..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/about-personalization.md +++ /dev/null @@ -1 +0,0 @@ -您还可以使用 [dotfiles](https://dotfiles.github.io/tutorials/) 仓库和[设置同步](https://code.visualstudio.com/docs/editor/settings-sync)来针对您创建的任何代码空间而个性化代码空间环境的各个方面。 个性化可以包括 shell 首选项和其他工具。 diff --git a/translations/zh-CN/data/reusables/codespaces/about-port-forwarding.md b/translations/zh-CN/data/reusables/codespaces/about-port-forwarding.md deleted file mode 100644 index 3befc07c9d..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/about-port-forwarding.md +++ /dev/null @@ -1 +0,0 @@ -您可以转发代码空间中的端口以测试和调试应用程序。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/apply-devcontainer-changes.md b/translations/zh-CN/data/reusables/codespaces/apply-devcontainer-changes.md deleted file mode 100644 index a60d164f36..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/apply-devcontainer-changes.md +++ /dev/null @@ -1 +0,0 @@ -在仓库的 {% data variables.product.prodname_codespaces %} 配置更改后,您可以通过重建代码空间的容器来将更改应用于现有代码空间。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/beta-functionality-limited.md b/translations/zh-CN/data/reusables/codespaces/beta-functionality-limited.md deleted file mode 100644 index 5b16ea0119..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/beta-functionality-limited.md +++ /dev/null @@ -1,5 +0,0 @@ -在测试期间,功能是有限的。 -- {% data reusables.codespaces.use-chrome %} -- 只有一个大小的代码空间可用。 -- 只支持 Linux 容器。 -- 代码空间无法完全恢复。 代码空间停止时正在运行的进程将不会重新启动。 diff --git a/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md deleted file mode 100644 index c9ee5e8bfe..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ /dev/null @@ -1 +0,0 @@ -1. 在 {% data variables.product.prodname_vscode %} 中,从左侧边栏单击 Remote Explorer 图标。 ![{% data variables.product.prodname_vscode %} 中的 Remote Explorer 图标](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/codespace-config-order.md b/translations/zh-CN/data/reusables/codespaces/codespace-config-order.md deleted file mode 100644 index bdfac0d210..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/codespace-config-order.md +++ /dev/null @@ -1 +0,0 @@ -`dotfiles` 个性化的应用先于仓库的默认码空间配置。 diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-are-per-branch.md b/translations/zh-CN/data/reusables/codespaces/codespaces-are-per-branch.md deleted file mode 100644 index b25e402c60..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/codespaces-are-per-branch.md +++ /dev/null @@ -1 +0,0 @@ -每个代码空间与仓库的一个特定分支关联。 diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-are-personal.md b/translations/zh-CN/data/reusables/codespaces/codespaces-are-personal.md deleted file mode 100644 index 3c061e19f0..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/codespaces-are-personal.md +++ /dev/null @@ -1 +0,0 @@ -您创建的每个代码空间只有您才可以使用。 其他任何人都不能在您的代码空间中工作。 diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-machine-types.md b/translations/zh-CN/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index 3790918bb6..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,11 +0,0 @@ -您可以在三种类型的远程机器上运行代码空间:基本、标准或高级。 每种类型都有不同的资源水平和不同的计费等级。{% note %} - -**注:**{% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -切换机器类型使您可以灵活地选择最适合您工作的资源。 某些任务可能需要不同的机器类型: - -* **基本**,适用于更新文件和提出拉取请求 -* **标准**,适用于编辑网站 -* **高级**,适用于数据分析等高计算任务 diff --git a/translations/zh-CN/data/reusables/codespaces/committing-link-to-procedure.md b/translations/zh-CN/data/reusables/codespaces/committing-link-to-procedure.md deleted file mode 100644 index 5cfe774ce3..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/committing-link-to-procedure.md +++ /dev/null @@ -1,3 +0,0 @@ -在对代码空间进行更改(无论是添加新代码还是更改配置)之后,您需要提交更改。 将更改提交到仓库可确保从此仓库创建代码空间的其他任何人都具有相同的配置。 这也意味着您所做的任何自定义,例如添加 {% data variables.product.prodname_vscode %} 扩展,都会显示给所有用户。 - -有关信息,请参阅“[在代码空间中使用源控制](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)”。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md deleted file mode 100644 index 2cf2c0ee92..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md +++ /dev/null @@ -1 +0,0 @@ -每个仓库甚至每个分支可创建多个代码空间。 但是,在有限的公测期间,每个用户帐户限于两个代码空间。 如果您已达到上限,想要创建一个新的代码空间,必须先删除一个旧代码空间。 diff --git a/translations/zh-CN/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/translations/zh-CN/data/reusables/codespaces/connect-to-codespace-from-vscode.md deleted file mode 100644 index 795ded63dd..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ /dev/null @@ -1 +0,0 @@ -您可以直接从 {% data variables.product.prodname_vscode %} 连接至您的代码空间。 更多信息请参阅“[在 {% data variables.product.prodname_vscode %} 中使用代码空间](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)”。 diff --git a/translations/zh-CN/data/reusables/codespaces/devcontainer-location.md b/translations/zh-CN/data/reusables/codespaces/devcontainer-location.md deleted file mode 100644 index ee733ada20..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/devcontainer-location.md +++ /dev/null @@ -1 +0,0 @@ -此文件可位于存储库的根目录或名为 `.devtainer` 的文件夹中。 如果文件位于仓库的根目录中,文件名必须以一个点开头:`.devcontainer.json`。 diff --git a/translations/zh-CN/data/reusables/codespaces/navigate-to-codespaces.md b/translations/zh-CN/data/reusables/codespaces/navigate-to-codespaces.md deleted file mode 100644 index a8b97bfd40..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/navigate-to-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. 在任何页面顶部,单击 **Codespaces(代码空间)**。 ![标头中的 {% data variables.product.prodname_codespaces %} 链接](/assets/images/help/codespaces/header-link.png) diff --git a/translations/zh-CN/data/reusables/codespaces/navigate-to-ports-tab.md b/translations/zh-CN/data/reusables/codespaces/navigate-to-ports-tab.md deleted file mode 100644 index f0295e7701..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/navigate-to-ports-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 ![端口选项卡](/assets/images/help/codespaces/ports-tab.png) diff --git a/translations/zh-CN/data/reusables/codespaces/rebuild-command.md b/translations/zh-CN/data/reusables/codespaces/rebuild-command.md deleted file mode 100644 index 71e4f05ade..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/rebuild-command.md +++ /dev/null @@ -1 +0,0 @@ -访问命令面板 (`shift command P` / `shift control P`),然后开始输入 "Codespaces: Rebuild Container"。 单击 **Codespaces: Rebuild Container(代码空间:重建容器)**。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/recovery-mode.md b/translations/zh-CN/data/reusables/codespaces/recovery-mode.md deleted file mode 100644 index f2b5bae88a..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/recovery-mode.md +++ /dev/null @@ -1 +0,0 @@ -如果对代码空间的配置的更改导致容器错误,则代码空间将在恢复模式下运行,并且您将看到错误消息。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/release-stage.md b/translations/zh-CN/data/reusables/codespaces/release-stage.md deleted file mode 100644 index 3220d5951c..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/release-stage.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**注:**{% data variables.product.prodname_codespaces %} 目前是有限公测版,可能会有变动。 有关加入公测的更多信息,请参阅“[关于 {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#joining-the-beta)”。 - -{% endnote %} diff --git a/translations/zh-CN/data/reusables/codespaces/secret-precedence.md b/translations/zh-CN/data/reusables/codespaces/secret-precedence.md deleted file mode 100644 index a6c7d721bb..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/secret-precedence.md +++ /dev/null @@ -1 +0,0 @@ -如果具有相同名称的机密存在于多个级别,则较低级别的机密优先。 例如,如果组织级别密码的名称与仓库级别的密码相同,则仓库级别的密码优先。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/secrets-naming.md b/translations/zh-CN/data/reusables/codespaces/secrets-naming.md deleted file mode 100644 index a1a55d82be..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/secrets-naming.md +++ /dev/null @@ -1,7 +0,0 @@ -以下规则适用于密码名称: - -* 密码名称只能包含字母数字字符(`[a-z]`、`[A-Z]`、`[0-9]`)或下划线 (`_`)。 不允许空格。 -* 密码名称不能以 `GITHUB_` 前缀开头。 -* 密码名称不能以数字开头。 -* 机密名称不区分大小写。 -* 密码名称在所创建的级别上必须是唯一的。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/secrets-on-start.md b/translations/zh-CN/data/reusables/codespaces/secrets-on-start.md deleted file mode 100644 index 6a9dd8e3b7..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/secrets-on-start.md +++ /dev/null @@ -1 +0,0 @@ -一旦创建了密码,便可以在创建新的代码空间或重新启动代码空间时使用它。 要使用刚刚在当前代码空间中创建的密码,您需要暂停代码空间并恢复它。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/source-control-display-dark.md b/translations/zh-CN/data/reusables/codespaces/source-control-display-dark.md deleted file mode 100644 index d70b9ac93e..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/source-control-display-dark.md +++ /dev/null @@ -1 +0,0 @@ -1. 在活动栏中,单击 **Source Control(源控制)**视图。 ![源控制视图](/assets/images/help/codespaces/source-control-activity-bar-button.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/source-control-display.md b/translations/zh-CN/data/reusables/codespaces/source-control-display.md deleted file mode 100644 index e2a8cb8c77..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/source-control-display.md +++ /dev/null @@ -1,3 +0,0 @@ -1. 在活动栏中,单击 **Source Control(源控制)**视图。 - - ![源控制视图](/assets/images/help/codespaces/codespaces-commit-activity.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/type-port-label.md b/translations/zh-CN/data/reusables/codespaces/type-port-label.md deleted file mode 100644 index 150b8007e4..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/type-port-label.md +++ /dev/null @@ -1 +0,0 @@ -1. 键入端口的标签,然后按 enter。 ![输入端口标签的文本框](/assets/images/help/codespaces/label-text-box.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/unsupported-repos.md b/translations/zh-CN/data/reusables/codespaces/unsupported-repos.md deleted file mode 100644 index 498f150830..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/unsupported-repos.md +++ /dev/null @@ -1 +0,0 @@ -在测试阶段,不支持组织拥有的私有仓库或者组织拥有的需要 SAML 单点登录的任何仓库。 diff --git a/translations/zh-CN/data/reusables/codespaces/use-chrome.md b/translations/zh-CN/data/reusables/codespaces/use-chrome.md deleted file mode 100644 index f399152bdc..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/use-chrome.md +++ /dev/null @@ -1 +0,0 @@ -为获取 {% data variables.product.prodname_codespaces %} 最佳使用体验,建议使用基于 Chromium 的浏览器,如 Google Chrome 或 Microsoft Edge。 diff --git a/translations/zh-CN/data/reusables/codespaces/use-visual-studio-features.md b/translations/zh-CN/data/reusables/codespaces/use-visual-studio-features.md deleted file mode 100644 index dc30c73437..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/use-visual-studio-features.md +++ /dev/null @@ -1 +0,0 @@ -使用 {% data variables.product.prodname_vscode %} 在代码空间中开发时,您可以编辑代码、调试和使用 Git 命令。 更多信息请参阅 [{% data variables.product.prodname_vscode %} 文档](https://code.visualstudio.com/docs)。 diff --git a/translations/zh-CN/data/reusables/codespaces/vscode-settings-order.md b/translations/zh-CN/data/reusables/codespaces/vscode-settings-order.md deleted file mode 100644 index 28c82030d8..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/vscode-settings-order.md +++ /dev/null @@ -1 +0,0 @@ -配置 {% data variables.product.prodname_vscode %} 的编辑器设置时,有三个可用的作用域:_工作区_、_远程 [Codespaces]_和_用户_。 如果在多个作用域中定义了设置,_工作区_设置优先级最高,_远程 [Codespaces]_ 次之,最后是_用户_。 diff --git a/translations/zh-CN/data/reusables/codespaces/you-can-see-all-your-codespaces.md b/translations/zh-CN/data/reusables/codespaces/you-can-see-all-your-codespaces.md deleted file mode 100644 index 7ed08ce28a..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/you-can-see-all-your-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -您可以在 [github.com/codespaces](https://github.com/codespaces) 上查看您创建的每一个可用代码空间。 diff --git a/translations/zh-CN/data/reusables/codespaces/your-codespaces-procedure-step.md b/translations/zh-CN/data/reusables/codespaces/your-codespaces-procedure-step.md deleted file mode 100644 index 1d02c80a2e..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/your-codespaces-procedure-step.md +++ /dev/null @@ -1,3 +0,0 @@ -1. 在 {% data variables.product.product_name %} 的右上角,单击您的个人资料照片,然后单击 **Your codespaces(您的代码空间)**。 - - ![“您的代码空间”菜单选项](/assets/images/help/codespaces/your-codespaces-option.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/gated-features/codespaces.md b/translations/zh-CN/data/reusables/gated-features/codespaces.md deleted file mode 100644 index ae5565955b..0000000000 --- a/translations/zh-CN/data/reusables/gated-features/codespaces.md +++ /dev/null @@ -1 +0,0 @@ -代码空间可用于使用 {% data variables.product.prodname_free_user %} 或 {% data variables.product.prodname_pro %} 的用户帐户。 {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/zh-CN/data/reusables/organizations/click-codespaces.md b/translations/zh-CN/data/reusables/organizations/click-codespaces.md deleted file mode 100644 index fa9c09b609..0000000000 --- a/translations/zh-CN/data/reusables/organizations/click-codespaces.md +++ /dev/null @@ -1 +0,0 @@ -1. 在左侧边栏中,单击 **Codespaces**。 ![左侧边栏中的"Codespaces"选项卡](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/translations/zh-CN/data/reusables/user_settings/codespaces-secret-repository-access.md b/translations/zh-CN/data/reusables/user_settings/codespaces-secret-repository-access.md deleted file mode 100644 index 0279c32bf5..0000000000 --- a/translations/zh-CN/data/reusables/user_settings/codespaces-secret-repository-access.md +++ /dev/null @@ -1 +0,0 @@ -1. 选择“Repository access(仓库访问)”下拉菜单,然后单击要访问该机密的仓库。 对每个您想要访问该机密的仓库重复操作。 !["仓库访问"下拉菜单](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/user_settings/codespaces-secret-value.md b/translations/zh-CN/data/reusables/user_settings/codespaces-secret-value.md deleted file mode 100644 index d9aadc9325..0000000000 --- a/translations/zh-CN/data/reusables/user_settings/codespaces-secret-value.md +++ /dev/null @@ -1 +0,0 @@ -1. 在“Value(值)”下,输入密码的名称。 !["值"文本框](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/user_settings/codespaces-tab.md b/translations/zh-CN/data/reusables/user_settings/codespaces-tab.md deleted file mode 100644 index 0071bc8834..0000000000 --- a/translations/zh-CN/data/reusables/user_settings/codespaces-tab.md +++ /dev/null @@ -1 +0,0 @@ -1. 在左侧边栏中,单击 **Codespaces**。 ![用户设置侧边栏中的 Codespaces 选项卡](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file