From 8854bb0414840f6cf76c7468b05c1a48d1cb9f42 Mon Sep 17 00:00:00 2001 From: Jason Lee Date: Sun, 25 Sep 2022 00:11:10 +0800 Subject: [PATCH] AutoCorrect fix for translations/zh-CN/content/{graphql,github-cli} --- .../creating-github-cli-extensions.md | 52 ++++++------ .../github-cli/github-cli-reference.md | 2 +- .../github-cli/github-cli/quickstart.md | 8 +- .../github-cli/using-github-cli-extensions.md | 16 ++-- translations/zh-CN/content/graphql/README.md | 4 +- .../guides/forming-calls-with-graphql.md | 80 +++++++++---------- .../graphql/guides/introduction-to-graphql.md | 26 +++--- .../guides/managing-enterprise-accounts.md | 20 ++--- .../migrating-graphql-global-node-ids.md | 16 ++-- .../graphql/guides/using-global-node-ids.md | 12 +-- .../graphql/guides/using-the-explorer.md | 14 ++-- .../using-the-graphql-api-for-discussions.md | 36 ++++----- .../graphql/overview/breaking-changes.md | 10 +-- .../content/graphql/overview/changelog.md | 4 +- .../zh-CN/content/graphql/overview/index.md | 2 +- .../graphql/overview/resource-limitations.md | 20 ++--- .../graphql/overview/schema-previews.md | 4 +- .../zh-CN/content/graphql/reference/enums.md | 2 +- .../graphql/reference/input-objects.md | 2 +- .../content/graphql/reference/interfaces.md | 2 +- .../content/graphql/reference/mutations.md | 2 +- .../content/graphql/reference/objects.md | 2 +- .../content/graphql/reference/queries.md | 2 +- .../zh-CN/content/graphql/reference/unions.md | 2 +- 24 files changed, 170 insertions(+), 170 deletions(-) diff --git a/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md b/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md index eb22e5a7f1e0..71a1f668b1a7 100644 --- a/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md +++ b/translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md @@ -19,11 +19,11 @@ ms.locfileid: '145066719' {% data reusables.cli.cli-extensions %} 有关如何使用 {% data variables.product.prodname_cli %} 扩展的详细信息，请参阅“[使用 {% data variables.product.prodname_cli %} 扩展](/github-cli/github-cli/using-github-cli-extensions)”。 -对于您创建的每个扩展，都需要一个存储库。 存储库名称必须以 `gh-` 开头。 存储库名称的其余部分是扩展的名称。 存储库的根目录下必须有一个与存储库同名的可执行文件，或者附加到发行版的一组预编译二进制可执行文件。 +对于您创建的每个扩展，都需要一个存储库。存储库名称必须以 `gh-` 开头。存储库名称的其余部分是扩展的名称。存储库的根目录下必须有一个与存储库同名的可执行文件，或者附加到发行版的一组预编译二进制可执行文件。 {% note %} -**注意**：当依赖于可执行脚本时，我们建议使用 bash 脚本，因为 bash 是一种广泛使用的解释器。 您可以使用非 bash 脚本，但用户必须安装必要的解译程序才能使用扩展。 如果您不希望依赖安装了解译程序的用户，请考虑使用预编译扩展。 +**注意**：当依赖于可执行脚本时，我们建议使用 bash 脚本，因为 bash 是一种广泛使用的解释器。您可以使用非 bash 脚本，但用户必须安装必要的解译程序才能使用扩展。如果您不希望依赖安装了解译程序的用户，请考虑使用预编译扩展。 {% endnote %} @@ -37,7 +37,7 @@ ms.locfileid: '145066719' 可以使用 `gh extension create` 命令为扩展创建一个项目，包括包含一些起始代码的 bash 脚本。 -1. 使用 `gh extension create` 子命令设置新的扩展。 将 `EXTENSION-NAME` 替换为扩展的名称。 +1. 使用 `gh extension create` 子命令设置新的扩展。将 `EXTENSION-NAME` 替换为扩展的名称。 ```shell gh extension create EXTENSION-NAME @@ -49,7 +49,7 @@ ms.locfileid: '145066719' 可以使用 `--precompiled=go` 参数为扩展创建基于 Go 的项目，包括 Go 基架、工作流基架和起始代码。 -1. 使用 `gh extension create` 子命令设置新的扩展。 将 `EXTENSION-NAME` 替换为扩展的名称并指定 `--precompiled=go`。 +1. 使用 `gh extension create` 子命令设置新的扩展。将 `EXTENSION-NAME` 替换为扩展的名称并指定 `--precompiled=go`。 ```shell gh extension create --precompiled=go EXTENSION-NAME @@ -61,7 +61,7 @@ ms.locfileid: '145066719' 可以使用 `--precompiled=other` 参数为非 Go 预编译扩展（包括工作流基架）创建项目。 -1. 使用 `gh extension create` 子命令设置新的扩展。 将 `EXTENSION-NAME` 替换为扩展的名称并指定 `--precompiled=other`。 +1. 使用 `gh extension create` 子命令设置新的扩展。将 `EXTENSION-NAME` 替换为扩展的名称并指定 `--precompiled=other`。 ```shell gh extension create --precompiled=other EXTENSION-NAME @@ -75,17 +75,17 @@ ms.locfileid: '145066719' ## 手动创建解译的扩展 -1. 为扩展创建一个名为 `gh-EXTENSION-NAME` 的本地目录。 将 `EXTENSION-NAME` 替换为扩展的名称。 例如 `gh-whoami`。 +1. 为扩展创建一个名为 `gh-EXTENSION-NAME` 的本地目录。将 `EXTENSION-NAME` 替换为扩展的名称。例如 `gh-whoami`。 1. 在您创建的目录中，添加与该目录同名的可执行文件。 {% note %} - **注意：** 请确保你的文件是可执行的。 在 Unix 上，可以在命令行中执行 `chmod +x file_name` 以使 `file_name` 可执行。 在 Windows 上，可以运行 `git init -b main`、`git add file_name`，然后运行 `git update-index --chmod=+x file_name`。 + **注意：** 请确保你的文件是可执行的。在 Unix 上，可以在命令行中执行 `chmod +x file_name` 以使 `file_name` 可执行。在 Windows 上，可以运行 `git init -b main`、`git add file_name`，然后运行 `git update-index --chmod=+x file_name`。 {% endnote %} -1. 在可执行文件中编写脚本。 例如： +1. 在可执行文件中编写脚本。例如： ```bash #!/usr/bin/env bash @@ -99,13 +99,13 @@ ms.locfileid: '145066719' gh extension install . ``` -1. 验证您的扩展是否正常工作。 将 `EXTENSION-NAME` 替换为扩展的名称。 例如 `whoami`。 +1. 验证您的扩展是否正常工作。将 `EXTENSION-NAME` 替换为扩展的名称。例如 `whoami`。 ```shell gh EXTENSION-NAME ``` -1. 从目录中，创建一个存储库以发布扩展。 将 `EXTENSION-NAME` 替换为扩展的名称。 +1. 从目录中，创建一个存储库以发布扩展。将 `EXTENSION-NAME` 替换为扩展的名称。 ```shell git init -b main @@ -113,15 +113,15 @@ ms.locfileid: '145066719' gh repo create gh-EXTENSION-NAME --source=. --public --push ``` -1. （可选）为了帮助其他用户发现你的扩展，请添加存储库主题 `gh-extension`。 这将使扩展显示在 [`gh-extension` 主题页](https://github.com/topics/gh-extension)上。 有关如何添加存储库主题的详细信息，请参阅“[使用主题对存储库进行分类](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)”。 +1. （可选）为了帮助其他用户发现你的扩展，请添加存储库主题 `gh-extension`。这将使扩展显示在 [`gh-extension` 主题页](https://github.com/topics/gh-extension)上。有关如何添加存储库主题的详细信息，请参阅“[使用主题对存储库进行分类](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)”。 ## 编写解译型 {% data variables.product.prodname_cli %} 扩展的提示 ### 处理参数和标志 -`gh my-extension-name` 命令之后的所有命令行参数都将传递给扩展脚本。 在 bash 脚本中，可以引用 `$1`、`$2` 等参数。可以使用参数来接受用户输入或修改脚本的行为。 +`gh my-extension-name` 命令之后的所有命令行参数都将传递给扩展脚本。在 bash 脚本中，可以引用 `$1`、`$2` 等参数。可以使用参数来接受用户输入或修改脚本的行为。 -例如，此脚本处理多个标志。 使用 `-h` 或 `--help` 标志调用脚本时，脚本将打印帮助文本，而不是继续执行。 使用 `--name` 标志调用脚本时，脚本会将标志后的下一个值设置为 `name_arg`。 使用 `--verbose` 标志调用脚本时，脚本将打印不同的问候语。 +例如，此脚本处理多个标志。使用 `-h` 或 `--help` 标志调用脚本时，脚本将打印帮助文本，而不是继续执行。使用 `--name` 标志调用脚本时，脚本会将标志后的下一个值设置为 `name_arg`。使用 `--verbose` 标志调用脚本时，脚本将打印不同的问候语。 ```bash #!/usr/bin/env bash @@ -159,7 +159,7 @@ fi ### 在非交互模式下调用核心命令 -某些 {% data variables.product.prodname_cli %} 核心命令将提示用户输入。 使用这些命令编写脚本时，通常需要提示。 为避免提示，请通过参数显式提供必要的信息。 +某些 {% data variables.product.prodname_cli %} 核心命令将提示用户输入。使用这些命令编写脚本时，通常需要提示。为避免提示，请通过参数显式提供必要的信息。 例如，要以编程方式创建问题，请指定标题和正文： @@ -169,19 +169,19 @@ gh issue create --title "My Title" --body "Issue description" ### 以编程方式获取数据 -许多核心命令支持 `--json` 标志，用于以编程方式提取数据。 例如，要返回其中列出拉取请求数量、标题和可合并性状态的 JSON 对象： +许多核心命令支持 `--json` 标志，用于以编程方式提取数据。例如，要返回其中列出拉取请求数量、标题和可合并性状态的 JSON 对象： ```shell gh pr list --json number,title,mergeStateStatus ``` -如果没有从 GitHub 提取特定数据的核心命令，则可以使用 [`gh api`](https://cli.github.com/manual/gh_api) 命令来访问 GitHub API。 例如，要获取有关当前用户的信息， +如果没有从 GitHub 提取特定数据的核心命令，则可以使用 [`gh api`](https://cli.github.com/manual/gh_api) 命令来访问 GitHub API。例如，要获取有关当前用户的信息， ```shell gh api user ``` -所有输出 JSON 数据的命令还具有将该数据筛选为脚本可以立即使用的数据的选项。 例如，要获取当前用户的名称： +所有输出 JSON 数据的命令还具有将该数据筛选为脚本可以立即使用的数据的选项。例如，要获取当前用户的名称： ```shell gh api user --jq '.name' @@ -191,9 +191,9 @@ gh api user --jq '.name' ## 手动创建预编译的扩展 -1. 为扩展创建一个名为 `gh-EXTENSION-NAME` 的本地目录。 将 `EXTENSION-NAME` 替换为扩展的名称。 例如 `gh-whoami`。 +1. 为扩展创建一个名为 `gh-EXTENSION-NAME` 的本地目录。将 `EXTENSION-NAME` 替换为扩展的名称。例如 `gh-whoami`。 -1. 在您创建的目录中，添加一些源代码。 例如： +1. 在您创建的目录中，添加一些源代码。例如： ```go package main @@ -219,7 +219,7 @@ gh api user --jq '.name' gh extension install . ``` -1. 生成代码。 例如，使用 Go，将 `YOUR-USERNAME` 替换为你的 GitHub 用户名： +1. 生成代码。例如，使用 Go，将 `YOUR-USERNAME` 替换为你的 GitHub 用户名： ```shell go mod init github.com/YOUR-USERNAME/gh-whoami @@ -227,13 +227,13 @@ gh api user --jq '.name' go build ``` -1. 验证您的扩展是否正常工作。 将 `EXTENSION-NAME` 替换为扩展的名称。 例如 `whoami`。 +1. 验证您的扩展是否正常工作。将 `EXTENSION-NAME` 替换为扩展的名称。例如 `whoami`。 ```shell gh EXTENSION-NAME ``` -1. 从目录中，创建一个存储库以发布扩展。 将 `EXTENSION-NAME` 替换为扩展的名称。 +1. 从目录中，创建一个存储库以发布扩展。将 `EXTENSION-NAME` 替换为扩展的名称。 {% note %} @@ -248,17 +248,17 @@ gh api user --jq '.name' gh repo create "gh-EXTENSION-NAME" ``` -1. 创建版本以与他人共享预编译的扩展。 针对要支持的每个平台进行编译，将每个二进制文件作为资产附加到发行版。 附加到发行版的二进制可执行文件必须遵循命名约定，并且具有 OS-ARCHITECTURE\[EXTENSION\] 的后缀。 +1. 创建版本以与他人共享预编译的扩展。针对要支持的每个平台进行编译，将每个二进制文件作为资产附加到发行版。附加到发行版的二进制可执行文件必须遵循命名约定，并且具有 OS-ARCHITECTURE\[EXTENSION\] 的后缀。 - 例如，为 Windows 64 位编译的名为 `whoami` 的扩展将具有名称 `gh-whoami-windows-amd64.exe`，而为 Linux 32 位编译的同一扩展将具有名称 `gh-whoami-linux-386`。 若要查看 `gh` 识别的 OS 和体系结构组合的详尽列表，请参阅[此源代码](https://github.com/cli/cli/blob/14f704fd0da58cc01413ee4ba16f13f27e33d15e/pkg/cmd/extension/manager.go#L696)。 + 例如，为 Windows 64 位编译的名为 `whoami` 的扩展将具有名称 `gh-whoami-windows-amd64.exe`，而为 Linux 32 位编译的同一扩展将具有名称 `gh-whoami-linux-386`。若要查看 `gh` 识别的 OS 和体系结构组合的详尽列表，请参阅[此源代码](https://github.com/cli/cli/blob/14f704fd0da58cc01413ee4ba16f13f27e33d15e/pkg/cmd/extension/manager.go#L696)。 {% note %} - **注意：** 要使扩展在 Windows 上正常运行，其资产文件必须具有 `.exe` 扩展名。 其他操作系统不需要扩展。 + **注意：** 要使扩展在 Windows 上正常运行，其资产文件必须具有 `.exe` 扩展名。其他操作系统不需要扩展。 {% endnote %} - 可以从命令行创建版本。 例如： + 可以从命令行创建版本。例如： ```shell git tag v1.0.0 diff --git a/translations/zh-CN/content/github-cli/github-cli/github-cli-reference.md b/translations/zh-CN/content/github-cli/github-cli/github-cli-reference.md index 68306af15d0c..8ea3946219d4 100644 --- a/translations/zh-CN/content/github-cli/github-cli/github-cli-reference.md +++ b/translations/zh-CN/content/github-cli/github-cli/github-cli-reference.md @@ -22,7 +22,7 @@ ms.locfileid: '145066718' gh ``` -要列出特定组下的所有命令，请使用不带参数的顶层命令。 例如，列出 [用于管理存储库的命令](https://cli.github.com/manual/gh_repo)： +要列出特定组下的所有命令，请使用不带参数的顶层命令。例如，列出 [用于管理存储库的命令](https://cli.github.com/manual/gh_repo)： ```shell gh repo diff --git a/translations/zh-CN/content/github-cli/github-cli/quickstart.md b/translations/zh-CN/content/github-cli/github-cli/quickstart.md index 254819be9192..d2aa69f19298 100644 --- a/translations/zh-CN/content/github-cli/github-cli/quickstart.md +++ b/translations/zh-CN/content/github-cli/github-cli/quickstart.md @@ -38,14 +38,14 @@ ms.locfileid: '145066714' ``` {% endif %} -1. 开始在命令行中使用 {% data variables.product.company_short %}。 例如，使用 `gh issue status` 或 `gh issue list --assignee @me` 查找要处理的问题。 使用 `gh pr create` 创建拉取请求。 使用 `gh pr checkout`、`gh pr diff` 和 `gh pr review` 查看拉取请求。 +1. 开始在命令行中使用 {% data variables.product.company_short %}。例如，使用 `gh issue status` 或 `gh issue list --assignee @me` 查找要处理的问题。使用 `gh pr create` 创建拉取请求。使用 `gh pr checkout`、`gh pr diff` 和 `gh pr review` 查看拉取请求。 ## 后续步骤 -- 告诉 {% data variables.product.prodname_cli %} 哪个文本编辑器用于打开文本编辑器的命令。 例如，输入 `gh config set editor "code -w"` 将首选文本编辑器设置为 {% data variables.product.prodname_vscode %}。 有关详细信息，请参阅 [`gh config set`](https://cli.github.com/manual/gh_config_set)。 +- 告诉 {% data variables.product.prodname_cli %} 哪个文本编辑器用于打开文本编辑器的命令。例如，输入 `gh config set editor "code -w"` 将首选文本编辑器设置为 {% data variables.product.prodname_vscode %}。有关详细信息，请参阅 [`gh config set`](https://cli.github.com/manual/gh_config_set)。 -- 为通常运行的命令定义别名。 例如，如果运行 `gh alias set prd "pr create --draft"`，则你可以运行 `gh prd` 以快速打开草稿拉取请求。 有关详细信息，请参阅 [`gh alias`](https://cli.github.com/manual/gh_alias)。 +- 为通常运行的命令定义别名。例如，如果运行 `gh alias set prd "pr create --draft"`，则你可以运行 `gh prd` 以快速打开草稿拉取请求。有关详细信息，请参阅 [`gh alias`](https://cli.github.com/manual/gh_alias)。 -- 使用 {% data variables.product.prodname_cli %} 扩展创建或添加自定义命令。 有关详细信息，请参阅“[使用 {% data variables.product.prodname_cli %} 扩展](/github-cli/github-cli/using-github-cli-extensions)”和“[创建 {% data variables.product.prodname_cli %} 扩展](/github-cli/github-cli/creating-github-cli-extensions)”。 +- 使用 {% data variables.product.prodname_cli %} 扩展创建或添加自定义命令。有关详细信息，请参阅“[使用 {% data variables.product.prodname_cli %} 扩展](/github-cli/github-cli/using-github-cli-extensions)”和“[创建 {% data variables.product.prodname_cli %} 扩展](/github-cli/github-cli/creating-github-cli-extensions)”。 - 有关可以使用 {% data variables.product.prodname_cli %} 运行的所有命令的详细信息，请参阅“[{% data variables.product.prodname_cli %} 参考](/github-cli/github-cli/github-cli-reference)”。 diff --git a/translations/zh-CN/content/github-cli/github-cli/using-github-cli-extensions.md b/translations/zh-CN/content/github-cli/github-cli/using-github-cli-extensions.md index f6f05266475c..fdbb7fb27476 100644 --- a/translations/zh-CN/content/github-cli/github-cli/using-github-cli-extensions.md +++ b/translations/zh-CN/content/github-cli/github-cli/using-github-cli-extensions.md @@ -19,13 +19,13 @@ ms.locfileid: '145066710' {% note %} -注意：{% data variables.product.product_name %} 和 {% data variables.product.prodname_cli %} 以外的扩展未经 {% data variables.product.product_name %} 认证，并受单独的服务条款、隐私策略和支持文档的约束。 要在使用第三方扩展时降低风险，请在安装或更新扩展之前审核扩展的源代码。 +注意：{% data variables.product.product_name %} 和 {% data variables.product.prodname_cli %} 以外的扩展未经 {% data variables.product.product_name %} 认证，并受单独的服务条款、隐私策略和支持文档的约束。要在使用第三方扩展时降低风险，请在安装或更新扩展之前审核扩展的源代码。 {% endnote %} {% data reusables.cli.cli-extensions %} 有关如何创建 {% data variables.product.prodname_cli %} 扩展的详细信息，请参阅“[创建 {% data variables.product.prodname_cli %} 扩展](/github-cli/github-cli/creating-github-cli-extensions)”。 -扩展在本地安装，范围限定为用户。 因此，如果您从另一台计算机访问 {% data variables.product.prodname_cli %} ，或者其他用户从同一台计算机访问 {% data variables.product.prodname_cli %} ，则该扩展将不可用。 +扩展在本地安装，范围限定为用户。因此，如果您从另一台计算机访问 {% data variables.product.prodname_cli %} ，或者其他用户从同一台计算机访问 {% data variables.product.prodname_cli %} ，则该扩展将不可用。 ## 查找扩展 @@ -33,9 +33,9 @@ ms.locfileid: '145066710' ## 安装扩展 -若要安装扩展，请使用 `extensions install` 子命令。 将 `repo` 参数替换为扩展的存储库。 可以使用完整的 URL，例如 `https://github.com/octocat/gh-whoami`，也可以仅使用所有者和存储库，例如 `octocat/gh-whoami`。 +若要安装扩展，请使用 `extensions install` 子命令。将 `repo` 参数替换为扩展的存储库。可以使用完整的 URL，例如 `https://github.com/octocat/gh-whoami`，也可以仅使用所有者和存储库，例如 `octocat/gh-whoami`。 -如果使用所有者和存储库，`gh` 将使用当前经过身份验证的 `gh` 主机名安装扩展。 从其他主机安装扩展时，完整的 URL 格式非常有用。 例如， {% data variables.product.prodname_ghe_server %} 上的用户应使用完整存储库 URL 从 {% data variables.product.prodname_dotcom_the_website %} 或任何其他主机安装扩展。 +如果使用所有者和存储库，`gh` 将使用当前经过身份验证的 `gh` 主机名安装扩展。从其他主机安装扩展时，完整的 URL 格式非常有用。例如， {% data variables.product.prodname_ghe_server %} 上的用户应使用完整存储库 URL 从 {% data variables.product.prodname_dotcom_the_website %} 或任何其他主机安装扩展。 若要从当前目录安装开发中的扩展，使用 `.` 作为 `repo` 参数的值。 @@ -43,11 +43,11 @@ ms.locfileid: '145066710' gh extension install repo ``` -如果已安装同名的扩展，则该命令将失败。 例如，如果已安装 `octocat/gh-whoami`，则必须在安装 `hubot/gh-whoami` 之前卸载它。 +如果已安装同名的扩展，则该命令将失败。例如，如果已安装 `octocat/gh-whoami`，则必须在安装 `hubot/gh-whoami` 之前卸载它。 ## 查看已安装的扩展 -若要查看已安装的所有扩展，请使用 `extensions list` 子命令。 输出还将告诉您哪些扩展具有可用的更新。 +若要查看已安装的所有扩展，请使用 `extensions list` 子命令。输出还将告诉您哪些扩展具有可用的更新。 ```shell gh extension list @@ -55,7 +55,7 @@ gh extension list ## 更新扩展 -若要更新扩展，请使用 `extensions upgrade` 子命令。 将 `extension` 参数替换为扩展的名称。 +若要更新扩展，请使用 `extensions upgrade` 子命令。将 `extension` 参数替换为扩展的名称。 ```shell gh extension upgrade extension @@ -69,7 +69,7 @@ gh extension upgrade --all ## 卸载扩展 -若要卸载扩展，请使用 `extensions remove` 子命令。 将 `extension` 参数替换为扩展的名称。 +若要卸载扩展，请使用 `extensions remove` 子命令。将 `extension` 参数替换为扩展的名称。 ```shell gh extension remove extension diff --git a/translations/zh-CN/content/graphql/README.md b/translations/zh-CN/content/graphql/README.md index 78f5b58c3798..a63399040c87 100644 --- a/translations/zh-CN/content/graphql/README.md +++ b/translations/zh-CN/content/graphql/README.md @@ -11,8 +11,8 @@ ms.locfileid: "145066678" `/content/graphql` 目录是 GitHub GraphQL API 文档所在的位置！ * `/content/graphql/guides` 和 `/content/graphql/overview` 目录包含可人工编辑的文章。 -* `/content/graphql/reference` 目录包含 GitHub GraphQL API 中使用的每个 GraphQL 数据类型的文章。 此目录中的大部分内容都使用 `include` 标记呈现。 +* `/content/graphql/reference` 目录包含 GitHub GraphQL API 中使用的每个 GraphQL 数据类型的文章。此目录中的大部分内容都使用 `include` 标记呈现。 - `include` 标记呈现的内容来自 `/lib/graphql/static` 目录，由 GitHub 内部的 API 源代码自动生成，不应人工编辑。 有关详细信息，请参阅 [`/lib/graphql/README.md`](/lib/graphql/README.md)。 + `include` 标记呈现的内容来自 `/lib/graphql/static` 目录，由 GitHub 内部的 API 源代码自动生成，不应人工编辑。有关详细信息，请参阅 [`/lib/graphql/README.md`](/lib/graphql/README.md)。 因此，我们无法接受对此存储库中 GraphQL API 参考内容的贡献。 diff --git a/translations/zh-CN/content/graphql/guides/forming-calls-with-graphql.md b/translations/zh-CN/content/graphql/guides/forming-calls-with-graphql.md index 18aeeeb68a84..d225dc66c30e 100644 --- a/translations/zh-CN/content/graphql/guides/forming-calls-with-graphql.md +++ b/translations/zh-CN/content/graphql/guides/forming-calls-with-graphql.md @@ -23,7 +23,7 @@ ms.locfileid: '147527892' 要与 GraphQL 服务器通信，需要具有正确作用域的 OAuth 令牌。 -按照“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”中的步骤创建令牌。 您需要的作用域取决于您尝试请求的数据类型。 例如，选择“用户”范围以请求用户数据。 如果需要访问存储库信息，请选择相应的“存储库”范围。 +按照“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”中的步骤创建令牌。您需要的作用域取决于您尝试请求的数据类型。例如，选择“用户”范围以请求用户数据。如果需要访问存储库信息，请选择相应的“存储库”范围。 {% ifversion fpt or ghec %} @@ -60,11 +60,11 @@ REST API 有多个端点；GraphQL API 只有一个端点： ## 与 GraphQL 通信 -由于 GraphQL 操作由多行 JSON 组成，因此 GitHub 建议使用[浏览器](/graphql/guides/using-the-explorer)进行 GraphQL 调用。 也可以使用 cURL 或任何其他采用 HTTP 的库。 +由于 GraphQL 操作由多行 JSON 组成，因此 GitHub 建议使用[浏览器](/graphql/guides/using-the-explorer)进行 GraphQL 调用。也可以使用 cURL 或任何其他采用 HTTP 的库。 -在 REST 中，[HTTP 谓词](/rest#http-verbs)确定执行的操作。 在 GraphQL 中，无论是执行查询还是突变，都要提供 JSON 编码的正文，因此 HTTP 谓词为 `POST`。 唯一的例外是[内省查询](/graphql/guides/introduction-to-graphql#discovering-the-graphql-api)，它是一种简单的 `GET` 到终结点查询。 有关 GraphQL 与 REST 的更多信息，请参阅“[从 REST 迁移到 GraphQL](/graphql/guides/migrating-from-rest-to-graphql)”。 +在 REST 中，[HTTP 谓词](/rest#http-verbs)确定执行的操作。在 GraphQL 中，无论是执行查询还是突变，都要提供 JSON 编码的正文，因此 HTTP 谓词为 `POST`。唯一的例外是[内省查询](/graphql/guides/introduction-to-graphql#discovering-the-graphql-api)，它是一种简单的 `GET` 到终结点查询。有关 GraphQL 与 REST 的更多信息，请参阅“[从 REST 迁移到 GraphQL](/graphql/guides/migrating-from-rest-to-graphql)”。 -要使用 cURL 查询 GraphQL，请利用 JSON 有效负载发出 `POST` 请求。 有效负载必须包含一个名为 `query` 的字符串： +要使用 cURL 查询 GraphQL，请利用 JSON 有效负载发出 `POST` 请求。有效负载必须包含一个名为 `query` 的字符串： ```shell curl -H "Authorization: bearer token" -X POST -d " \ @@ -76,13 +76,13 @@ curl -H "Authorization: bearer token" -X POST -d " \ {% tip %} -注意：`"query"` 的字符串值必须进行换行符转义，否则架构将无法正确解析它。 对于 `POST` 正文，请使用外双引号和转义的内双引号。 +注意：`"query"` 的字符串值必须进行换行符转义，否则架构将无法正确解析它。对于 `POST` 正文，请使用外双引号和转义的内双引号。 {% endtip %} ### 关于查询和突变操作 -GitHub 的 GraphQL API 中允许的两种操作类型为查询和突变 。 比较 GraphQL 与 REST，查询操作就像 `GET` 请求，而突变操作则像 `POST`/`PATCH`/`DELETE`。 [突变名称](/graphql/reference/mutations)确定执行的修改内容。 +GitHub 的 GraphQL API 中允许的两种操作类型为查询和突变。比较 GraphQL 与 REST，查询操作就像 `GET` 请求，而突变操作则像 `POST`/`PATCH`/`DELETE`。 [突变名称](/graphql/reference/mutations)确定执行的修改内容。 有关速率限制的信息，请参阅“[GraphQL 资源限制](/graphql/overview/resource-limitations)”。 @@ -90,7 +90,7 @@ GitHub 的 GraphQL API 中允许的两种操作类型为查询和突变 。 比 ### 关于查询 -GraphQL 查询仅返回你指定的数据。 要建立查询，必须指定[字段内的字段](/graphql/guides/introduction-to-graphql#field)（也称为嵌套的子字段），直到仅返回[标量](/graphql/reference/scalars)。 +GraphQL 查询仅返回你指定的数据。要建立查询，必须指定[字段内的字段](/graphql/guides/introduction-to-graphql#field)（也称为嵌套的子字段），直到仅返回[标量](/graphql/reference/scalars)。 查询的结构如下： @@ -104,9 +104,9 @@ GraphQL 查询仅返回你指定的数据。 要建立查询，必须指定[字 要建立突变，必须指定三个参数： -1. 突变名称。 您要执行的修改类型。 -2. 输入对象。 要发送到服务器的数据，由输入字段组成。 将其作为参数传递至突变名称。 -3. 有效负载对象。 要从服务器返回的数据，由返回字段组成。 将其作为突变名称的正文传递。 +1. 突变名称。您要执行的修改类型。 +2. 输入对象。要发送到服务器的数据，由输入字段组成。将其作为参数传递至突变名称。 +3. 有效负载对象。要从服务器返回的数据，由返回字段组成。将其作为突变名称的正文传递。 突变的结构如下： @@ -118,7 +118,7 @@ GraphQL 查询仅返回你指定的数据。 要建立查询，必须指定[字 此示例中的输入对象为 `MutationNameInput`，有效负载对象为 `MutationNamePayload`。 -在[突变](/graphql/reference/mutations)引用中，列出的输入字段是作为输入对象传递的内容。 列出的返回字段是作为有效负载对象传递的内容。 +在[突变](/graphql/reference/mutations)引用中，列出的输入字段是作为输入对象传递的内容。列出的返回字段是作为有效负载对象传递的内容。 有关实际示例，请参阅“[示例突变](#example-mutation)”。 @@ -160,7 +160,7 @@ variables { } ``` - 此对象必须是有效的 JSON。 本示例显示了一个简单的 `Int` 变量类型，但可以定义更复杂的变量类型，如输入对象。 也可以在此定义多个变量。 + 此对象必须是有效的 JSON。本示例显示了一个简单的 `Int` 变量类型，但可以定义更复杂的变量类型，如输入对象。也可以在此定义多个变量。 2. 将变量作为参数传递至操作： @@ -168,7 +168,7 @@ variables { query($number_of_repos:Int!){ ``` - 此参数是一个键值对，其中键为以 `$` 开头的名称（例如 `$number_of_repos`），值为类型（例如 `Int`） 。 添加 `!` 以指出是否需要此类型。 如果您已经定义了多个变量，请将它们作为多个参数加入此处。 + 此参数是一个键值对，其中键为以 `$` 开头的名称（例如 `$number_of_repos`），值为类型（例如 `Int`） 。添加 `!` 以指出是否需要此类型。如果您已经定义了多个变量，请将它们作为多个参数加入此处。 3. 在操作中使用变量： @@ -176,9 +176,9 @@ variables { repositories(last: $number_of_repos) { ``` - 在本示例中，我们用变量替换要检索的仓库编号。 在步骤 2 中指定类型，因为 GraphQL 会强制执行强类型化。 + 在本示例中，我们用变量替换要检索的仓库编号。在步骤 2 中指定类型，因为 GraphQL 会强制执行强类型化。 -此流程会使查询参数具有动态性。 现在，只需更改 `variables` 对象中的值，查询的其余部分则保持不变。 +此流程会使查询参数具有动态性。现在，只需更改 `variables` 对象中的值，查询的其余部分则保持不变。 将变量用作参数可支持动态更新 `variables` 对象中的值，而无需更改查询。 @@ -218,7 +218,7 @@ query { * `repository(owner:"octocat", name:"Hello-World") {` - 要开始查询，需找到 [`repository`](/graphql/reference/objects#repository) 对象。 架构验证表明此对象需要 `owner` 和 `name` 参数。 + 要开始查询，需找到 [`repository`](/graphql/reference/objects#repository) 对象。架构验证表明此对象需要 `owner` 和 `name` 参数。 * `issues(last:20, states:CLOSED) {` @@ -228,11 +228,11 @@ query { - [文档](/graphql/reference/objects#repository)中指出，此对象的类型为 `IssueConnection`。 - 架构验证表明此对象需要将 `last` 或 `first` 个结果作为参数，因此我们提供了 `20`。 - - [文档](/graphql/reference/objects#repository)也指出，此对象接受 `states` 参数，即一种 [`IssueState`](/graphql/reference/enums#issuestate) 枚举类型，可接受的值为 `OPEN` 或 `CLOSED`。 要仅查找已关闭的问题，可对 `states` 键赋值 `CLOSED`。 + - [文档](/graphql/reference/objects#repository)也指出，此对象接受 `states` 参数，即一种 [`IssueState`](/graphql/reference/enums#issuestate) 枚举类型，可接受的值为 `OPEN` 或 `CLOSED`。要仅查找已关闭的问题，可对 `states` 键赋值 `CLOSED`。 * `edges {` - 我们知道 `issues` 是一种连接，因为它的类型为 `IssueConnection`。 要检索关于各个问题的数据，必须通过 `edges` 访问节点。 + 我们知道 `issues` 是一种连接，因为它的类型为 `IssueConnection`。要检索关于各个问题的数据，必须通过 `edges` 访问节点。 * `node {` @@ -254,13 +254,13 @@ query { 在此指定 `Issue` 对象的 `title`、`url` 和 `labels` 字段。 - `labels` 字段的类型为 [`LabelConnection`](/graphql/reference/objects#labelconnection)。 与 `issues` 对象一样，`labels` 也是一种连接，因此必须将其边缘传送到连接的节点：`label` 对象。 在此节点上，可指定要返回的 `label` 对象字段，在本例中为 `name`。 + `labels` 字段的类型为 [`LabelConnection`](/graphql/reference/objects#labelconnection)。与 `issues` 对象一样，`labels` 也是一种连接，因此必须将其边缘传送到连接的节点：`label` 对象。在此节点上，可指定要返回的 `label` 对象字段，在本例中为 `name`。 -你可能会注意到，在 Octocat 的{% ifversion not ghae %}公共{% endif %} `Hello-World` 存储库中运行此查询不会返回很多标签。 尝试在您自己的其中一个使用标签的仓库中运行，很可能会看到不同的结果。 +你可能会注意到，在 Octocat 的{% ifversion not ghae %}公共{% endif %} `Hello-World` 存储库中运行此查询不会返回很多标签。尝试在您自己的其中一个使用标签的仓库中运行，很可能会看到不同的结果。 ## 突变示例 -突变通常需要只有先执行查询才能找到的信息。 本示例显示两个操作： +突变通常需要只有先执行查询才能找到的信息。本示例显示两个操作： 1. 用于获取议题 ID 的查询。 2. 用于向议题添加表情符号反应的突变。 @@ -288,15 +288,15 @@ mutation AddReactionToIssue { {% tip %} -如果为查询和突变命名（在本示例中为 `FindIssueID` 和 `AddReactionToIssue`），则可以将二者放入此浏览器的同一个窗口，但操作将作为对 GraphQL 终结点的单独调用执行。 不能同时执行查询和突变，反之亦然。 +如果为查询和突变命名（在本示例中为 `FindIssueID` 和 `AddReactionToIssue`），则可以将二者放入此浏览器的同一个窗口，但操作将作为对 GraphQL 终结点的单独调用执行。不能同时执行查询和突变，反之亦然。 {% endtip %} -我们演练一遍这个示例。 任务听起来简单：向议题添加表情符号反应即可。 +我们演练一遍这个示例。任务听起来简单：向议题添加表情符号反应即可。 -那么，我们怎么知道从查询开始呢？ 还不知道。 +那么，我们怎么知道从查询开始呢？还不知道。 -因为我们想修改服务器上的数据（向议题添加表情符号），所以先搜索架构，查找有用的突变。 参考文档所示为 [`addReaction`](/graphql/reference/mutations#addreaction) 突变，其描述为：`Adds a reaction to a subject.` Perfect! +因为我们想修改服务器上的数据（向议题添加表情符号），所以先搜索架构，查找有用的突变。参考文档所示为 [`addReaction`](/graphql/reference/mutations#addreaction) 突变，其描述为：`Adds a reaction to a subject.` Perfect! 突变文档列出了三个输入字段： @@ -304,9 +304,9 @@ mutation AddReactionToIssue { * `subjectId` (`ID!`) * `content` (`ReactionContent!`) -`!` 指示 `subjectId` 和 `content` 是必填字段。 必填字段 `content` 是有道理的：我们想添加反应，因此需要指定要使用哪个表情符号。 +`!` 指示 `subjectId` 和 `content` 是必填字段。必填字段 `content` 是有道理的：我们想添加反应，因此需要指定要使用哪个表情符号。 -但 `subjectId` 为什么是必填字段呢？ 这是因为，`subjectId` 是确定要对哪个存储库中的哪个问题做出反应的唯一方式 。 +但 `subjectId` 为什么是必填字段呢？这是因为，`subjectId` 是确定要对哪个存储库中的哪个问题做出反应的唯一方式。 因此，本示例要从查询开始：获取 `ID`。 @@ -314,7 +314,7 @@ mutation AddReactionToIssue { * `query FindIssueID {` - 我们将执行查询，并将其命名为 `FindIssueID`。 请注意，为查询命名是可选操作；我们在此为它命名，然后即可将它与突变放在同一个 Explorer 窗口中。 + 我们将执行查询，并将其命名为 `FindIssueID`。请注意，为查询命名是可选操作；我们在此为它命名，然后即可将它与突变放在同一个 Explorer 窗口中。 * `repository(owner:"octocat", name:"Hello-World") {` @@ -332,7 +332,7 @@ mutation AddReactionToIssue { {% tip %} -注意：查询中返回的 `id` 是将在突变中作为 `subjectID` 传递的值。 文档和架构内省都不会显示这种关系；您需要理解这些名称背后的概念才能找出答案。 +注意：查询中返回的 `id` 是将在突变中作为 `subjectID` 传递的值。文档和架构内省都不会显示这种关系；您需要理解这些名称背后的概念才能找出答案。 {% endtip %} @@ -340,21 +340,21 @@ mutation AddReactionToIssue { * `mutation AddReactionToIssue {` - 我们将执行突变，并将其命名为 `AddReactionToIssue`。 与查询一样，为突变命名是可选操作；我们在此为它命名，然后即可将它与查询放在同一个 Explorer 窗口中。 + 我们将执行突变，并将其命名为 `AddReactionToIssue`。与查询一样，为突变命名是可选操作；我们在此为它命名，然后即可将它与查询放在同一个 Explorer 窗口中。 * `addReaction(input:{subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}) {` 让我们来检查这一行： - `addReaction` 是突变的名称。 - - `input` 是必需的参数键。 突变的参数键始终是 `input`。 - - `{subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}` 是必需的参数值。 突变的参数值始终是由输入字段（在本例中为 `subjectId` 和 `content`）组成的[输入对象](/graphql/reference/input-objects)（因此带有大括号）。 + - `input` 是必需的参数键。突变的参数键始终是 `input`。 + - `{subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}` 是必需的参数值。突变的参数值始终是由输入字段（在本例中为 `subjectId` 和 `content`）组成的[输入对象](/graphql/reference/input-objects)（因此带有大括号）。 - 我们怎么知道内容使用哪个值呢？ [`addReaction` 文档](/graphql/reference/mutations#addreaction)指出，`content` 字段的类型为 [`ReactionContent`](/graphql/reference/enums#reactioncontent)，即一种[枚举类型](/graphql/reference/enums)，因为 GitHub 只支持使用某些表情符号进行反应。 这些是允许的反应值 （注意，某些值与其相应的表情符号名称不同）： + 我们怎么知道内容使用哪个值呢？ [`addReaction` 文档](/graphql/reference/mutations#addreaction)指出，`content` 字段的类型为 [`ReactionContent`](/graphql/reference/enums#reactioncontent)，即一种[枚举类型](/graphql/reference/enums)，因为 GitHub 只支持使用某些表情符号进行反应。这些是允许的反应值（注意，某些值与其相应的表情符号名称不同）： {% data reusables.repositories.reaction_list %} -* 调用的其余部分由有效负载对象组成。 我们将在此指定执行突变后由服务器返回的数据。 这几行来自 [`addReaction` 文档](/graphql/reference/mutations#addreaction)，其中包含三个可能返回的字段： +* 调用的其余部分由有效负载对象组成。我们将在此指定执行突变后由服务器返回的数据。这几行来自 [`addReaction` 文档](/graphql/reference/mutations#addreaction)，其中包含三个可能返回的字段： - `clientMutationId` (`String`) - `reaction` (`Reaction!`) @@ -379,9 +379,9 @@ mutation AddReactionToIssue { } ``` -就这么简单！ 将鼠标悬停在 :tada: 上找到你的用户名，查看[问题的反应](https://github.com/octocat/Hello-World/issues/349)。 +就这么简单！将鼠标悬停在 :tada: 上找到你的用户名，查看[问题的反应](https://github.com/octocat/Hello-World/issues/349)。 -最后注意：当您在输入对象中传递多个字段时，语法可能会变笨拙。 将字段移入[变量](#working-with-variables)可避免这种情况。 下面是您利用变量重写原始突变的方式： +最后注意：当您在输入对象中传递多个字段时，语法可能会变笨拙。将字段移入[变量](#working-with-variables)可避免这种情况。下面是您利用变量重写原始突变的方式： ```graphql mutation($myVar:AddReactionInput!) { @@ -404,9 +404,9 @@ variables { {% note %} -你可能会注意到，前文示例中的 `content` 字段值（直接用于突变）在 `HOORAY` 两侧没有引号，但在变量中使用时有引号。 原因是： -* 直接在突变中使用 `content` 时，架构预计此值的类型为 [`ReactionContent`](/graphql/reference/enums#reactioncontent)，即一种枚举类型，而非字符串。 如果您在枚举值两侧添加引号，架构验证将出现错误，因为引号是为字符串保留的。 -* 在变量中使用 `content` 时，变量部分必须为有效的 JSON，因此需要引号。 当变量在执行过程中传递至突变时，架构验证将正确解释 `ReactionContent` 类型。 +你可能会注意到，前文示例中的 `content` 字段值（直接用于突变）在 `HOORAY` 两侧没有引号，但在变量中使用时有引号。原因是： +* 直接在突变中使用 `content` 时，架构预计此值的类型为 [`ReactionContent`](/graphql/reference/enums#reactioncontent)，即一种枚举类型，而非字符串。如果您在枚举值两侧添加引号，架构验证将出现错误，因为引号是为字符串保留的。 +* 在变量中使用 `content` 时，变量部分必须为有效的 JSON，因此需要引号。当变量在执行过程中传递至突变时，架构验证将正确解释 `ReactionContent` 类型。 有关枚举与字符串之间差异的更多信息，请参阅[官方 GraphQL 规格](https://graphql.github.io/graphql-spec/June2018/#sec-Enums)。 @@ -414,7 +414,7 @@ variables { ## 延伸阅读 -建立 GraphQL 调用时，可执行更多操作。 下面是接下来要阅读的一些内容： +建立 GraphQL 调用时，可执行更多操作。下面是接下来要阅读的一些内容： * [分页](https://graphql.org/learn/pagination/) * [片段](https://graphql.org/learn/queries/#fragments) diff --git a/translations/zh-CN/content/graphql/guides/introduction-to-graphql.md b/translations/zh-CN/content/graphql/guides/introduction-to-graphql.md index 028b38a782dc..80bdf5b0e7ba 100644 --- a/translations/zh-CN/content/graphql/guides/introduction-to-graphql.md +++ b/translations/zh-CN/content/graphql/guides/introduction-to-graphql.md @@ -20,25 +20,25 @@ ms.locfileid: '145066670' --- ## GraphQL 术语 -GitHub GraphQL API 表示 GitHub REST API 发生的架构和概念转变。 你可能会在 GraphQL API [参考文档](/graphql)中遇到一些新术语。 +GitHub GraphQL API 表示 GitHub REST API 发生的架构和概念转变。你可能会在 GraphQL API [参考文档](/graphql)中遇到一些新术语。 ## 架构 -架构可定义 GraphQL API 的类型系统。 它将描述客户端可以访问的完整可能数据集（对象、字段、关系、一切）。 来自客户端的调用已针对架构进行[验证](https://graphql.github.io/learn/validation/)和[执行](https://graphql.github.io/learn/execution/)。 客户端可通过[省](#discovering-the-graphql-api)找到有关架构的信息。 架构位于 GraphQL API 服务器上。 有关详细信息，请参阅“[发现 GraphQL API](#discovering-the-graphql-api)”。 +架构可定义 GraphQL API 的类型系统。它将描述客户端可以访问的完整可能数据集（对象、字段、关系、一切）。来自客户端的调用已针对架构进行[验证](https://graphql.github.io/learn/validation/)和[执行](https://graphql.github.io/learn/execution/)。客户端可通过[省](#discovering-the-graphql-api)找到有关架构的信息。架构位于 GraphQL API 服务器上。有关详细信息，请参阅“[发现 GraphQL API](#discovering-the-graphql-api)”。 ## 字段 -字段是一种可从对象检索的数据单元。 正如[官方 GraphQL 文档](https://graphql.github.io/learn/schema/)所述：“GraphQL 查询语言主要关于选择对象的字段。”。 +字段是一种可从对象检索的数据单元。正如[官方 GraphQL 文档](https://graphql.github.io/learn/schema/)所述：“GraphQL 查询语言主要关于选择对象的字段。”。 [官方规范](https://graphql.github.io/graphql-spec/June2018/#sec-Language.Fields)还提到了字段： > 所有 GraphQL 操作都必须将其选项指定为可返回标量值的字段，以确保得到明确响应。 -这意味着，如果您尝试返回的字段不是标量，架构验证将出现错误。 必须添加嵌套子字段，直到所有字段都返回标量。 +这意味着，如果您尝试返回的字段不是标量，架构验证将出现错误。必须添加嵌套子字段，直到所有字段都返回标量。 ## 参数 -参数是指一组附加至特定字段的键值对。 某些字段需要参数。 [Mutation](/graphql/guides/forming-calls-with-graphql#about-mutations) 需要输入对象作为参数。 +参数是指一组附加至特定字段的键值对。某些字段需要参数。 [Mutation](/graphql/guides/forming-calls-with-graphql#about-mutations) 需要输入对象作为参数。 ## 实现 @@ -69,21 +69,21 @@ type Y implements X { ## 连接 -连接可用于查询作为同一个调用的一部分的相关对象。 通过连接，可以使用单个 GraphQL 调用，其中，必须对 REST API 使用多个调用。 有关详细信息，请参阅“[从 REST 迁移到 GraphQL](/graphql/guides/migrating-from-rest-to-graphql)”。 +连接可用于查询作为同一个调用的一部分的相关对象。通过连接，可以使用单个 GraphQL 调用，其中，必须对 REST API 使用多个调用。有关详细信息，请参阅“[从 REST 迁移到 GraphQL](/graphql/guides/migrating-from-rest-to-graphql)”。 -它有助于绘制图形：用线连接点。 点是节点，线是边缘。 连接可定义节点之间的关系。 +它有助于绘制图形：用线连接点。点是节点，线是边缘。连接可定义节点之间的关系。 ## 边缘 -边缘表示节点之间的连接。 查询连接时，可以遍历边缘获取节点。 每个 `edges` 字段都有一个 `node` 字段和 `cursor` 一个字段。 游标用于[分页](https://graphql.github.io/learn/pagination/)。 +边缘表示节点之间的连接。查询连接时，可以遍历边缘获取节点。每个 `edges` 字段都有一个 `node` 字段和 `cursor` 一个字段。游标用于[分页](https://graphql.github.io/learn/pagination/)。 ## 节点 -Node 是对象的通用术语。 您可以直接查找节点，或通过连接访问相关节点。 如果指定不返回[标量](/graphql/reference/scalars)的 `node`，则必须包含子字段，直到所有字段都返回标量。 有关通过 REST API 访问节点 ID 并在 GraphQL 查询中使用它们的信息，请参阅“[使用全局节点 ID](/graphql/guides/using-global-node-ids)”。 +Node 是对象的通用术语。您可以直接查找节点，或通过连接访问相关节点。如果指定不返回[标量](/graphql/reference/scalars)的 `node`，则必须包含子字段，直到所有字段都返回标量。有关通过 REST API 访问节点 ID 并在 GraphQL 查询中使用它们的信息，请参阅“[使用全局节点 ID](/graphql/guides/using-global-node-ids)”。 ## 了解 GraphQL API -GraphQL 是[内省的](https://graphql.github.io/learn/introspection/)。 这意味着，您可以查询 GraphQL 架构，了解关于其自身的详细信息。 +GraphQL 是[内省的](https://graphql.github.io/learn/introspection/)。这意味着，您可以查询 GraphQL 架构，了解关于其自身的详细信息。 * 查询 `__schema` 以列出架构中定义的所有类型并获取关于每个类型的详细信息： @@ -125,11 +125,11 @@ GraphQL 是[内省的](https://graphql.github.io/learn/introspection/)。 这意 {% note %} - 注意：如果收到响应 `"message": "Bad credentials"` 或 `401 Unauthorized`，请检查你所使用的令牌是否有效。 有关详细信息，请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 + 注意：如果收到响应 `"message": "Bad credentials"` 或 `401 Unauthorized`，请检查你所使用的令牌是否有效。有关详细信息，请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 {% endnote %} - 结果出现在 JSON 中，因此，我们建议整洁打印，以便阅读和搜索。 为此，可使用 [jq](https://stedolan.github.io/jq/) 等命令行工具或将结果通过管道传输到 `python -m json.tool`。 + 结果出现在 JSON 中，因此，我们建议整洁打印，以便阅读和搜索。为此，可使用 [jq](https://stedolan.github.io/jq/) 等命令行工具或将结果通过管道传输到 `python -m json.tool`。 或者，也可以传递 `idl` 媒体类型，以返回 IDL 格式的结果，这是架构的压缩版本： @@ -140,7 +140,7 @@ GraphQL 是[内省的](https://graphql.github.io/learn/introspection/)。 这意 {% note %} - 注意：自省查询可能是将在 GraphQL 中运行的唯一 `GET` 请求。 如果要传递正文，则无论是查询还是突变，GraphQL 请求方法都为 `POST`。 + 注意：自省查询可能是将在 GraphQL 中运行的唯一 `GET` 请求。如果要传递正文，则无论是查询还是突变，GraphQL 请求方法都为 `POST`。 {% endnote %} diff --git a/translations/zh-CN/content/graphql/guides/managing-enterprise-accounts.md b/translations/zh-CN/content/graphql/guides/managing-enterprise-accounts.md index 306156d08b26..65658223e1f7 100644 --- a/translations/zh-CN/content/graphql/guides/managing-enterprise-accounts.md +++ b/translations/zh-CN/content/graphql/guides/managing-enterprise-accounts.md @@ -23,7 +23,7 @@ ms.locfileid: '145066666' 企业帐户端点适用于 GitHub Enterprise Cloud 和 GitHub Enterprise Server。 -使用 GraphQL 可以请求并仅返回指定的数据。 例如，可以创建 GraphQL 查询或请求信息，以查看添加到组织的所有新组织成员。 或者，可以做出更改，以邀请管理员加入企业帐户。 +使用 GraphQL 可以请求并仅返回指定的数据。例如，可以创建 GraphQL 查询或请求信息，以查看添加到组织的所有新组织成员。或者，可以做出更改，以邀请管理员加入企业帐户。 使用审核日志 API，可以监视下列行为： - 访问组织或存储库设置。 @@ -32,7 +32,7 @@ ms.locfileid: '145066666' - 将用户提升为管理员。 - 更改 GitHub 应用权限。 -使用审核日志 API 可以保留审核日志数据的副本。 对于使用审核日志 API 执行的查询，GraphQL 响应最多可包含 90 至 120 天的数据。 有关审核日志 API 提供的字段列表，请参阅“[AuditEntry 接口](/graphql/reference/interfaces#auditentry/)”。 +使用审核日志 API 可以保留审核日志数据的副本。对于使用审核日志 API 执行的查询，GraphQL 响应最多可包含 90 至 120 天的数据。有关审核日志 API 提供的字段列表，请参阅“[AuditEntry 接口](/graphql/reference/interfaces#auditentry/)”。 通过企业帐户 API，可以： - 列出并审查属于企业帐户的所有组织和仓库。 @@ -54,9 +54,9 @@ ms.locfileid: '145066666' ### 1. 使用个人访问令牌进行身份验证 -1. 要使用 GraphQL 进行身份验证，需要通过开发者设置生成个人访问令牌 (PAT)。 有关详细信息，请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 +1. 要使用 GraphQL 进行身份验证，需要通过开发者设置生成个人访问令牌 (PAT)。有关详细信息，请参阅“[创建个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token)”。 -2. 向要访问的 GHES 区域的个人访问令牌授予管理员和完全控制权限。 要获得对私有仓库、组织、团队、用户数据及企业帐单和个人资料数据访问的完全权限，建议您为个人访问令牌选择以下作用域： +2. 向要访问的 GHES 区域的个人访问令牌授予管理员和完全控制权限。要获得对私有仓库、组织、团队、用户数据及企业帐单和个人资料数据访问的完全权限，建议您为个人访问令牌选择以下作用域： - `repo` - `admin:org` - `user` @@ -83,11 +83,11 @@ ms.locfileid: '145066666' ### 3. 设置 Insomnia，将 GitHub GraphQL API 用于企业帐户 -1. 将基 url 和 `POST` 方法添加至 GraphQL 客户端。 使用 GraphQL 请求信息（查询）、更改信息（突变）或使用 GitHub API 传输数据时，默认 HTTP 方法为 `POST`，基 url 遵循此语法： +1. 将基 url 和 `POST` 方法添加至 GraphQL 客户端。使用 GraphQL 请求信息（查询）、更改信息（突变）或使用 GitHub API 传输数据时，默认 HTTP 方法为 `POST`，基 url 遵循此语法： - 对于企业实例：`https:///api/graphql` - 对于 GitHub Enterprise 云：`https://api.github.com/graphql` -2. 要进行身份验证，请打开身份验证选项菜单，并选择“持有者令牌”。 接下来，添加您之前复制的个人访问令牌。 +2. 要进行身份验证，请打开身份验证选项菜单，并选择“持有者令牌”。接下来，添加您之前复制的个人访问令牌。 ![个人访问令牌的权限选项](/assets/images/developer/graphql/insomnia-base-url-and-pat.png) @@ -102,7 +102,7 @@ ms.locfileid: '145066666' ## 使用企业账户 API 的查询示例 -此 GraphQL 查询使用 Enterprise Accounts API 请求每个设备的组织中 {% ifversion not ghae %}`public`{% else %}`private`{% endif %} 存储库的总数。 要自定义此查询，请用企业帐户的句柄替换 ``。 例如，如果企业帐户位于 `https://github.com/enterprises/octo-enterprise`，请用 `octo-enterprise` 替换 ``。 +此 GraphQL 查询使用 Enterprise Accounts API 请求每个设备的组织中 {% ifversion not ghae %}`public`{% else %}`private`{% endif %} 存储库的总数。要自定义此查询，请用企业帐户的句柄替换 ``。例如，如果企业帐户位于 `https://github.com/enterprises/octo-enterprise`，请用 `octo-enterprise` 替换 ``。 {% ifversion not ghae %} @@ -169,7 +169,7 @@ variables { ``` {% endif %} -下一个 GraphQL 查询示例显示了在不使用企业帐户 API 的情况下检索每个组织中的 {% ifversion not ghae %}`public`{% else %}`private`{% endif %} 存储库总数的难度。 请注意，GraphQL 企业账户 API 已使企业执行此任务变得更简单，因为您只需要自定义单个变量。 要自定义此查询，请将 `` 和 `` 等项替换为实例中的组织名称。 +下一个 GraphQL 查询示例显示了在不使用企业帐户 API 的情况下检索每个组织中的 {% ifversion not ghae %}`public`{% else %}`private`{% endif %} 存储库总数的难度。请注意，GraphQL 企业账户 API 已使企业执行此任务变得更简单，因为您只需要自定义单个变量。要自定义此查询，请将 `` 和 `` 等项替换为实例中的组织名称。 {% ifversion not ghae %} ```graphql @@ -265,7 +265,7 @@ fragment repositories on Organization { {% endif %} -此 GraphQL 查询用于请求企业组织的最后 5 个日志条目。 要自定义此查询，请替换 `` 和 ``。 +此 GraphQL 查询用于请求企业组织的最后 5 个日志条目。要自定义此查询，请替换 `` 和 ``。 ```graphql { @@ -299,5 +299,5 @@ fragment repositories on Organization { 有关可与企业帐户 API 结合使用的新查询、突变和架构定义类型的详细信息，请参阅任何 [GraphQL 参考页面](/graphql)含有详细 GraphQL 定义的边栏。 -您可以从 GitHub 的 GraphQL explorer 访问参考文档。 有关详细信息，请参阅“[使用资源管理器](/graphql/guides/using-the-explorer#accessing-the-sidebar-docs)”。 +您可以从 GitHub 的 GraphQL explorer 访问参考文档。有关详细信息，请参阅“[使用资源管理器](/graphql/guides/using-the-explorer#accessing-the-sidebar-docs)”。 有关其他信息，如身份验证和速率限制详细信息，请查看[指南](/graphql/guides)。 diff --git a/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md b/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md index f6694813d00e..829c8ee27c53 100644 --- a/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -16,22 +16,22 @@ ms.locfileid: '147717851' --- ## 背景 -{% data variables.product.product_name %} GraphQL API 目前支持两种类型的全局节点 ID 格式。 旧格式将被弃用，并替换为新格式。 本指南介绍如何在必要时迁移到新格式。 +{% data variables.product.product_name %} GraphQL API 目前支持两种类型的全局节点 ID 格式。旧格式将被弃用，并替换为新格式。本指南介绍如何在必要时迁移到新格式。 -通过迁移到新格式，可以确保请求的响应时间保持一致且较短。 您还可以确保在完全弃用旧 ID 后，应用程序继续工作。 +通过迁移到新格式，可以确保请求的响应时间保持一致且较短。您还可以确保在完全弃用旧 ID 后，应用程序继续工作。 若要详细了解为何将弃用旧版全局节点 ID 格式，请参阅“[即将推出 GraphQL 的新全局 ID 格式](https://github.blog/2021-02-10-new-global-id-format-coming-to-graphql)”。 ## 确定是否需要采取措施 -仅在存储对 GraphQL 全局节点 ID 的引用时，才需要遵循迁移步骤。 这些 ID 对应于架构中任何对象的 `id` 字段。 如果不存储任何全局节点 ID，则可以继续与 API 交互，而不会发生任何更改。 +仅在存储对 GraphQL 全局节点 ID 的引用时，才需要遵循迁移步骤。这些 ID 对应于架构中任何对象的 `id` 字段。如果不存储任何全局节点 ID，则可以继续与 API 交互，而不会发生任何更改。 -此外，如果当前对旧 ID 进行解码以提取类型信息（例如，如果使用 `PR_kwDOAHz1OX4uYAah` 的前两个字符来确定对象是否为拉取请求），则由于 ID 的格式已更改，你的服务将中断。 应迁移服务以将这些 ID 视为不透明字符串进行处理。 这些 ID 将是唯一的，因此您可以直接依赖它们作为引用。 +此外，如果当前对旧 ID 进行解码以提取类型信息（例如，如果使用 `PR_kwDOAHz1OX4uYAah` 的前两个字符来确定对象是否为拉取请求），则由于 ID 的格式已更改，你的服务将中断。应迁移服务以将这些 ID 视为不透明字符串进行处理。这些 ID 将是唯一的，因此您可以直接依赖它们作为引用。 ## 迁移到新的全局 ID -为方便迁移到新 ID 格式，你可以在 GraphQL API 请求中使用 `X-Github-Next-Global-ID` 标头。 `X-Github-Next-Global-ID` 标头的值可以是 `1` 或 `0`。 将该值设置为 `1` 将强制响应有效负载始终对为其请求 `id` 字段的任何对象使用新的 ID 格式。 将值设置为 `0` 将恢复为默认行为，即根据对象创建日期显示旧 ID 或新 ID。 +为方便迁移到新 ID 格式，你可以在 GraphQL API 请求中使用 `X-Github-Next-Global-ID` 标头。 `X-Github-Next-Global-ID` 标头的值可以是 `1` 或 `0`。将该值设置为 `1` 将强制响应有效负载始终对为其请求 `id` 字段的任何对象使用新的 ID 格式。将值设置为 `0` 将恢复为默认行为，即根据对象创建日期显示旧 ID 或新 ID。 下面是一个使用 cURL 的示例请求： @@ -47,9 +47,9 @@ $ curl \ ``` {"data":{"node":{"id":"U_kgDOADP9xw"}}} ``` -使用 `X-Github-Next-Global-ID` 标头，你可以找到在应用程序中引用的旧 ID 的新 ID 格式。 然后，您可以使用响应中收到的 ID 更新这些引用。 您应更新对旧版 ID 的所有引用，并对 API 的任何后续请求使用新的 ID 格式。 要执行批量操作，您可以使用别名在一次 API 调用中提交多个节点查询。 有关详细信息，请参阅“[GraphQL 文档](https://graphql.org/learn/queries/#aliases)”。 +使用 `X-Github-Next-Global-ID` 标头，你可以找到在应用程序中引用的旧 ID 的新 ID 格式。然后，您可以使用响应中收到的 ID 更新这些引用。您应更新对旧版 ID 的所有引用，并对 API 的任何后续请求使用新的 ID 格式。要执行批量操作，您可以使用别名在一次 API 调用中提交多个节点查询。有关详细信息，请参阅“[GraphQL 文档](https://graphql.org/learn/queries/#aliases)”。 -您还可以为项目集合获取新 ID。 例如，如果要获取组织中最后 10 个存储库的新 ID，则可以使用如下所示的查询： +您还可以为项目集合获取新 ID。例如，如果要获取组织中最后 10 个存储库的新 ID，则可以使用如下所示的查询： ``` { organization(login: "github") { @@ -66,7 +66,7 @@ $ curl \ } ``` -请注意，将 `X-Github-Next-Global-ID` 设置为 `1` 将影响查询中每个 `id` 字段的返回值。 这意味着，即使你提交了非 `node` 查询，只要请求了 `id` 字段便会获得新的格式 ID。 +请注意，将 `X-Github-Next-Global-ID` 设置为 `1` 将影响查询中每个 `id` 字段的返回值。这意味着，即使你提交了非 `node` 查询，只要请求了 `id` 字段便会获得新的格式 ID。 ## 分享反馈 diff --git a/translations/zh-CN/content/graphql/guides/using-global-node-ids.md b/translations/zh-CN/content/graphql/guides/using-global-node-ids.md index db4da798b837..0a55843c96a3 100644 --- a/translations/zh-CN/content/graphql/guides/using-global-node-ids.md +++ b/translations/zh-CN/content/graphql/guides/using-global-node-ids.md @@ -17,11 +17,11 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '146381470' --- -您可以使用 REST API 或 GraphQL API 访问 GitHub 中的大多数对象（用户、议题、拉取请求等）。 可以在 REST API 中找到许多对象的全局节点 ID，并将这些 ID 用于 GraphQL 操作。 有关详细信息，请参阅“[预览 REST API 资源中的 GraphQL API 节点 ID](https://developer.github.com/changes/2017-12-19-graphql-node-id/)”。 +您可以使用 REST API 或 GraphQL API 访问 GitHub 中的大多数对象（用户、议题、拉取请求等）。可以在 REST API 中找到许多对象的全局节点 ID，并将这些 ID 用于 GraphQL 操作。有关详细信息，请参阅“[预览 REST API 资源中的 GraphQL API 节点 ID](https://developer.github.com/changes/2017-12-19-graphql-node-id/)”。 {% note %} -注意：在 REST 中，全局节点 ID 字段被命名为 `node_id`。 在 GraphQL 中，此字段为 `node` 接口上的 `id` 字段。 若要重温“节点”在 GraphQL 中的含义，请参阅“[GraphQL 简介](/graphql/guides/introduction-to-graphql#node)”。 +注意：在 REST 中，全局节点 ID 字段被命名为 `node_id`。在 GraphQL 中，此字段为 `node` 接口上的 `id` 字段。若要重温“节点”在 GraphQL 中的含义，请参阅“[GraphQL 简介](/graphql/guides/introduction-to-graphql#node)”。 {% endnote %} @@ -95,9 +95,9 @@ $ curl -i -u username:token {% data variables.product.api_url_pre %}/us ## 2. 在 GraphQL 中查找对象类型 -在此示例中，`node_id` 值为 `MDQ6VXNlcjU4MzIzMQ==`。 您可以使用此值在 GraphQL 中查询同一个对象。 +在此示例中，`node_id` 值为 `MDQ6VXNlcjU4MzIzMQ==`。您可以使用此值在 GraphQL 中查询同一个对象。 -不过，首先需要知道对象的类型。 您可以通过简单的 GraphQL 查询检查类型： +不过，首先需要知道对象的类型。您可以通过简单的 GraphQL 查询检查类型： ```graphql query { @@ -113,7 +113,7 @@ query { ## 3. 在 GraphQL 中执行直接节点查找 -一旦确认类型，即可使用[行内分段](https://graphql.github.io/learn/queries/#inline-fragments)按 ID 访问对象并返回附加数据。 在本示例中，我们可以定义想要查询的 `User` 上的字段： +一旦确认类型，即可使用[行内分段](https://graphql.github.io/learn/queries/#inline-fragments)按 ID 访问对象并返回附加数据。在本示例中，我们可以定义想要查询的 `User` 上的字段： ```graphql query { @@ -130,4 +130,4 @@ query { ## 在迁移中使用全局节点 ID -构建使用 REST API 或 GraphQL API 的集成时，最佳做法是保留全局节点 ID，以便轻松引用不同 API 版本的对象。 有关处理 REST 与 GraphQL 之间的转换的更多信息，请参阅“[从 REST 迁移到 GraphQL](/graphql/guides/migrating-from-rest-to-graphql)”。 +构建使用 REST API 或 GraphQL API 的集成时，最佳做法是保留全局节点 ID，以便轻松引用不同 API 版本的对象。有关处理 REST 与 GraphQL 之间的转换的更多信息，请参阅“[从 REST 迁移到 GraphQL](/graphql/guides/migrating-from-rest-to-graphql)”。 diff --git a/translations/zh-CN/content/graphql/guides/using-the-explorer.md b/translations/zh-CN/content/graphql/guides/using-the-explorer.md index fb48215589ae..d3e768385d94 100644 --- a/translations/zh-CN/content/graphql/guides/using-the-explorer.md +++ b/translations/zh-CN/content/graphql/guides/using-the-explorer.md @@ -38,7 +38,7 @@ ms.locfileid: '146749487' 1. 获取 [OAuth 标记](/graphql/guides/forming-calls-with-graphql#authenticating-with-graphql)。 1. 启动 GraphiQL。 1. 在 GraphiQL 的右上角，单击“编辑 HTTP 标头”。 -1. 在“键”字段中，选择 。 在“值”字段中，输入 `Bearer `，其中 `` 是你生成的 OAuth 令牌。 +1. 在“键”字段中，选择。在“值”字段中，输入 `Bearer `，其中 `` 是你生成的 OAuth 令牌。 ![graphiql 标头](/assets/images/developer/graphiql-headers.png) 1. 单击该令牌右侧的复选标记进行保存。 1. 要返回编辑器，请在“编辑 HTTP 标头”模式外部单击。 @@ -61,11 +61,11 @@ query { } ``` -如果一切运行正常，将会显示您的登录信息。 您已设置完成，可以开始查询。 +如果一切运行正常，将会显示您的登录信息。您已设置完成，可以开始查询。 ## 访问边栏文档 -GraphQL 架构中的所有类型都包含一个编译到文档中的 `description` 字段。 该浏览器页面右侧可折叠的“文档”窗格可用于浏览有关类型系统的文档。 文档将自动更新，并删除已弃用的字段。 +GraphQL 架构中的所有类型都包含一个编译到文档中的 `description` 字段。该浏览器页面右侧可折叠的“文档”窗格可用于浏览有关类型系统的文档。文档将自动更新，并删除已弃用的字段。 {% note %} @@ -95,7 +95,7 @@ variables { 这是通过 cURL `POST` 提交调用的正确格式（但要[避免使用换行符](/graphql/guides/forming-calls-with-graphql#communicating-with-graphql)）。 -如果要在浏览器中运行调用，请在主窗格中输入 `query` 字段，并在其下方的“查询变量”窗格中输入变量。 在浏览器中省略 `variables` 一词： +如果要在浏览器中运行调用，请在主窗格中输入 `query` 字段，并在其下方的“查询变量”窗格中输入变量。在浏览器中省略 `variables` 一词： ```graphql { @@ -114,7 +114,7 @@ variables { * 基于当前架构的智能输入提示 * 键入时预提示验证错误 -如果输入的查询格式不正确或未通过[架构验证](/graphql/guides/introduction-to-graphql#schema)，则会弹出错误警示窗口。 如果您运行查询，错误将返回响应窗格中。 +如果输入的查询格式不正确或未通过[架构验证](/graphql/guides/introduction-to-graphql#schema)，则会弹出错误警示窗口。如果您运行查询，错误将返回响应窗格中。 GraphQL 响应中包含多个键：`data` 哈希和 `errors` 数组。 @@ -135,7 +135,7 @@ GraphQL 响应中包含多个键：`data` 哈希和 `errors` 数组。 } ``` -您可能会遇到与架构无关的意外错误。 如果发生这种情况，该消息将包含一个参考代码，供您在报告问题时使用： +您可能会遇到与架构无关的意外错误。如果发生这种情况，该消息将包含一个参考代码，供您在报告问题时使用： ```json { @@ -150,6 +150,6 @@ GraphQL 响应中包含多个键：`data` 哈希和 `errors` 数组。 {% note %} -注意：{% data variables.product.prodname_dotcom %} 建议，在将数据用于生产环境之前，先检查其是否有错误。 在 GraphQL 中，失败并不意味着全部错误：在一些 GraphQL 查询失败的同时，另一些查询可能成功。 +注意：{% data variables.product.prodname_dotcom %} 建议，在将数据用于生产环境之前，先检查其是否有错误。在 GraphQL 中，失败并不意味着全部错误：在一些 GraphQL 查询失败的同时，另一些查询可能成功。 {% endnote %} diff --git a/translations/zh-CN/content/graphql/guides/using-the-graphql-api-for-discussions.md b/translations/zh-CN/content/graphql/guides/using-the-graphql-api-for-discussions.md index a9e51db16e72..2056e59de2b3 100644 --- a/translations/zh-CN/content/graphql/guides/using-the-graphql-api-for-discussions.md +++ b/translations/zh-CN/content/graphql/guides/using-the-graphql-api-for-discussions.md @@ -11,15 +11,15 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147408841' --- -{% data variables.product.prodname_discussions %} GraphQL API 允许您获取、创建、编辑和删除讨论帖子。 有关 {% data variables.product.prodname_discussions %} 的详细信息，请参阅“[‎关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions)”。 +{% data variables.product.prodname_discussions %} GraphQL API 允许您获取、创建、编辑和删除讨论帖子。有关 {% data variables.product.prodname_discussions %} 的详细信息，请参阅“[‎关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions)”。 -此 API 适用于经过验证的用户、OAuth 应用程序和 GitHub 应用程序。 对于专用存储库，访问令牌需要 `repo` 范围，对于公共存储库，则需要 `public_repo` 范围。 有关详细信息，请参阅“[OAuth 应用的范围](/developers/apps/scopes-for-oauth-apps)”。 +此 API 适用于经过验证的用户、OAuth 应用程序和 GitHub 应用程序。对于专用存储库，访问令牌需要 `repo` 范围，对于公共存储库，则需要 `public_repo` 范围。有关详细信息，请参阅“[OAuth 应用的范围](/developers/apps/scopes-for-oauth-apps)”。 ## 字段 ### Repository.discussions -列出仓库中的讨论。 如果指定了 `categoryId`，则仅返回该类别中的结果。 +列出仓库中的讨论。如果指定了 `categoryId`，则仅返回该类别中的结果。 _签名：_ @@ -72,7 +72,7 @@ enum DiscussionOrderField { ### Repository.discussionCategories -返回此仓库中定义的可用讨论类别。 每个仓库最多可以有 10 个类别。 有关讨论类别的详细信息，请参阅“[关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)”。 +返回此仓库中定义的可用讨论类别。每个仓库最多可以有 10 个类别。有关讨论类别的详细信息，请参阅“[关于讨论](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)”。 _签名：_ @@ -87,7 +87,7 @@ discussionCategories( ### Repository.discussion -获取讨论. 如果使用指定 ID 的讨论不存在则返回 `null`。 +获取讨论。如果使用指定 ID 的讨论不存在则返回 `null`。 _签名：_ @@ -112,7 +112,7 @@ pinnedDiscussions( ## 对象 -注意：为简洁起见，此处不会扩展连接类型。 架构中提到的每个连接类型都遵循与 GraphQL API 中其他连接相同的模式。 有关详细信息，请参阅“[GraphQL 简介](/graphql/guides/introduction-to-graphql#connection)”。 +注意：为简洁起见，此处不会扩展连接类型。架构中提到的每个连接类型都遵循与 GraphQL API 中其他连接相同的模式。有关详细信息，请参阅“[GraphQL 简介](/graphql/guides/introduction-to-graphql#connection)”。 ```graphql query { @@ -854,7 +854,7 @@ enum PinnedDiscussionGradient { ### RepositoryDiscussionAuthor -由 `User` 和 `Organization` 类型实现。 注意：只有从 `User` 转换来的 `Organization` 才会有与之关联的讨论。 +由 `User` 和 `Organization` 类型实现。注意：只有从 `User` 转换来的 `Organization` 才会有与之关联的讨论。
字段 @@ -962,7 +962,7 @@ interface RepositoryDiscussionCommentAuthor { ## 突变 -这些突变遵循与 GraphQL API 中其他突变相同的实现模式。 每个突变都接受以突变命名的 `Input` 类型的单个参数，并返回包含指定字段的 `Payload` 类型。 +这些突变遵循与 GraphQL API 中其他突变相同的实现模式。每个突变都接受以突变命名的 `Input` 类型的单个参数，并返回包含指定字段的 `Payload` 类型。 例如，这是一个基本 `createDiscussion` 突变，将会创建一个新的讨论： @@ -981,7 +981,7 @@ mutation { ### createDiscussion -输入字段: +输入字段： * `body: String!` 新讨论的正文。 * `title: String!` 新讨论的标题。 @@ -996,7 +996,7 @@ mutation { ### updateDiscussion -输入字段: +输入字段： * `discussionId: ID!` 要更新的讨论的节点 ID。 * `body: String` 讨论正文的新内容。 @@ -1010,7 +1010,7 @@ mutation { * `discussion: Discussion` 已修改的讨论。 ### deleteDiscussion -输入字段: +输入字段： * `id: ID!` 要删除的讨论的节点 ID。 * `clientMutationId: String` 进行突变的客户端的唯一标识符。 @@ -1022,11 +1022,11 @@ mutation { ### addDiscussionComment -输入字段: +输入字段： * `body: String!` 注释的内容。 * `discussionId: ID!` 要注释的讨论的节点 ID。 -* `replyToId: ID` 要答复的讨论注释的节点 ID。 如果不存在，创建的评论将是顶层评论。 +* `replyToId: ID` 要答复的讨论注释的节点 ID。如果不存在，创建的评论将是顶层评论。 * `clientMutationId: String` 进行突变的客户端的唯一标识符。 返回类型字段： @@ -1036,7 +1036,7 @@ mutation { ### updateDiscussionComment -输入字段: +输入字段： * `body: String!` 注释正文的新内容。 * `commentId: ID!` 要更新的讨论注释的节点 ID。 @@ -1049,7 +1049,7 @@ mutation { ### deleteDiscussionComment -输入字段: +输入字段： * `id: ID!` 要删除的讨论注释的节点 ID。 * `clientMutationId: String` 进行突变的客户端的唯一标识符。 @@ -1061,7 +1061,7 @@ mutation { ### markDiscussionCommentAsAnswer -输入字段: +输入字段： * `id: ID!` 要标记为答案的讨论注释的节点 ID。 * `clientMutationId: String` 进行突变的客户端的唯一标识符。 @@ -1073,7 +1073,7 @@ mutation { ### unmarkDiscussionCommentAsAnswer -输入字段: +输入字段： * `id: ID!` 要取消标记为答案的讨论注释的节点 ID。 * `clientMutationId: String` 进行突变的客户端的唯一标识符。 @@ -1085,4 +1085,4 @@ mutation { ## 搜索 -可以从顶层 `search` 字段返回讨论。 若要搜索讨论，请指定 `type` 为 `DISCUSSION`。 `SearchResultItemConnection` 类型有一个 `discussionCount` 字段来报告返回的讨论数，并且 `Discussion` 类型已添加到 `SearchResultItem` 并集。 有关详细信息，请参阅“[查询](/graphql/reference/queries#searchresultitemconnection)”和“[搜索讨论](/search-github/searching-on-github/searching-discussions)”。 +可以从顶层 `search` 字段返回讨论。若要搜索讨论，请指定 `type` 为 `DISCUSSION`。 `SearchResultItemConnection` 类型有一个 `discussionCount` 字段来报告返回的讨论数，并且 `Discussion` 类型已添加到 `SearchResultItem` 并集。有关详细信息，请参阅“[查询](/graphql/reference/queries#searchresultitemconnection)”和“[搜索讨论](/search-github/searching-on-github/searching-discussions)”。 diff --git a/translations/zh-CN/content/graphql/overview/breaking-changes.md b/translations/zh-CN/content/graphql/overview/breaking-changes.md index cc778301d319..cb78e112670f 100644 --- a/translations/zh-CN/content/graphql/overview/breaking-changes.md +++ b/translations/zh-CN/content/graphql/overview/breaking-changes.md @@ -19,11 +19,11 @@ ms.locfileid: '147496650' --- ## 关于重大变更 -重大变更是指可能需要集成商采取行动的任何变更。 我们将这些变更分为两类： +重大变更是指可能需要集成商采取行动的任何变更。我们将这些变更分为两类： -- 中断性变更：会改变对 GraphQL API 的现有查询的变更。 例如，删除字段就是重大变更。 -- 危险变更：不会改变现有查询，但会影响客户端运行时的行为的变更。 添加枚举值就是一个危险变更示例。 +- 中断性变更：会改变对 GraphQL API 的现有查询的变更。例如，删除字段就是重大变更。 +- 危险变更：不会改变现有查询，但会影响客户端运行时的行为的变更。添加枚举值就是一个危险变更示例。 -我们努力为集成商提供稳定的 API。 当某项新功能还处于完善阶段时，我们将在[架构预览](/graphql/overview/schema-previews)模式下发布此功能。 +我们努力为集成商提供稳定的 API。当某项新功能还处于完善阶段时，我们将在[架构预览](/graphql/overview/schema-previews)模式下发布此功能。 -我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更，以便给集成商预留进行必要调整的时间。 变更在季度第一天（1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日）生效。 例如，如果我们在 1 月 15 日宣布变更，将在 7 月 1 日执行。 +我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更，以便给集成商预留进行必要调整的时间。变更在季度第一天（1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日）生效。例如，如果我们在 1 月 15 日宣布变更，将在 7 月 1 日执行。 diff --git a/translations/zh-CN/content/graphql/overview/changelog.md b/translations/zh-CN/content/graphql/overview/changelog.md index 59182e79319b..209cb4a5d176 100644 --- a/translations/zh-CN/content/graphql/overview/changelog.md +++ b/translations/zh-CN/content/graphql/overview/changelog.md @@ -1,6 +1,6 @@ --- title: 更改日志 -intro: GraphQL 架构变更日志是指最近和即将发生的 GraphQL API 架构变更列表。 其中包括向后兼容变更、架构预览和即将发生的重大变更。 +intro: GraphQL 架构变更日志是指最近和即将发生的 GraphQL API 架构变更列表。其中包括向后兼容变更、架构预览和即将发生的重大变更。 redirect_from: - /v4/changelog versions: @@ -17,4 +17,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147496546' --- -重大变更包括会改变现有查询或可能影响客户端运行时行为的变更。 有关中断性变更列表及其发生时间，请参阅我们的[中断性变更日志](/graphql/overview/breaking-changes)。 +重大变更包括会改变现有查询或可能影响客户端运行时行为的变更。有关中断性变更列表及其发生时间，请参阅我们的[中断性变更日志](/graphql/overview/breaking-changes)。 diff --git a/translations/zh-CN/content/graphql/overview/index.md b/translations/zh-CN/content/graphql/overview/index.md index 2918340e84ea..ff4f557a3d4b 100644 --- a/translations/zh-CN/content/graphql/overview/index.md +++ b/translations/zh-CN/content/graphql/overview/index.md @@ -1,6 +1,6 @@ --- title: 概述 -intro: '了解 {% data variables.product.prodname_dotcom %} GraphQL API、即将发生的变更预览、重大变更和限制。 您也可以使用 GraphQL Explorer 与真实 {% data variables.product.prodname_dotcom %} 数据的 API 交互。' +intro: '了解 {% data variables.product.prodname_dotcom %} GraphQL API、即将发生的变更预览、重大变更和限制。您也可以使用 GraphQL Explorer 与真实 {% data variables.product.prodname_dotcom %} 数据的 API 交互。' versions: fpt: '*' ghec: '*' diff --git a/translations/zh-CN/content/graphql/overview/resource-limitations.md b/translations/zh-CN/content/graphql/overview/resource-limitations.md index f269ceeb121c..440110edb3d9 100644 --- a/translations/zh-CN/content/graphql/overview/resource-limitations.md +++ b/translations/zh-CN/content/graphql/overview/resource-limitations.md @@ -137,12 +137,12 @@ ms.locfileid: '146381422' GraphQL API 限制不同于 REST API 的[速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting)。 -API 速率限制为什么不同？ 使用 [GraphQL](/graphql)，一个 GraphQL 调用可以替换 [多个 REST 调用](/graphql/guides/migrating-from-rest-to-graphql)。 单个复杂 GraphQL 调用可能相当于数千个 REST 请求。 虽然单个 GraphQL 调用远远低于 REST API v3 速率限制，但对 GitHub 的服务器来说，查询的计算成本可能同样高昂。 +API 速率限制为什么不同？使用 [GraphQL](/graphql)，一个 GraphQL 调用可以替换 [多个 REST 调用](/graphql/guides/migrating-from-rest-to-graphql)。单个复杂 GraphQL 调用可能相当于数千个 REST 请求。虽然单个 GraphQL 调用远远低于 REST API v3 速率限制，但对 GitHub 的服务器来说，查询的计算成本可能同样高昂。 -为了准确表示查询的服务器成本，GraphQL API 将根据标准化点数来计算调用的速率限制分数。 查询分数计入了父连接及其子连接上的第一个和最后一个参数。 +为了准确表示查询的服务器成本，GraphQL API 将根据标准化点数来计算调用的速率限制分数。查询分数计入了父连接及其子连接上的第一个和最后一个参数。 * 公式使用父连接及其子连接上的 `first` 和 `last` 参数预计算 GitHub 系统上的潜在负载，如 MySQL、ElasticSearch 和 Git。 -* 每个连接都有自己的点值。 此点值与调用的其他点数相结合，计入总速率限制分数。 +* 每个连接都有自己的点值。此点值与调用的其他点数相结合，计入总速率限制分数。 GraphQL API 速率限制为每小时 5,000 点。 @@ -184,10 +184,10 @@ query { ### 在运行调用之前计算速率限制分数 -查询 `rateLimit` 对象时会返回调用的分数，但运行调用时会计入限制。 为避免这种两难局面，可以在运行之前计算调用分数。 下面的计算结果与 `rateLimit { cost }` 返回的成本大致相同。 +查询 `rateLimit` 对象时会返回调用的分数，但运行调用时会计入限制。为避免这种两难局面，可以在运行之前计算调用分数。下面的计算结果与 `rateLimit { cost }` 返回的成本大致相同。 -1. 将完成调用中每个独有连接所需的请求数加起来。 假设每个请求都将达到 `first` 或 `last` 参数限制。 -2. 将数字除以 100，然后将结果四舍五入，获取最终的聚合成本。 这一步可使大数字规范化。 +1. 将完成调用中每个独有连接所需的请求数加起来。假设每个请求都将达到 `first` 或 `last` 参数限制。 +2. 将数字除以 100，然后将结果四舍五入，获取最终的聚合成本。这一步可使大数字规范化。 {% note %} @@ -231,9 +231,9 @@ query { 此查询需要 5,101 个请求才能完成： -* 虽然我们要返回 100 个存储库，但 API 必须连接到查看器的帐户一次才能获取存储库列表。 因此，存储库的请求 = 1 -* 虽然我们要返回 50 个问题，但 API 必须与 100 个存储库的每个库相连接，才能获取问题列表。 因此，问题请求 = 100 -* 虽然我们要返回 60 个标签，但 API 必须与 5,000 个潜在总问题中的每个问题相连接，才能获取标签列表。 因此，标签请求 = 5,000 +* 虽然我们要返回 100 个存储库，但 API 必须连接到查看器的帐户一次才能获取存储库列表。因此，存储库的请求 = 1 +* 虽然我们要返回 50 个问题，但 API 必须与 100 个存储库的每个库相连接，才能获取问题列表。因此，问题请求 = 100 +* 虽然我们要返回 60 个标签，但 API 必须与 5,000 个潜在总问题中的每个问题相连接，才能获取标签列表。因此，标签请求 = 5,000 * 总计 = 5,101 -除以100，然后四舍五入就得到了查询的最终分数：51 +除以 100，然后四舍五入就得到了查询的最终分数：51 diff --git a/translations/zh-CN/content/graphql/overview/schema-previews.md b/translations/zh-CN/content/graphql/overview/schema-previews.md index 5ac9dbaf96c5..42b69fab7f21 100644 --- a/translations/zh-CN/content/graphql/overview/schema-previews.md +++ b/translations/zh-CN/content/graphql/overview/schema-previews.md @@ -19,9 +19,9 @@ ms.locfileid: '147496594' --- ## 关于架构预览 -在预览期间，我们可以根据开发者的反馈更改某些功能。 如果我们确实进行了更改，我们将在[开发者博客](https://developer.github.com/changes/)上公布这些更改，而不会事先通知。 +在预览期间，我们可以根据开发者的反馈更改某些功能。如果我们确实进行了更改，我们将在[开发者博客](https://developer.github.com/changes/)上公布这些更改，而不会事先通知。 -若要访问架构预览，需要在请求的 `Accept` 标头中提供自定义[媒体类型](/rest/overview/media-types)。 每个预览的功能文档可指定要提供的自定义媒体类型。 +若要访问架构预览，需要在请求的 `Accept` 标头中提供自定义[媒体类型](/rest/overview/media-types)。每个预览的功能文档可指定要提供的自定义媒体类型。 {% note %} diff --git a/translations/zh-CN/content/graphql/reference/enums.md b/translations/zh-CN/content/graphql/reference/enums.md index ec5a2bab97b0..d766f04ec552 100644 --- a/translations/zh-CN/content/graphql/reference/enums.md +++ b/translations/zh-CN/content/graphql/reference/enums.md @@ -21,7 +21,7 @@ ms.locfileid: '147496642' [枚举](https://graphql.github.io/graphql-spec/June2018/#sec-Enums)表示字段的可能值集。 -例如，该 [`Issue`](/graphql/reference/objects#issue) 对象具有一个名为 `state` 的字段。 该状态是一个枚举（具体来说，是类型为 [`IssueState`](/graphql/reference/enums#issuestate) 的枚举），因为它可能是 `OPEN` 或 `CLOSED`。 +例如，该 [`Issue`](/graphql/reference/objects#issue) 对象具有一个名为 `state` 的字段。该状态是一个枚举（具体来说，是类型为 [`IssueState`](/graphql/reference/enums#issuestate) 的枚举），因为它可能是 `OPEN` 或 `CLOSED`。 有关详细信息，请参阅“[GraphQL 简介](/graphql/guides/introduction-to-graphql)”。 diff --git a/translations/zh-CN/content/graphql/reference/input-objects.md b/translations/zh-CN/content/graphql/reference/input-objects.md index 80296909653e..9f79adc1053b 100644 --- a/translations/zh-CN/content/graphql/reference/input-objects.md +++ b/translations/zh-CN/content/graphql/reference/input-objects.md @@ -21,7 +21,7 @@ ms.locfileid: '147496683' [输入对象](https://graphql.github.io/graphql-spec/June2018/#sec-Input-Objects)可描述为“可组合对象”，因为它们包含一组用于定义对象的输入字段。 -例如，[`CommitAuthor`](/graphql/reference/input-objects#commitauthor) 采用 `emails` 字段。 为 `emails` 提供一个值后，可将 `CommitAuthor` 转换成包含电子邮件地址的 `User` 对象列表。 注意，[对象](/graphql/reference/objects)可能包含输入对象，然而，[变更](/graphql/reference/mutations)需要输入对象 。 +例如，[`CommitAuthor`](/graphql/reference/input-objects#commitauthor) 采用 `emails` 字段。为 `emails` 提供一个值后，可将 `CommitAuthor` 转换成包含电子邮件地址的 `User` 对象列表。注意，[对象](/graphql/reference/objects)可能包含输入对象，然而，[变更](/graphql/reference/mutations)需要输入对象。 有关详细信息，请参阅“[关于变更](/graphql/guides/forming-calls-with-graphql#about-mutations)”。 diff --git a/translations/zh-CN/content/graphql/reference/interfaces.md b/translations/zh-CN/content/graphql/reference/interfaces.md index ba184ca3043b..684cdfd39580 100644 --- a/translations/zh-CN/content/graphql/reference/interfaces.md +++ b/translations/zh-CN/content/graphql/reference/interfaces.md @@ -21,7 +21,7 @@ ms.locfileid: '147496610' [接口](https://graphql.github.io/graphql-spec/June2018/#sec-Interfaces)用作其他对象可以继承的父对象。 -例如，[`Lockable`](/graphql/reference/interfaces#lockable) 是一个接口，因为 [`Issue`](/graphql/reference/objects#issue) 和 [`PullRequest`](/graphql/reference/objects#pullrequest) 对象都可以锁定。 接口拥有自己的指定字段列表，这些字段通过实现对象得以共享。 +例如，[`Lockable`](/graphql/reference/interfaces#lockable) 是一个接口，因为 [`Issue`](/graphql/reference/objects#issue) 和 [`PullRequest`](/graphql/reference/objects#pullrequest) 对象都可以锁定。接口拥有自己的指定字段列表，这些字段通过实现对象得以共享。 有关详细信息，请参阅“[实现](/graphql/guides/introduction-to-graphql#implementation)”。 diff --git a/translations/zh-CN/content/graphql/reference/mutations.md b/translations/zh-CN/content/graphql/reference/mutations.md index 156f1c3a2fbb..3b2479bc2dbf 100644 --- a/translations/zh-CN/content/graphql/reference/mutations.md +++ b/translations/zh-CN/content/graphql/reference/mutations.md @@ -19,7 +19,7 @@ ms.locfileid: '147496684' --- ## 关于突变 -每个 GraphQL 架构的查询和突变都有根类型。 [变更类型](https://graphql.github.io/graphql-spec/June2018/#sec-Type-System)定义更改服务器数据的 GraphQL 操作。 类似于执行 Http 谓词，例如 `POST`、`PATCH` 和 `DELETE`。 +每个 GraphQL 架构的查询和突变都有根类型。 [变更类型](https://graphql.github.io/graphql-spec/June2018/#sec-Type-System)定义更改服务器数据的 GraphQL 操作。类似于执行 Http 谓词，例如 `POST`、`PATCH` 和 `DELETE`。 有关详细信息，请参阅“[关于变更](/graphql/guides/forming-calls-with-graphql#about-mutations)”。 diff --git a/translations/zh-CN/content/graphql/reference/objects.md b/translations/zh-CN/content/graphql/reference/objects.md index 2070469b32de..279edc07cf84 100644 --- a/translations/zh-CN/content/graphql/reference/objects.md +++ b/translations/zh-CN/content/graphql/reference/objects.md @@ -19,7 +19,7 @@ ms.locfileid: '147496538' --- ## 关于对象 -GraphQL 中的[对象](https://graphql.github.io/graphql-spec/June2018/#sec-Objects)表示可以访问的资源。 对象包含经过专门类型化的字段列表。 +GraphQL 中的[对象](https://graphql.github.io/graphql-spec/June2018/#sec-Objects)表示可以访问的资源。对象包含经过专门类型化的字段列表。 例如，[`Repository`](/graphql/reference/objects#repository) 对象具有一个名为 `name` 的字段，该字段是 `String`。 diff --git a/translations/zh-CN/content/graphql/reference/queries.md b/translations/zh-CN/content/graphql/reference/queries.md index 6150e75f2e34..baa1df210d1c 100644 --- a/translations/zh-CN/content/graphql/reference/queries.md +++ b/translations/zh-CN/content/graphql/reference/queries.md @@ -26,7 +26,7 @@ ms.locfileid: '147496522' {% note %} -注意：对于[用户到服务器](/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) {% data variables.product.prodname_github_app %} 请求，应该为问题和拉取请求使用单独的查询。 例如，使用 `is:issue` 或 `is:pull-request` 筛选器及其等效项。 使用 `search` 连接在单一查询中返回问题和拉取请求的组合将产生一组空节点。 +注意：对于[用户到服务器](/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) {% data variables.product.prodname_github_app %} 请求，应该为问题和拉取请求使用单独的查询。例如，使用 `is:issue` 或 `is:pull-request` 筛选器及其等效项。使用 `search` 连接在单一查询中返回问题和拉取请求的组合将产生一组空节点。 {% endnote %} diff --git a/translations/zh-CN/content/graphql/reference/unions.md b/translations/zh-CN/content/graphql/reference/unions.md index f31ed4df1211..306aed46633a 100644 --- a/translations/zh-CN/content/graphql/reference/unions.md +++ b/translations/zh-CN/content/graphql/reference/unions.md @@ -21,7 +21,7 @@ ms.locfileid: '147496483' [联合](https://graphql.github.io/graphql-spec/June2018/#sec-Unions)是表示多个对象的对象类型。 -例如，标记为 [`ProjectCardItem`](/graphql/reference/unions#projectcarditem) 的字段可以是 [`Issue`](/graphql/reference/objects#issue) 或 [`PullRequest`](/graphql/reference/objects#pullrequest)，因为所有这些对象都可以位于一个项目卡中。 使用并集代替对象可以带来灵活性。 +例如，标记为 [`ProjectCardItem`](/graphql/reference/unions#projectcarditem) 的字段可以是 [`Issue`](/graphql/reference/objects#issue) 或 [`PullRequest`](/graphql/reference/objects#pullrequest)，因为所有这些对象都可以位于一个项目卡中。使用并集代替对象可以带来灵活性。 有关详细信息，请参阅“[GraphQL 简介](/graphql/guides/introduction-to-graphql)”。