github
/
docs
зеркало из https://github.com/github/docs.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Action ran graphql script"update-files"

This commit is contained in:
rachmari 2021-09-09 16:37:20 +00:00 коммит произвёл GitHub
Родитель 741982627d
Коммит 361b273d1a
14 изменённых файлов: 14786 добавлений и 3495 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

301
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.
"""

2
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.

14
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

3635
data/graphql/ghes-3.2/schema.docs-enterprise.graphql
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

8
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.'

371
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.
"""

25
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": [
{

1974
lib/graphql/static/prerendered-input-objects.json
Просмотреть файл

Различия файлов скрыты, потому что одна или несколько строк слишком длинны

4620
lib/graphql/static/prerendered-objects.json
Просмотреть файл

Различия файлов скрыты, потому что одна или несколько строк слишком длинны

284
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"
}
]
}

328
lib/graphql/static/schema-dotcom.json
Просмотреть файл

@ -781,26 +781,6 @@
}
]
},
{
"name": "sponsorsListing",
"type": "SponsorsListing",
"kind": "objects",
"id": "sponsorslisting",
"href": "/graphql/reference/objects#sponsorslisting",
"description": "<p>Look up a single Sponsors Listing.</p>",
"isDeprecated": true,
"deprecationReason": "<p><code>Query.sponsorsListing</code> will be removed. Use <code>Sponsorable.sponsorsListing</code> instead. Removal on 2020-04-01 UTC.</p>",
"args": [
{
"name": "slug",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>Select the Sponsors listing which matches this slug.</p>"
}
]
},
{
"name": "topic",
"type": "Topic",
@ -1601,6 +1581,40 @@
}
]
},
{
"name": "cancelSponsorship",
"kind": "mutations",
"id": "cancelsponsorship",
"href": "/graphql/reference/mutations#cancelsponsorship",
"description": "<p>Cancel an active sponsorship.</p>",
"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": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "sponsorsTier",
"type": "SponsorsTier",
"id": "sponsorstier",
"kind": "objects",
"href": "/graphql/reference/objects#sponsorstier",
"description": "<p>The tier that was being used at the time of cancellation.</p>"
}
]
},
{
"name": "changeUserStatus",
"kind": "mutations",
@ -1983,6 +1997,48 @@
}
]
},
{
"name": "createCommitOnBranch",
"kind": "mutations",
"id": "createcommitonbranch",
"href": "/graphql/reference/mutations#createcommitonbranch",
"description": "<p>Appends a commit to the given branch as the authenticated user.</p>\n<p>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 <code>git commit</code>.</p>\n<h2 id=\"locating-a-branch\"><a href=\"#locating-a-branch\">Locating a Branch</a></h2>\n<p>Commits are appended to a <code>branch</code> of type <code>Ref</code>.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with <code>refs/heads/</code>, although including this prefix is optional.</p>\n<p>Callers may specify the <code>branch</code> to commit to either by its global node\nID or by passing both of <code>repositoryNameWithOwner</code> and <code>refName</code>. For\nmore details see the documentation for <code>CommittableBranch</code>.</p>\n<h2 id=\"describing-changes\"><a href=\"#describing-changes\">Describing Changes</a></h2>\n<p><code>fileChanges</code> are specified as a <code>FilesChanges</code> object describing\n<code>FileAdditions</code> and <code>FileDeletions</code>.</p>\n<p>Please see the documentation for <code>FileChanges</code> for more information on\nhow to use this argument to describe any set of file changes.</p>\n<h2 id=\"authorship\"><a href=\"#authorship\">Authorship</a></h2>\n<p>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.</p>\n<p>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.</p>\n<p>If you need full control over author and committer information, please\nuse the Git Database REST API instead.</p>\n<h2 id=\"commit-signing\"><a href=\"#commit-signing\">Commit Signing</a></h2>\n<p>Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.</p>",
"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": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "commit",
"type": "Commit",
"id": "commit",
"kind": "objects",
"href": "/graphql/reference/objects#commit",
"description": "<p>The new commit.</p>"
},
{
"name": "ref",
"type": "Ref",
"id": "ref",
"kind": "objects",
"href": "/graphql/reference/objects#ref",
"description": "<p>The ref which has been updated to point to the new commit.</p>"
}
]
},
{
"name": "createContentAttachment",
"kind": "mutations",
@ -70706,6 +70762,57 @@
}
]
},
{
"name": "CancelSponsorshipInput",
"kind": "inputObjects",
"id": "cancelsponsorshipinput",
"href": "/graphql/reference/input-objects#cancelsponsorshipinput",
"description": "<p>Autogenerated input type of CancelSponsorship.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "sponsorId",
"description": "<p>The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.</p>",
"type": "ID",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "sponsorLogin",
"description": "<p>The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "sponsorableId",
"description": "<p>The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.</p>",
"type": "ID",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "sponsorableLogin",
"description": "<p>The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.</p>",
"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": "<p>A message to include with a new commit.</p>",
"inputFields": [
{
"name": "body",
"description": "<p>The body of the message.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "headline",
"description": "<p>The headline of the message.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
]
},
{
"name": "CommittableBranch",
"kind": "inputObjects",
"id": "committablebranch",
"href": "/graphql/reference/input-objects#committablebranch",
"description": "<p>A git ref for a commit to be appended to.</p>\n<p>The ref must be a branch, i.e. its fully qualified name must start\nwith <code>refs/heads/</code> (although the input is not required to be fully\nqualified).</p>\n<p>The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.</p>",
"inputFields": [
{
"name": "branchName",
"description": "<p>The unqualified name of the branch to append the commit to.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "id",
"description": "<p>The Node ID of the Ref to be updated.</p>",
"type": "ID",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
},
{
"name": "repositoryNameWithOwner",
"description": "<p>The nameWithOwner of the repository to commit to.</p>",
"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": "<p>Autogenerated input type of CreateCommitOnBranch.</p>",
"inputFields": [
{
"name": "branch",
"description": "<p>The Ref to be updated. Must be a branch.</p>",
"type": "CommittableBranch!",
"id": "committablebranch",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#committablebranch"
},
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "expectedHeadOid",
"description": "<p>The git commit oid expected at the head of the branch prior to the commit.</p>",
"type": "GitObjectID!",
"id": "gitobjectid",
"kind": "scalars",
"href": "/graphql/reference/scalars#gitobjectid"
},
{
"name": "fileChanges",
"description": "<p>A description of changes to files in this commit.</p>",
"type": "FileChanges",
"id": "filechanges",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#filechanges"
},
{
"name": "message",
"description": "<p>The commit message the be included with the commit.</p>",
"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": "<p>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.</p>",
"inputFields": [
{
"name": "contents",
"description": "<p>The base64 encoded contents of the file.</p>",
"type": "Base64String!",
"id": "base64string",
"kind": "scalars",
"href": "/graphql/reference/scalars#base64string"
},
{
"name": "path",
"description": "<p>The path in the repository where the file will be located.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
]
},
{
"name": "FileChanges",
"kind": "inputObjects",
"id": "filechanges",
"href": "/graphql/reference/input-objects#filechanges",
"description": "<p>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 <code>additions</code> and zero or more\nfile <code>deletions</code>.</p>\n<p>Both fields are optional; omitting both will produce a commit with no\nfile changes.</p>\n<p><code>deletions</code> and <code>additions</code> describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n<code>/</code>. The root of a git tree is an empty string, so paths are not\nslash-prefixed.</p>\n<p><code>path</code> values must be unique across all <code>additions</code> and <code>deletions</code>\nprovided. Any duplication will result in a validation error.</p>\n<h2 id=\"encoding\"><a href=\"#encoding\">Encoding</a></h2>\n<p>File contents must be provided in full for each <code>FileAddition</code>.</p>\n<p>The <code>contents</code> of a <code>FileAddition</code> 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.</p>\n<p>The encoded contents may be binary.</p>\n<p>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 (<code>\\n</code> or <code>\\r\\n</code>), and that all files end\nwith a newline.</p>\n<h2 id=\"modeling-file-changes\"><a href=\"#modeling-file-changes\">Modeling file changes</a></h2>\n<p>Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the <code>FileChanges</code> type as follows:</p>\n<ol>\n<li>\n<p>New file addition: create file <code>hello world\\n</code> at path <code>docs/README.txt</code>:</p>\n<p> {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}</p>\n</li>\n<li>\n<p>Existing file modification: change existing <code>docs/README.txt</code> to have new\ncontent <code>new content here\\n</code>:</p>\n<pre><code>{\n \"additions\" [\n {\n \"path\": \"docs/README.txt\",\n \"contents\": base64encode(\"new content here\\n\")\n }\n ]\n}\n</code></pre>\n</li>\n<li>\n<p>Existing file deletion: remove existing file <code>docs/README.txt</code>.\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.</p>\n<pre><code>{\n \"deletions\" [\n {\n \"path\": \"docs/README.txt\"\n }\n ]\n}\n</code></pre>\n</li>\n<li>\n<p>File rename with no changes: rename <code>docs/README.txt</code> with\nprevious content <code>hello world\\n</code> to the same content at\n<code>newdocs/README.txt</code>:</p>\n<pre><code>{\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</code></pre>\n</li>\n<li>\n<p>File rename with changes: rename <code>docs/README.txt</code> with\nprevious content <code>hello world\\n</code> to a file at path\n<code>newdocs/README.txt</code> with content <code>new contents\\n</code>:</p>\n<pre><code>{\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</code></pre>\n</li>\n</ol>",
"inputFields": [
{
"name": "additions",
"description": "<p>File to add or change.</p>",
"type": "[FileAddition!]",
"id": "fileaddition",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#fileaddition"
},
{
"name": "deletions",
"description": "<p>Files to delete.</p>",
"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": "<p>A command to delete the file at the given path as part of a commit.</p>",
"inputFields": [
{
"name": "path",
"description": "<p>The path to delete.</p>",
"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": "<p>A (potentially binary) string encoded using base64.</p>"
},
{
"name": "Boolean",
"description": "Represents `true` or `false` values.",

223
lib/graphql/static/schema-ghae.json
Просмотреть файл

@ -1540,6 +1540,48 @@
}
]
},
{
"name": "createCommitOnBranch",
"kind": "mutations",
"id": "createcommitonbranch",
"href": "/graphql/reference/mutations#createcommitonbranch",
"description": "<p>Appends a commit to the given branch as the authenticated user.</p>\n<p>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 <code>git commit</code>.</p>\n<h2 id=\"locating-a-branch\"><a href=\"#locating-a-branch\">Locating a Branch</a></h2>\n<p>Commits are appended to a <code>branch</code> of type <code>Ref</code>.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with <code>refs/heads/</code>, although including this prefix is optional.</p>\n<p>Callers may specify the <code>branch</code> to commit to either by its global node\nID or by passing both of <code>repositoryNameWithOwner</code> and <code>refName</code>. For\nmore details see the documentation for <code>CommittableBranch</code>.</p>\n<h2 id=\"describing-changes\"><a href=\"#describing-changes\">Describing Changes</a></h2>\n<p><code>fileChanges</code> are specified as a <code>FilesChanges</code> object describing\n<code>FileAdditions</code> and <code>FileDeletions</code>.</p>\n<p>Please see the documentation for <code>FileChanges</code> for more information on\nhow to use this argument to describe any set of file changes.</p>\n<h2 id=\"authorship\"><a href=\"#authorship\">Authorship</a></h2>\n<p>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.</p>\n<p>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.</p>\n<p>If you need full control over author and committer information, please\nuse the Git Database REST API instead.</p>\n<h2 id=\"commit-signing\"><a href=\"#commit-signing\">Commit Signing</a></h2>\n<p>Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.</p>",
"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": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "commit",
"type": "Commit",
"id": "commit",
"kind": "objects",
"href": "/graphql/reference/objects#commit",
"description": "<p>The new commit.</p>"
},
{
"name": "ref",
"type": "Ref",
"id": "ref",
"kind": "objects",
"href": "/graphql/reference/objects#ref",
"description": "<p>The ref which has been updated to point to the new commit.</p>"
}
]
},
{
"name": "createContentAttachment",
"kind": "mutations",
@ -64218,6 +64260,64 @@
}
]
},
{
"name": "CommitMessage",
"kind": "inputObjects",
"id": "commitmessage",
"href": "/graphql/reference/input-objects#commitmessage",
"description": "<p>A message to include with a new commit.</p>",
"inputFields": [
{
"name": "body",
"description": "<p>The body of the message.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "headline",
"description": "<p>The headline of the message.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
]
},
{
"name": "CommittableBranch",
"kind": "inputObjects",
"id": "committablebranch",
"href": "/graphql/reference/input-objects#committablebranch",
"description": "<p>A git ref for a commit to be appended to.</p>\n<p>The ref must be a branch, i.e. its fully qualified name must start\nwith <code>refs/heads/</code> (although the input is not required to be fully\nqualified).</p>\n<p>The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.</p>",
"inputFields": [
{
"name": "branchName",
"description": "<p>The unqualified name of the branch to append the commit to.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "id",
"description": "<p>The Node ID of the Ref to be updated.</p>",
"type": "ID",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id"
},
{
"name": "repositoryNameWithOwner",
"description": "<p>The nameWithOwner of the repository to commit to.</p>",
"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": "<p>Autogenerated input type of CreateCommitOnBranch.</p>",
"inputFields": [
{
"name": "branch",
"description": "<p>The Ref to be updated. Must be a branch.</p>",
"type": "CommittableBranch!",
"id": "committablebranch",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#committablebranch"
},
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "expectedHeadOid",
"description": "<p>The git commit oid expected at the head of the branch prior to the commit.</p>",
"type": "GitObjectID!",
"id": "gitobjectid",
"kind": "scalars",
"href": "/graphql/reference/scalars#gitobjectid"
},
{
"name": "fileChanges",
"description": "<p>A description of changes to files in this commit.</p>",
"type": "FileChanges",
"id": "filechanges",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#filechanges"
},
{
"name": "message",
"description": "<p>The commit message the be included with the commit.</p>",
"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": "<p>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.</p>",
"inputFields": [
{
"name": "contents",
"description": "<p>The base64 encoded contents of the file.</p>",
"type": "Base64String!",
"id": "base64string",
"kind": "scalars",
"href": "/graphql/reference/scalars#base64string"
},
{
"name": "path",
"description": "<p>The path in the repository where the file will be located.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
]
},
{
"name": "FileChanges",
"kind": "inputObjects",
"id": "filechanges",
"href": "/graphql/reference/input-objects#filechanges",
"description": "<p>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 <code>additions</code> and zero or more\nfile <code>deletions</code>.</p>\n<p>Both fields are optional; omitting both will produce a commit with no\nfile changes.</p>\n<p><code>deletions</code> and <code>additions</code> describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n<code>/</code>. The root of a git tree is an empty string, so paths are not\nslash-prefixed.</p>\n<p><code>path</code> values must be unique across all <code>additions</code> and <code>deletions</code>\nprovided. Any duplication will result in a validation error.</p>\n<h2 id=\"encoding\"><a href=\"#encoding\">Encoding</a></h2>\n<p>File contents must be provided in full for each <code>FileAddition</code>.</p>\n<p>The <code>contents</code> of a <code>FileAddition</code> 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.</p>\n<p>The encoded contents may be binary.</p>\n<p>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 (<code>\\n</code> or <code>\\r\\n</code>), and that all files end\nwith a newline.</p>\n<h2 id=\"modeling-file-changes\"><a href=\"#modeling-file-changes\">Modeling file changes</a></h2>\n<p>Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the <code>FileChanges</code> type as follows:</p>\n<ol>\n<li>\n<p>New file addition: create file <code>hello world\\n</code> at path <code>docs/README.txt</code>:</p>\n<p> {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}</p>\n</li>\n<li>\n<p>Existing file modification: change existing <code>docs/README.txt</code> to have new\ncontent <code>new content here\\n</code>:</p>\n<pre><code>{\n \"additions\" [\n {\n \"path\": \"docs/README.txt\",\n \"contents\": base64encode(\"new content here\\n\")\n }\n ]\n}\n</code></pre>\n</li>\n<li>\n<p>Existing file deletion: remove existing file <code>docs/README.txt</code>.\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.</p>\n<pre><code>{\n \"deletions\" [\n {\n \"path\": \"docs/README.txt\"\n }\n ]\n}\n</code></pre>\n</li>\n<li>\n<p>File rename with no changes: rename <code>docs/README.txt</code> with\nprevious content <code>hello world\\n</code> to the same content at\n<code>newdocs/README.txt</code>:</p>\n<pre><code>{\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</code></pre>\n</li>\n<li>\n<p>File rename with changes: rename <code>docs/README.txt</code> with\nprevious content <code>hello world\\n</code> to a file at path\n<code>newdocs/README.txt</code> with content <code>new contents\\n</code>:</p>\n<pre><code>{\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</code></pre>\n</li>\n</ol>",
"inputFields": [
{
"name": "additions",
"description": "<p>File to add or change.</p>",
"type": "[FileAddition!]",
"id": "fileaddition",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#fileaddition"
},
{
"name": "deletions",
"description": "<p>Files to delete.</p>",
"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": "<p>A command to delete the file at the given path as part of a commit.</p>",
"inputFields": [
{
"name": "path",
"description": "<p>The path to delete.</p>",
"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": "<p>A (potentially binary) string encoded using base64.</p>"
},
{
"name": "Boolean",
"description": "Represents `true` or `false` values.",

6194
lib/graphql/static/schema-ghes-3.2.json
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

302
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": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "Query.sponsorsListing",
"description": "<p><code>sponsorsListing</code> will be removed. Use <code>Sponsorable.sponsorsListing</code> instead.</p>",
"reason": "<p><code>Query.sponsorsListing</code> will be removed.</p>",
"location": "EnterpriseBillingInfo.seats",
"description": "<p><code>seats</code> will be removed. Use EnterpriseBillingInfo.totalLicenses instead.</p>",
"reason": "<p><code>seats</code> will be replaced with <code>totalLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "EnterpriseBillingInfo.availableSeats",
"description": "<p><code>availableSeats</code> will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.</p>",
"reason": "<p><code>availableSeats</code> will be replaced with <code>totalAvailableLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
},
"ghes-3.2": {
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
},
{
"location": "EnterprisePendingCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseOutsideCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All outside collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseMemberEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All members consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-10-01": [
{
"location": "Sponsorship.sponsor",
"description": "<p><code>sponsor</code> will be removed. Use <code>Sponsorship.sponsorEntity</code> instead.</p>",
"reason": "<p><code>Sponsorship.sponsor</code> will be removed.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "nholden"
},
{
"location": "RepositoryInvitationOrderField.INVITEE_LOGIN",
"description": "<p><code>INVITEE_LOGIN</code> will be removed.</p>",
"reason": "<p><code>INVITEE_LOGIN</code> is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "jdennes"
},
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "EnterpriseOwnerInfo.pendingCollaborators",
"description": "<p><code>pendingCollaborators</code> will be removed. Use the <code>pendingCollaboratorInvitations</code> field instead.</p>",
"reason": "<p>Repository invitations can now be associated with an email, not only an invitee.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "jdennes"
}
],
"2020-07-01": [
{
"location": "EnterprisePendingMemberInvitationEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending members consume a license</p>",
"date": "2020-07-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-04-01": [
{
"location": "Sponsorship.maintainer",
"description": "<p><code>maintainer</code> will be removed. Use <code>Sponsorship.sponsorable</code> instead.</p>",
"reason": "<p><code>Sponsorship.maintainer</code> will be removed.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "antn"
@ -754,147 +908,5 @@
"owner": "tambling"
}
]
},
"ghes-3.2": {
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
},
{
"location": "EnterprisePendingCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseOutsideCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All outside collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseMemberEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All members consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-10-01": [
{
"location": "Sponsorship.sponsor",
"description": "<p><code>sponsor</code> will be removed. Use <code>Sponsorship.sponsorEntity</code> instead.</p>",
"reason": "<p><code>Sponsorship.sponsor</code> will be removed.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "nholden"
},
{
"location": "RepositoryInvitationOrderField.INVITEE_LOGIN",
"description": "<p><code>INVITEE_LOGIN</code> will be removed.</p>",
"reason": "<p><code>INVITEE_LOGIN</code> is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "jdennes"
},
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "EnterpriseOwnerInfo.pendingCollaborators",
"description": "<p><code>pendingCollaborators</code> will be removed. Use the <code>pendingCollaboratorInvitations</code> field instead.</p>",
"reason": "<p>Repository invitations can now be associated with an email, not only an invitee.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "jdennes"
}
],
"2020-07-01": [
{
"location": "EnterprisePendingMemberInvitationEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending members consume a license</p>",
"date": "2020-07-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-04-01": [
{
"location": "Sponsorship.maintainer",
"description": "<p><code>maintainer</code> will be removed. Use <code>Sponsorship.sponsorable</code> instead.</p>",
"reason": "<p><code>Sponsorship.maintainer</code> will be removed.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "antn"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "EnterpriseBillingInfo.seats",
"description": "<p><code>seats</code> will be removed. Use EnterpriseBillingInfo.totalLicenses instead.</p>",
"reason": "<p><code>seats</code> will be replaced with <code>totalLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "EnterpriseBillingInfo.availableSeats",
"description": "<p><code>availableSeats</code> will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.</p>",
"reason": "<p><code>availableSeats</code> will be replaced with <code>totalAvailableLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}
}