diff --git a/src/graphql/data/dotcom/schema.json b/src/graphql/data/dotcom/schema.json index 5a114ba56d..0cb22b854d 100644 --- a/src/graphql/data/dotcom/schema.json +++ b/src/graphql/data/dotcom/schema.json @@ -2395,7 +2395,7 @@ "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.

", + "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", @@ -87320,7 +87320,7 @@ "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\nrepositoryNameWithOwner and branchName.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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\nrepositoryNameWithOwner and branchName.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -90806,7 +90806,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghae/schema.json b/src/graphql/data/ghae/schema.json index 9d8b830733..de0bcba1bf 100644 --- a/src/graphql/data/ghae/schema.json +++ b/src/graphql/data/ghae/schema.json @@ -1734,7 +1734,7 @@ "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.

", + "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", @@ -71487,7 +71487,7 @@ "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\nrepositoryNameWithOwner and branchName.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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\nrepositoryNameWithOwner and branchName.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -74207,7 +74207,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 5a114ba56d..0cb22b854d 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -2395,7 +2395,7 @@ "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.

", + "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", @@ -87320,7 +87320,7 @@ "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\nrepositoryNameWithOwner and branchName.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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\nrepositoryNameWithOwner and branchName.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -90806,7 +90806,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghes-3.4/schema.json b/src/graphql/data/ghes-3.4/schema.json index 5b60cdb7d4..b69a8cd73b 100644 --- a/src/graphql/data/ghes-3.4/schema.json +++ b/src/graphql/data/ghes-3.4/schema.json @@ -1618,7 +1618,7 @@ "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.

", + "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", @@ -66911,7 +66911,7 @@ "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.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -69257,7 +69257,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghes-3.5/schema.json b/src/graphql/data/ghes-3.5/schema.json index 0a1a9fa942..c48774c528 100644 --- a/src/graphql/data/ghes-3.5/schema.json +++ b/src/graphql/data/ghes-3.5/schema.json @@ -1652,7 +1652,7 @@ "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.

", + "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", @@ -67743,7 +67743,7 @@ "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.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -70163,7 +70163,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghes-3.6/schema.json b/src/graphql/data/ghes-3.6/schema.json index ad7a8ac64b..d332e19173 100644 --- a/src/graphql/data/ghes-3.6/schema.json +++ b/src/graphql/data/ghes-3.6/schema.json @@ -1668,7 +1668,7 @@ "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.

", + "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", @@ -68350,7 +68350,7 @@ "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.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -70770,7 +70770,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghes-3.7/schema.json b/src/graphql/data/ghes-3.7/schema.json index 0c46a44ea4..36a464f7ef 100644 --- a/src/graphql/data/ghes-3.7/schema.json +++ b/src/graphql/data/ghes-3.7/schema.json @@ -1770,7 +1770,7 @@ "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.

", + "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", @@ -73271,7 +73271,7 @@ "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\nrepositoryNameWithOwner and branchName.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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\nrepositoryNameWithOwner and branchName.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -75785,7 +75785,7 @@ "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
", + "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", diff --git a/src/graphql/data/ghes-3.8/schema.json b/src/graphql/data/ghes-3.8/schema.json index 33058f633f..38613eef5e 100644 --- a/src/graphql/data/ghes-3.8/schema.json +++ b/src/graphql/data/ghes-3.8/schema.json @@ -1872,7 +1872,7 @@ "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.

", + "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", @@ -75411,7 +75411,7 @@ "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\nrepositoryNameWithOwner and branchName.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", + "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\nrepositoryNameWithOwner and branchName.

\n

Examples #

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using repositoryNameWithOwner and branchName:

\n
{\n  \"repositoryNameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -78044,7 +78044,7 @@ "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
", + "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",