diff --git a/translations/zh-CN/content/rest/README.md b/translations/zh-CN/content/rest/README.md index 2b3f180c1008..24919a566947 100644 --- a/translations/zh-CN/content/rest/README.md +++ b/translations/zh-CN/content/rest/README.md @@ -10,9 +10,9 @@ ms.locfileid: "145129226" `/content/rest` 目录是 GitHub REST API 文档所在的位置！ -* `/content/rest/guides` 和 `/content/rest/overview` 目录包含常规文章。 这些项目可人工编辑。 -* `/content/rest/reference` 目录包含 GitHub REST API 中每组终结点的文章。 此目录中的大部分内容都使用 `include` 标记呈现。 +* `/content/rest/guides` 和 `/content/rest/overview` 目录包含常规文章。这些项目可人工编辑。 +* `/content/rest/reference` 目录包含 GitHub REST API 中每组终结点的文章。此目录中的大部分内容都使用 `include` 标记呈现。 - `include` 标记呈现的内容来自 `/lib/rest/static` 目录，由 GitHub 内部的 API 源代码自动生成，不应人工编辑。 有关详细信息，请参阅 [`/lib/rest/README.md`](/lib/rest/README.md)。 + `include` 标记呈现的内容来自 `/lib/rest/static` 目录，由 GitHub 内部的 API 源代码自动生成，不应人工编辑。有关详细信息，请参阅 [`/lib/rest/README.md`](/lib/rest/README.md)。 我们无法接受对由 `include` 标记呈现的内容的更改。但你可以打开一个描述你希望看到的更改的问题。 diff --git a/translations/zh-CN/content/rest/actions/index.md b/translations/zh-CN/content/rest/actions/index.md index 2979e82974aa..e86de1ed81f0 100644 --- a/translations/zh-CN/content/rest/actions/index.md +++ b/translations/zh-CN/content/rest/actions/index.md @@ -30,4 +30,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147061968' --- -{% data variables.product.prodname_actions %} API 允许您使用 REST API 来管理 {% data variables.product.prodname_actions %}。 {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} 需要在每个端点中提及的权限。 有关详细信息，请参阅“[{% data variables.product.prodname_actions %} 文档](/actions)”。 +{% data variables.product.prodname_actions %} API 允许您使用 REST API 来管理 {% data variables.product.prodname_actions %}。 {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} 需要在每个端点中提及的权限。有关详细信息，请参阅“[{% data variables.product.prodname_actions %} 文档](/actions)”。 diff --git a/translations/zh-CN/content/rest/actions/secrets.md b/translations/zh-CN/content/rest/actions/secrets.md index 6e7a84a46307..641302c7cb87 100644 --- a/translations/zh-CN/content/rest/actions/secrets.md +++ b/translations/zh-CN/content/rest/actions/secrets.md @@ -21,4 +21,4 @@ ms.locfileid: '147061978' 通过 {% data variables.product.prodname_actions %} 机密 API，可以创建、更新、删除和检索有关可在 {% data variables.product.prodname_actions %} 工作流中使用的加密机密的信息。 {% data reusables.actions.about-secrets %} 有关详细信息，请参阅“[创建和使用加密机密](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)”。 -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %}必须具有 `secrets` 权限才可使用此 API。 经过身份验证的用户必须对仓库具有协作者权限才可创建、更新或读取密码。 +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %}必须具有 `secrets` 权限才可使用此 API。经过身份验证的用户必须对仓库具有协作者权限才可创建、更新或读取密码。 diff --git a/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md b/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md index 90a1075e13aa..97bcfabcdcc7 100644 --- a/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md +++ b/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md @@ -17,6 +17,6 @@ ms.locfileid: '147064368' --- ## 关于自托管运行器组 API -自托管运行器组 API 允许你管理自托管运行器组。 有关详细信息，请参阅“[使用组管理对自托管运行器的访问](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)”。 +自托管运行器组 API 允许你管理自托管运行器组。有关详细信息，请参阅“[使用组管理对自托管运行器的访问](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)”。 -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %}必须具有对存储库的 `administration` 权限，或具有对组织的 `organization_self_hosted_runners` 权限。 经过身份验证的用户必须具有对存储库或组织的管理员访问权限或者企业的 `manage_runners:enterprise` 作用域才能使用此 API。 +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %}必须具有对存储库的 `administration` 权限，或具有对组织的 `organization_self_hosted_runners` 权限。经过身份验证的用户必须具有对存储库或组织的管理员访问权限或者企业的 `manage_runners:enterprise` 作用域才能使用此 API。 diff --git a/translations/zh-CN/content/rest/actions/self-hosted-runners.md b/translations/zh-CN/content/rest/actions/self-hosted-runners.md index 5f6e0f2e89f2..3545b28d95e8 100644 --- a/translations/zh-CN/content/rest/actions/self-hosted-runners.md +++ b/translations/zh-CN/content/rest/actions/self-hosted-runners.md @@ -19,4 +19,4 @@ ms.locfileid: '147064376' 自托管运行器 API 支持注册、查看和删除自托管的运行器。 {% data reusables.actions.about-self-hosted-runners %} 有关详细信息，请参阅“[托管自己的运行器](/actions/hosting-your-own-runners)”。 -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %}必须具有对存储库的 `administration` 权限，或具有对组织的 `organization_self_hosted_runners` 权限。 经过身份验证的用户必须具有对存储库或组织的管理员访问权限或者企业的 `manage_runners:enterprise` 作用域才能使用此 API。 +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %}必须具有对存储库的 `administration` 权限，或具有对组织的 `organization_self_hosted_runners` 权限。经过身份验证的用户必须具有对存储库或组织的管理员访问权限或者企业的 `manage_runners:enterprise` 作用域才能使用此 API。 diff --git a/translations/zh-CN/content/rest/activity/events.md b/translations/zh-CN/content/rest/activity/events.md index 176af52f9ffb..823c63835aea 100644 --- a/translations/zh-CN/content/rest/activity/events.md +++ b/translations/zh-CN/content/rest/activity/events.md @@ -18,9 +18,9 @@ ms.locfileid: '147064304' --- 这些事件推动站点上的各种活动流。 -事件 API 可以返回 {% data variables.product.product_name %} 上的活动触发的不同类型事件。 有关可从事件 API 接收的特定事件的详细信息，请参阅“[{% data variables.product.prodname_dotcom %} 事件类型](/developers/webhooks-and-events/github-event-types)”。 存储库问题的事件 API 也可用。 有关详细信息，请参阅“[议题事件 API](/rest/reference/issues#events)”。 +事件 API 可以返回 {% data variables.product.product_name %} 上的活动触发的不同类型事件。有关可从事件 API 接收的特定事件的详细信息，请参阅“[{% data variables.product.prodname_dotcom %} 事件类型](/developers/webhooks-and-events/github-event-types)”。存储库问题的事件 API 也可用。有关详细信息，请参阅“[议题事件 API](/rest/reference/issues#events)”。 -事件针对使用 "ETag" 标头的轮询进行了优化。 如果未触发任何新事件，您将会看到一个 "304 Not Modified" 响应，并且您的当前速率限制不受影响。 还有一个 "X-Poll-Interval" 标头，用于指定允许您轮询的间隔时间（以秒为单位）。 在服务器负载较高时，该时间可能会增加。 请遵循标头指示。 +事件针对使用 "ETag" 标头的轮询进行了优化。如果未触发任何新事件，您将会看到一个 "304 Not Modified" 响应，并且您的当前速率限制不受影响。还有一个 "X-Poll-Interval" 标头，用于指定允许您轮询的间隔时间（以秒为单位）。在服务器负载较高时，该时间可能会增加。请遵循标头指示。 ``` shell $ curl -I {% data variables.product.api_url_pre %}/users/tater/events @@ -35,4 +35,4 @@ $ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' > X-Poll-Interval: 60 ``` -时间表中只包含过去 90 天内创建的事件。 超过 90 天的活动将不包括在内（即使时间表中的活动总数不到 300 个）。 +时间表中只包含过去 90 天内创建的事件。超过 90 天的活动将不包括在内（即使时间表中的活动总数不到 300 个）。 diff --git a/translations/zh-CN/content/rest/activity/feeds.md b/translations/zh-CN/content/rest/activity/feeds.md index a7a71af57f8f..6e5e3b9c462f 100644 --- a/translations/zh-CN/content/rest/activity/feeds.md +++ b/translations/zh-CN/content/rest/activity/feeds.md @@ -18,11 +18,11 @@ ms.locfileid: '147064296' --- ## 关于源 API -若要查看可用的源，请使用[“获取源”](#get-feeds)操作。 然后，可以通过向其中一个源 URL 发送请求来获取源。 +若要查看可用的源，请使用[“获取源”](#get-feeds)操作。然后，可以通过向其中一个源 URL 发送请求来获取源。 ### 获取 Atom 馈送的示例 -若要获取 Atom 格式的馈送，必须在 `Accept` 标头中指定 `application/atom+xml` 类型。 例如，要获取 GitHub 安全通告的 Atom 馈送： +若要获取 Atom 格式的馈送，必须在 `Accept` 标头中指定 `application/atom+xml` 类型。例如，要获取 GitHub 安全通告的 Atom 馈送： curl -H "Accept: application/atom+xml" https://github.com/security-advisories diff --git a/translations/zh-CN/content/rest/activity/notifications.md b/translations/zh-CN/content/rest/activity/notifications.md index 3636878dcdac..239c9a6baeab 100644 --- a/translations/zh-CN/content/rest/activity/notifications.md +++ b/translations/zh-CN/content/rest/activity/notifications.md @@ -18,13 +18,13 @@ ms.locfileid: '147064272' --- ## 关于通知 API -使用通知 API 可以管理 {% data variables.product.product_name %} 通知。 有关通知的详细信息，请参阅“[关于通知](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)”。 +使用通知 API 可以管理 {% data variables.product.product_name %} 通知。有关通知的详细信息，请参阅“[关于通知](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)”。 -所有通知 API 调用都需要 `notifications` 或 `repo` API 作用域。 这将赋予对某些议题和提交内容的只读权限。 你仍需要 `repo` 作用域才能从相应的端点访问议题和提交。 +所有通知 API 调用都需要 `notifications` 或 `repo` API 作用域。这将赋予对某些议题和提交内容的只读权限。你仍需要 `repo` 作用域才能从相应的端点访问议题和提交。 -通知以“帖子”的形式返回。 帖子包含当前对议题、拉取请求或提交的讨论信息。 +通知以“帖子”的形式返回。帖子包含当前对议题、拉取请求或提交的讨论信息。 -通知针对使用 `Last-Modified` 标头的轮询进行了优化。 如果没有新的通知，你将看到 `304 Not Modified` 响应，你的当前速率限制不受影响。 还有一个 `X-Poll-Interval` 标头，用于指定允许你轮询的间隔时间（以秒为单位）。 在服务器负载较高时，该时间可能会增加。 请遵循标头指示。 +通知针对使用 `Last-Modified` 标头的轮询进行了优化。如果没有新的通知，你将看到 `304 Not Modified` 响应，你的当前速率限制不受影响。还有一个 `X-Poll-Interval` 标头，用于指定允许你轮询的间隔时间（以秒为单位）。在服务器负载较高时，该时间可能会增加。请遵循标头指示。 ``` shell # Add authentication to your requests @@ -42,7 +42,7 @@ $ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" ### 关于通知原因 -从通知 API 检索响应时，每个有效负载都有一个名为 `reason` 的键。 这些键对应于触发通知的事件。 +从通知 API 检索响应时，每个有效负载都有一个名为 `reason` 的键。这些键对应于触发通知的事件。 以下是接收通知的可能 `reason`： @@ -63,4 +63,4 @@ $ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" 请注意，`reason` 根据每个帖子而修改，如果在以后的通知中，`reason` 不同，其值可能会变更。 -例如，如果你是某个议题的作者，则有关该议题的后续通知中，其 `reason` 值为 `author`。 如果后来你在这个议题上被 **@mentioned** ，则你此后收到的通知中，其 `reason` 值为 `mention`。 无论你此后是否被再次提及，`reason` 值将保持 `mention` 不变。 +例如，如果你是某个议题的作者，则有关该议题的后续通知中，其 `reason` 值为 `author`。如果后来你在这个议题上被 **@mentioned** ，则你此后收到的通知中，其 `reason` 值为 `mention`。无论你此后是否被再次提及，`reason` 值将保持 `mention` 不变。 diff --git a/translations/zh-CN/content/rest/activity/starring.md b/translations/zh-CN/content/rest/activity/starring.md index 94e0f41d965f..54bf4e66a334 100644 --- a/translations/zh-CN/content/rest/activity/starring.md +++ b/translations/zh-CN/content/rest/activity/starring.md @@ -18,15 +18,15 @@ ms.locfileid: '147064248' --- ## 关于星标 API -星标 API 允许为存储库添加书签。 显示在仓库旁边的星标表示大致的兴趣程度。 星标对通知或活动馈送没有影响。 有关详细信息，请参阅“[使用星标保存存储库](/get-started/exploring-projects-on-github/saving-repositories-with-stars)”。 +星标 API 允许为存储库添加书签。显示在仓库旁边的星标表示大致的兴趣程度。星标对通知或活动馈送没有影响。有关详细信息，请参阅“[使用星标保存存储库](/get-started/exploring-projects-on-github/saving-repositories-with-stars)”。 ### 标星与 关注 -2012 年 8 月，我们在 {% data variables.product.prodname_dotcom %} 上[更改了关注工作的方式](https://github.com/blog/1204-notifications-stars)。 许多 API 客户端应用程序可能在使用原始的“观察程序”端点来访问此数据。 现在，可以开始使用“星标”端点了（如下所述）。 有关详细信息，请参阅[观察程序 API 更改帖子](https://developer.github.com/changes/2012-09-05-watcher-api/)和“[存储库观察 API](/rest/reference/activity#watching)”。 +2012 年 8 月，我们在 {% data variables.product.prodname_dotcom %} 上[更改了关注工作的方式](https://github.com/blog/1204-notifications-stars)。许多 API 客户端应用程序可能在使用原始的“观察程序”端点来访问此数据。现在，可以开始使用“星标”端点了（如下所述）。有关详细信息，请参阅[观察程序 API 更改帖子](https://developer.github.com/changes/2012-09-05-watcher-api/)和“[存储库观察 API](/rest/reference/activity#watching)”。 ### 标星的自定义媒体类型 -标星 REST API 有一个支持的自定义媒体类型。 使用此自定义媒体类型时，你将收到带有 `starred_at` 时间戳属性的响应，该属性指示星标创建的时间。 该响应还有第二个属性，该属性包括在不使用自定义媒体类型时返回的资源。 包含资源的属性将为 `user` 或 `repo`。 +标星 REST API 有一个支持的自定义媒体类型。使用此自定义媒体类型时，你将收到带有 `starred_at` 时间戳属性的响应，该属性指示星标创建的时间。该响应还有第二个属性，该属性包括在不使用自定义媒体类型时返回的资源。包含资源的属性将为 `user` 或 `repo`。 application/vnd.github.star+json diff --git a/translations/zh-CN/content/rest/activity/watching.md b/translations/zh-CN/content/rest/activity/watching.md index 0edf6528aaf5..5ca0101d5db7 100644 --- a/translations/zh-CN/content/rest/activity/watching.md +++ b/translations/zh-CN/content/rest/activity/watching.md @@ -18,4 +18,4 @@ ms.locfileid: '147883479' --- ## 关于监视 API -监视 API 允许用户订阅存储库中活动的通知。 若要改为为存储库添加书签，请参阅“[标星](/rest/reference/activity#starring)”。 +监视 API 允许用户订阅存储库中活动的通知。若要改为为存储库添加书签，请参阅“[标星](/rest/reference/activity#starring)”。 diff --git a/translations/zh-CN/content/rest/apps/apps.md b/translations/zh-CN/content/rest/apps/apps.md index 4a5ceffedb3b..afab9388a380 100644 --- a/translations/zh-CN/content/rest/apps/apps.md +++ b/translations/zh-CN/content/rest/apps/apps.md @@ -21,10 +21,10 @@ ms.locfileid: '146769187' {% data reusables.apps.general-apps-restrictions %} -本页列出了验证为 GitHub 应用程序后可访问的端点。 有关详细信息，请参阅“[验证为 GitHub 应用](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)”。 +本页列出了验证为 GitHub 应用程序后可访问的端点。有关详细信息，请参阅“[验证为 GitHub 应用](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)”。 验证为 GitHub 应用程序后，GitHub 应用程序 API 使您能够获取有关 GitHub 应用程序的高层次信息以及有关应用程序安装的特定信息。 -验证为 GitHub 应用后，你可以访问 REST API 终结点。 这些终结点包含指示“使用 GitHub 应用”的文本。 验证为用户后也可以访问这些端点。 +验证为 GitHub 应用后，你可以访问 REST API 终结点。这些终结点包含指示“使用 GitHub 应用”的文本。验证为用户后也可以访问这些端点。 -某些 REST API 终结点需要验证为 GitHub 应用安装设施。 有关这些终结点的列表，请参阅“[安装](/rest/reference/apps#installations)”。 +某些 REST API 终结点需要验证为 GitHub 应用安装设施。有关这些终结点的列表，请参阅“[安装](/rest/reference/apps#installations)”。 diff --git a/translations/zh-CN/content/rest/apps/installations.md b/translations/zh-CN/content/rest/apps/installations.md index c3c615f1ef64..f20e87bbe46c 100644 --- a/translations/zh-CN/content/rest/apps/installations.md +++ b/translations/zh-CN/content/rest/apps/installations.md @@ -20,6 +20,6 @@ ms.locfileid: '147711668' --- ## 关于 {% data variables.product.prodname_github_app %} 安装 API -“安装”是指已安装该应用的任何用户或组织帐户。 有关如何验证为安装并限制对特定存储库的访问的信息，请参阅“[验证为安装](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)”。 +“安装”是指已安装该应用的任何用户或组织帐户。有关如何验证为安装并限制对特定存储库的访问的信息，请参阅“[验证为安装](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)”。 若要列出组织的所有 GitHub 应用安装，请参阅“[列出组织的应用安装](/rest/orgs/orgs#list-app-installations-for-an-organization)”。 diff --git a/translations/zh-CN/content/rest/apps/marketplace.md b/translations/zh-CN/content/rest/apps/marketplace.md index 694894f9dcc8..0f1aaacdfb30 100644 --- a/translations/zh-CN/content/rest/apps/marketplace.md +++ b/translations/zh-CN/content/rest/apps/marketplace.md @@ -24,8 +24,8 @@ ms.locfileid: '145129186' ### 使用存根端点进行测试 -此 API 包含的终结点允许使用“存根数据”[测试 {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/)。 存根数据是硬编码的假数据，不会根据实际订阅而更改。 +此 API 包含的终结点允许使用“存根数据”[测试 {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/)。存根数据是硬编码的假数据，不会根据实际订阅而更改。 -要使用存根数据进行测试，请使用存根端点代替其对应的生产端点。 这允许您在 {% data variables.product.prodname_marketplace %} 上列出 {% data variables.product.prodname_github_apps %} 之前测试 API 逻辑是否成功。 +要使用存根数据进行测试，请使用存根端点代替其对应的生产端点。这允许您在 {% data variables.product.prodname_marketplace %} 上列出 {% data variables.product.prodname_github_apps %} 之前测试 API 逻辑是否成功。 在部署您的 {% data variables.product.prodname_github_app %} 之前，请务必将存根端点替换为生产端点。 diff --git a/translations/zh-CN/content/rest/billing.md b/translations/zh-CN/content/rest/billing.md index 54a6b660e211..5928a72aaacb 100644 --- a/translations/zh-CN/content/rest/billing.md +++ b/translations/zh-CN/content/rest/billing.md @@ -19,4 +19,4 @@ ms.locfileid: '147062503' --- ## 关于计费 API -您可以获取企业的帐单信息。 有关详细信息，请参阅“[{% data variables.product.prodname_dotcom %} Enterprise 管理](/rest/reference/enterprise-admin#billing)”REST API。 +您可以获取企业的帐单信息。有关详细信息，请参阅“[{% data variables.product.prodname_dotcom %} Enterprise 管理](/rest/reference/enterprise-admin#billing)”REST API。 diff --git a/translations/zh-CN/content/rest/checks/index.md b/translations/zh-CN/content/rest/checks/index.md index 513c999d0a30..7a3c35230da6 100644 --- a/translations/zh-CN/content/rest/checks/index.md +++ b/translations/zh-CN/content/rest/checks/index.md @@ -22,4 +22,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/11/2022 ms.locfileid: '147065840' --- -您可以创建应用程序以执行持续集成 、代码分析或代码扫描服务，并提供有关提交的详细反馈。 有关详细信息，请参阅“[检查 API 入门](/rest/guides/getting-started-with-the-checks-api)”和“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)”。 +您可以创建应用程序以执行持续集成、代码分析或代码扫描服务，并提供有关提交的详细反馈。有关详细信息，请参阅“[检查 API 入门](/rest/guides/getting-started-with-the-checks-api)”和“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)”。 diff --git a/translations/zh-CN/content/rest/checks/suites.md b/translations/zh-CN/content/rest/checks/suites.md index 07dbbb985e96..aebb9dc0c632 100644 --- a/translations/zh-CN/content/rest/checks/suites.md +++ b/translations/zh-CN/content/rest/checks/suites.md @@ -19,6 +19,6 @@ ms.locfileid: '147063192' --- {% note %} - 注意：GitHub 应用在每个提交 SHA 中仅接收一个 [`check_suite`](/webhooks/event-payloads/#check_suite) 事件，即使将提交 SHA 推送到多个分支也是如此。 要了解何时将提交 SHA 推送到分支，可以订阅分支 [`create`](/webhooks/event-payloads/#create) 事件。 + 注意：GitHub 应用在每个提交 SHA 中仅接收一个 [`check_suite`](/webhooks/event-payloads/#check_suite) 事件，即使将提交 SHA 推送到多个分支也是如此。要了解何时将提交 SHA 推送到分支，可以订阅分支 [`create`](/webhooks/event-payloads/#create) 事件。 {% endnote %} diff --git a/translations/zh-CN/content/rest/code-scanning.md b/translations/zh-CN/content/rest/code-scanning.md index 52eb938af04f..ce8455d940c1 100644 --- a/translations/zh-CN/content/rest/code-scanning.md +++ b/translations/zh-CN/content/rest/code-scanning.md @@ -24,7 +24,7 @@ ms.locfileid: '147061392' ## 关于代码扫描 API -{% data variables.product.prodname_code_scanning %} API 可让您从仓库检索和更新 {% data variables.product.prodname_code_scanning %} 警报。 您可以使用端点为组织中的 {% data variables.product.prodname_code_scanning %} 警报创建自动报告，或上传使用离线 {% data variables.product.prodname_code_scanning %} 工具生成的分析结果。 有关详细信息，请参阅“[查找代码中的安全漏洞和错误](/github/finding-security-vulnerabilities-and-errors-in-your-code)”。 +{% data variables.product.prodname_code_scanning %} API 可让您从仓库检索和更新 {% data variables.product.prodname_code_scanning %} 警报。您可以使用端点为组织中的 {% data variables.product.prodname_code_scanning %} 警报创建自动报告，或上传使用离线 {% data variables.product.prodname_code_scanning %} 工具生成的分析结果。有关详细信息，请参阅“[查找代码中的安全漏洞和错误](/github/finding-security-vulnerabilities-and-errors-in-your-code)”。 ### {% data variables.product.prodname_code_scanning %} 的自定义媒体类型 @@ -32,6 +32,6 @@ ms.locfileid: '147061392' application/sarif+json -可以将此媒体类型用于发送到 `/analyses/{analysis_id}` 终结点的 `GET` 请求。 有关此操作的详细信息，请参阅“[获取存储库的 {% data variables.product.prodname_code_scanning %} 分析](#get-a-code-scanning-analysis-for-a-repository)”。 将此媒体类型用于此操作时，响应包括为指定分析上传的实际数据的子集，而不是使用默认媒体类型时返回的分析摘要。 响应还包括其他数据，如 `github/alertNumber` 和 `github/alertUrl` 属性。 数据的格式为 [SARIF 版本 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html)。 +可以将此媒体类型用于发送到 `/analyses/{analysis_id}` 终结点的 `GET` 请求。有关此操作的详细信息，请参阅“[获取存储库的 {% data variables.product.prodname_code_scanning %} 分析](#get-a-code-scanning-analysis-for-a-repository)”。将此媒体类型用于此操作时，响应包括为指定分析上传的实际数据的子集，而不是使用默认媒体类型时返回的分析摘要。响应还包括其他数据，如 `github/alertNumber` 和 `github/alertUrl` 属性。数据的格式为 [SARIF 版本 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html)。 有关详细信息，请参阅“[媒体类型](/rest/overview/media-types)”。 diff --git a/translations/zh-CN/content/rest/codes-of-conduct.md b/translations/zh-CN/content/rest/codes-of-conduct.md index 445d41613dd3..8a657e14fd83 100644 --- a/translations/zh-CN/content/rest/codes-of-conduct.md +++ b/translations/zh-CN/content/rest/codes-of-conduct.md @@ -20,4 +20,4 @@ ms.locfileid: '147061384' --- ## 关于行为准则 API -您可以使用行为准则 API 检索有关仓库行为准则的信息。 若要获取存储库的行为准则，请使用“[获取存储库](/rest/reference/repos#get-a-repository)”终结点。 +您可以使用行为准则 API 检索有关仓库行为准则的信息。若要获取存储库的行为准则，请使用“[获取存储库](/rest/reference/repos#get-a-repository)”终结点。 diff --git a/translations/zh-CN/content/rest/codespaces/codespaces.md b/translations/zh-CN/content/rest/codespaces/codespaces.md index 3eea611e0c55..9d5e664bf9c9 100644 --- a/translations/zh-CN/content/rest/codespaces/codespaces.md +++ b/translations/zh-CN/content/rest/codespaces/codespaces.md @@ -16,4 +16,4 @@ ms.locfileid: '147110568' --- ## 关于 Codespaces API -{% data variables.product.prodname_github_codespaces %} API 使你能够使用 REST API 管理 {% data variables.product.prodname_codespaces %}。 此 API 适用于经过验证的用户、OAuth 应用和 GitHub 应用。 有关详细信息，请参阅“[{% data variables.product.prodname_codespaces %}](/codespaces)。” +{% data variables.product.prodname_github_codespaces %} API 使你能够使用 REST API 管理 {% data variables.product.prodname_codespaces %}。此 API 适用于经过验证的用户、OAuth 应用和 GitHub 应用。有关详细信息，请参阅“[{% data variables.product.prodname_codespaces %}](/codespaces)。” diff --git a/translations/zh-CN/content/rest/codespaces/machines.md b/translations/zh-CN/content/rest/codespaces/machines.md index f1cf1b6ffc4d..3721323b5c0a 100644 --- a/translations/zh-CN/content/rest/codespaces/machines.md +++ b/translations/zh-CN/content/rest/codespaces/machines.md @@ -18,6 +18,6 @@ ms.locfileid: '147067976' --- ## 关于 Codespaces 计算机 API -Codespaces 计算机 API 允许用户确定哪些计算机类型可用于创建 codespace，无论是在给定的存储库上还是作为经过身份验证的用户。 有关详细信息，请参阅“[有关计算机类型](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)。” +Codespaces 计算机 API 允许用户确定哪些计算机类型可用于创建 codespace，无论是在给定的存储库上还是作为经过身份验证的用户。有关详细信息，请参阅“[有关计算机类型](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)。” -还可以通过更新其 `machine` 属性来更改现有 codespace 的机器时使用此信息。 计算机更新将在下次重新启动 codespace 时进行。 有关详细信息，请参阅“[更改 codespace 的计算机类型](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)。” +还可以通过更新其 `machine` 属性来更改现有 codespace 的机器时使用此信息。计算机更新将在下次重新启动 codespace 时进行。有关详细信息，请参阅“[更改 codespace 的计算机类型](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)。” diff --git a/translations/zh-CN/content/rest/codespaces/organizations.md b/translations/zh-CN/content/rest/codespaces/organizations.md index 41e0e2229743..347f3797876e 100644 --- a/translations/zh-CN/content/rest/codespaces/organizations.md +++ b/translations/zh-CN/content/rest/codespaces/organizations.md @@ -20,4 +20,4 @@ ms.locfileid: '147079873' ## 关于 Codespaces 组织 API -可通过 {% data variables.product.prodname_codespaces %} 组织 API 使用 REST API 管理向组织收费的 {% data variables.product.prodname_codespaces %}。 此 API 可用于经过身份验证的组织管理员和 OAuth 应用，但不适用于 GitHub 应用。 有关详细信息，请参阅“[{% data variables.product.prodname_codespaces %}](/codespaces)。” +可通过 {% data variables.product.prodname_codespaces %} 组织 API 使用 REST API 管理向组织收费的 {% data variables.product.prodname_codespaces %}。此 API 可用于经过身份验证的组织管理员和 OAuth 应用，但不适用于 GitHub 应用。有关详细信息，请参阅“[{% data variables.product.prodname_codespaces %}](/codespaces)。” diff --git a/translations/zh-CN/content/rest/codespaces/repository-secrets.md b/translations/zh-CN/content/rest/codespaces/repository-secrets.md index b01b430e9f7c..6e1a54d2ca52 100644 --- a/translations/zh-CN/content/rest/codespaces/repository-secrets.md +++ b/translations/zh-CN/content/rest/codespaces/repository-secrets.md @@ -18,4 +18,4 @@ ms.locfileid: '147063976' --- ## 关于 Codespaces 存储库机密 API -Codespaces 存储库机密 API 允许用户为用户有权访问的存储库创建、列出和删除机密（如云服务的访问令牌）。 这些机密在运行时可供 codespace 使用。 有关详细信息，请参阅“[管理 codespace 的加密机密](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)。” +Codespaces 存储库机密 API 允许用户为用户有权访问的存储库创建、列出和删除机密（如云服务的访问令牌）。这些机密在运行时可供 codespace 使用。有关详细信息，请参阅“[管理 codespace 的加密机密](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)。” diff --git a/translations/zh-CN/content/rest/codespaces/secrets.md b/translations/zh-CN/content/rest/codespaces/secrets.md index 8baf34b6cc15..866d21297146 100644 --- a/translations/zh-CN/content/rest/codespaces/secrets.md +++ b/translations/zh-CN/content/rest/codespaces/secrets.md @@ -18,4 +18,4 @@ ms.locfileid: '147067232' --- ## 关于 Codespaces 用户机密 API -Codespaces 用户机密 API 支持用户创建、列出和删除机密（例如云服务的访问令牌）以及将机密分配给用户有权访问的存储库。 这些机密在运行时可供 codespace 使用。 有关详细信息，请参阅“[管理 codespace 的加密机密](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)。” +Codespaces 用户机密 API 支持用户创建、列出和删除机密（例如云服务的访问令牌）以及将机密分配给用户有权访问的存储库。这些机密在运行时可供 codespace 使用。有关详细信息，请参阅“[管理 codespace 的加密机密](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)。” diff --git a/translations/zh-CN/content/rest/collaborators/invitations.md b/translations/zh-CN/content/rest/collaborators/invitations.md index 8e390c63f65e..9edca5210572 100644 --- a/translations/zh-CN/content/rest/collaborators/invitations.md +++ b/translations/zh-CN/content/rest/collaborators/invitations.md @@ -20,8 +20,8 @@ ms.locfileid: '147065792' --- ## 关于存储库邀请 API -通过存储库邀请 API，可以查看和管理邀请以协作处理存储库。 受邀用户（或代表受邀用户的外部服务）可以选择接受或拒绝邀请。 +通过存储库邀请 API，可以查看和管理邀请以协作处理存储库。受邀用户（或代表受邀用户的外部服务）可以选择接受或拒绝邀请。 -若要将用户添加为协作者，请改用协作者 API。 有关详细信息，请参阅“[添加存储库协作者](/rest/collaborators/collaborators#add-a-repository-collaborator)”。 +若要将用户添加为协作者，请改用协作者 API。有关详细信息，请参阅“[添加存储库协作者](/rest/collaborators/collaborators#add-a-repository-collaborator)”。 请注意，`repo:invite` [OAuth 作用域](/developers/apps/scopes-for-oauth-apps)授予对邀请的目标访问权限，而不授予对存储库代码的访问权限，同时 `repo` 作用域授予对代码和邀请的权限。 diff --git a/translations/zh-CN/content/rest/commits/comments.md b/translations/zh-CN/content/rest/commits/comments.md index 9d47189cc7e2..5daad043c939 100644 --- a/translations/zh-CN/content/rest/commits/comments.md +++ b/translations/zh-CN/content/rest/commits/comments.md @@ -23,7 +23,7 @@ ms.locfileid: '147065344' ### 提交评论的自定义媒体类型 -以下是提交评论支持的媒体类型。 可在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 +以下是提交评论支持的媒体类型。可在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 application/vnd.github-commitcomment.raw+json application/vnd.github-commitcomment.text+json diff --git a/translations/zh-CN/content/rest/commits/commits.md b/translations/zh-CN/content/rest/commits/commits.md index 46d8102fd067..791b69c8a529 100644 --- a/translations/zh-CN/content/rest/commits/commits.md +++ b/translations/zh-CN/content/rest/commits/commits.md @@ -1,6 +1,6 @@ --- title: 提交 -intro: 提交 API 使你能够列出、查看并比较存储库中的提交。 您还可以与提交注释和提交状态进行交互。 +intro: 提交 API 使你能够列出、查看并比较存储库中的提交。您还可以与提交注释和提交状态进行交互。 versions: fpt: '*' ghes: '*' diff --git a/translations/zh-CN/content/rest/commits/index.md b/translations/zh-CN/content/rest/commits/index.md index 67b64f2f31a8..f36df2f13952 100644 --- a/translations/zh-CN/content/rest/commits/index.md +++ b/translations/zh-CN/content/rest/commits/index.md @@ -1,6 +1,6 @@ --- title: 提交 -intro: 提交 API 允许您列出、查看和比较存储库中的提交。 您还可以与提交注释和提交状态进行交互。 +intro: 提交 API 允许您列出、查看和比较存储库中的提交。您还可以与提交注释和提交状态进行交互。 allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/translations/zh-CN/content/rest/commits/statuses.md b/translations/zh-CN/content/rest/commits/statuses.md index 52f4b2dab494..94b1f8fd077d 100644 --- a/translations/zh-CN/content/rest/commits/statuses.md +++ b/translations/zh-CN/content/rest/commits/statuses.md @@ -19,11 +19,11 @@ ms.locfileid: '147882293' --- ## 关于提交状态 API -提交状态 API 允许外部服务将提交标记为 `error`、`failure`、`pending` 或 `success` 状态，然后在涉及这些提交的拉取请求中反映出来。 状态还可以选择包含 `description` 和 `target_url`，强烈建议使用它们，因为它们使状态在 GitHub UI 中更有用。 +提交状态 API 允许外部服务将提交标记为 `error`、`failure`、`pending` 或 `success` 状态，然后在涉及这些提交的拉取请求中反映出来。状态还可以选择包含 `description` 和 `target_url`，强烈建议使用它们，因为它们使状态在 GitHub UI 中更有用。 例如，持续集成服务的一个常见用途是使用状态将提交标记为通过或失败的构建。 `target_url` 将是到构建输出的完整 URL，而 `description` 将是构建过程中发生情况的高级摘要。 -状态可以包括 `context` 以指示提供该状态的服务是什么。 例如，你可以让持续集成服务推送上下文为 `ci` 的状态，让安全审核工具推送上下文为 `security` 的状态。 然后，可以使用[获取组合状态作为特定引用](/rest/reference/commits#get-the-combined-status-for-a-specific-reference)来检索提交的完整状态。 +状态可以包括 `context` 以指示提供该状态的服务是什么。例如，你可以让持续集成服务推送上下文为 `ci` 的状态，让安全审核工具推送上下文为 `security` 的状态。然后，可以使用[获取组合状态作为特定引用](/rest/reference/commits#get-the-combined-status-for-a-specific-reference)来检索提交的完整状态。 请注意，`repo:status` [OAuth 范围](/developers/apps/scopes-for-oauth-apps)授予对状态的目标访问权限，而不授予对存储库代码的访问权限，同时 `repo` 范围授予对代码和状态的权限。 diff --git a/translations/zh-CN/content/rest/dependabot/secrets.md b/translations/zh-CN/content/rest/dependabot/secrets.md index e9ece8b73f54..601854de5b81 100644 --- a/translations/zh-CN/content/rest/dependabot/secrets.md +++ b/translations/zh-CN/content/rest/dependabot/secrets.md @@ -20,4 +20,4 @@ ms.locfileid: '147882285' {% data variables.product.prodname_dependabot %} 机密 API 允许你创建、更新、删除和检索有关加密机密的信息。 {% data reusables.actions.about-secrets %} 有关详细信息，请参阅“[管理 Dependabot 的加密机密](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)”。 -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} 必须具有 `dependabot_secrets` 权限才可使用此 API。 经过身份验证的用户必须对仓库具有协作者权限才可创建、更新或读取密码。 +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} 必须具有 `dependabot_secrets` 权限才可使用此 API。经过身份验证的用户必须对仓库具有协作者权限才可创建、更新或读取密码。 diff --git a/translations/zh-CN/content/rest/dependency-graph/dependency-review.md b/translations/zh-CN/content/rest/dependency-graph/dependency-review.md index 5c77e4633d78..d04286cad686 100644 --- a/translations/zh-CN/content/rest/dependency-graph/dependency-review.md +++ b/translations/zh-CN/content/rest/dependency-graph/dependency-review.md @@ -21,4 +21,4 @@ ms.locfileid: '147064872' {% data reusables.dependency-review.dependency-review-api-beta-note %} -通过依赖项审查 API，你可以在将这些更改添加到环境之前了解依赖项更改以及这些更改的安全影响。 可以查看存储库的两次提交之间的依赖项差异，包括具有已知漏洞的任何版本更新的漏洞数据。 有关依赖项审查的详细信息，请参阅“[关于依赖项审查](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)”。 +通过依赖项审查 API，你可以在将这些更改添加到环境之前了解依赖项更改以及这些更改的安全影响。可以查看存储库的两次提交之间的依赖项差异，包括具有已知漏洞的任何版本更新的漏洞数据。有关依赖项审查的详细信息，请参阅“[关于依赖项审查](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)”。 diff --git a/translations/zh-CN/content/rest/dependency-graph/dependency-submission.md b/translations/zh-CN/content/rest/dependency-graph/dependency-submission.md index d2f6e2ea1826..ddc24843539a 100644 --- a/translations/zh-CN/content/rest/dependency-graph/dependency-submission.md +++ b/translations/zh-CN/content/rest/dependency-graph/dependency-submission.md @@ -17,6 +17,6 @@ ms.locfileid: '147079889' {% data reusables.dependency-submission.about-dependency-submission %} -依赖项以快照的形式提交到依赖项提交 API。 快照是一组与提交 SHA 和其他元数据关联的依赖项，反映提交存储库的当前状态。 可以选择使用预先创建的操作，或创建自己的操作，以在每次生成项目时，以所需的格式将依赖项提交到依赖项提交 API。 有关使用依赖项提交 API 的详细信息，请参阅“[使用依赖项提交 API](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)”。 +依赖项以快照的形式提交到依赖项提交 API。快照是一组与提交 SHA 和其他元数据关联的依赖项，反映提交存储库的当前状态。可以选择使用预先创建的操作，或创建自己的操作，以在每次生成项目时，以所需的格式将依赖项提交到依赖项提交 API。有关使用依赖项提交 API 的详细信息，请参阅“[使用依赖项提交 API](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)”。 -可以将多个依赖项集提交到依赖项提交 API，以包含在依赖项关系图中。 API 使用快照的 `job.correlator` 属性和 `detector.name` 类别来确保显示每个工作流的最新提交。 属性 `correlator` 本身是用于保持独立提交不同的主要字段。 例如 `correlator` 可以是操作运行中两个可用变量的简单组合：` `。 +可以将多个依赖项集提交到依赖项提交 API，以包含在依赖项关系图中。API 使用快照的 `job.correlator` 属性和 `detector.name` 类别来确保显示每个工作流的最新提交。属性 `correlator` 本身是用于保持独立提交不同的主要字段。例如 `correlator` 可以是操作运行中两个可用变量的简单组合：` `。 diff --git a/translations/zh-CN/content/rest/deploy-keys.md b/translations/zh-CN/content/rest/deploy-keys.md index cec867541758..d8de81df4c11 100644 --- a/translations/zh-CN/content/rest/deploy-keys.md +++ b/translations/zh-CN/content/rest/deploy-keys.md @@ -23,4 +23,4 @@ ms.locfileid: '147060073' {% data reusables.repositories.deploy-keys %} -部署密钥可以使用以下 API 端点进行设置，也可以使用 GitHub 进行设置。 若要了解如何在 GitHub 中设置部署密钥，请参阅“[管理部署密钥](/developers/overview/managing-deploy-keys)。” +部署密钥可以使用以下 API 端点进行设置，也可以使用 GitHub 进行设置。若要了解如何在 GitHub 中设置部署密钥，请参阅“[管理部署密钥](/developers/overview/managing-deploy-keys)。” diff --git a/translations/zh-CN/content/rest/deployments/branch-policies.md b/translations/zh-CN/content/rest/deployments/branch-policies.md index 9f0ed245ac5c..cca5ccf79ca1 100644 --- a/translations/zh-CN/content/rest/deployments/branch-policies.md +++ b/translations/zh-CN/content/rest/deployments/branch-policies.md @@ -20,6 +20,6 @@ ms.locfileid: '147549109' --- ## 关于部署分支策略 API -使用部署分支策略 API 可以指定分支必须匹配才能部署到环境的自定义名称模式。 环境的 `deployment_branch_policy.custom_branch_policies` 属性必须设置为 `true` 才能使用这些终结点。 若要更新环境的 `deployment_branch_policy`，请参阅“[创建或更新环境](/rest/deployments/environments#create-or-update-an-environment)”。 +使用部署分支策略 API 可以指定分支必须匹配才能部署到环境的自定义名称模式。环境的 `deployment_branch_policy.custom_branch_policies` 属性必须设置为 `true` 才能使用这些终结点。若要更新环境的 `deployment_branch_policy`，请参阅“[创建或更新环境](/rest/deployments/environments#create-or-update-an-environment)”。 有关将环境部署限制为某些分支的详细信息，请参阅“[使用环境进行部署](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)”。 diff --git a/translations/zh-CN/content/rest/deployments/deployments.md b/translations/zh-CN/content/rest/deployments/deployments.md index 072df702ab09..92f73a7885b1 100644 --- a/translations/zh-CN/content/rest/deployments/deployments.md +++ b/translations/zh-CN/content/rest/deployments/deployments.md @@ -18,13 +18,13 @@ ms.locfileid: '147067960' --- ## 关于部署 API -部署是部署特定引用（分支、SHA、标记）的请求。 GitHub 分派一个 [`deployment` 事件](/developers/webhooks-and-events/webhook-events-and-payloads#deployment)，外部服务可以在创建新部署时侦听该事件并采取行动。 部署使开发者和组织能够围绕部署构建松散耦合的工具，而不必担心交付不同类型的应用程序（例如 Web 和本地应用程序）的实现细节。 +部署是部署特定引用（分支、SHA、标记）的请求。GitHub 分派一个 [`deployment` 事件](/developers/webhooks-and-events/webhook-events-and-payloads#deployment)，外部服务可以在创建新部署时侦听该事件并采取行动。部署使开发者和组织能够围绕部署构建松散耦合的工具，而不必担心交付不同类型的应用程序（例如 Web 和本地应用程序）的实现细节。 部署状态允许外部服务使用 `error`、`failure`、`pending`、`in_progress`、`queued` 或 `success` 状态来标记部署，以便系统侦听 [`deployment_status` 事件](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status)消耗。 部署状态还可以包括可选的 `description` 和 `log_url`，强烈建议使用它们，因为它们使部署状态更有用。 `log_url` 是部署输出的完整 URL，`description` 是部署所发生情况的高级摘要。 -GitHub 在创建新部署和部署状态时调度 `deployment` 和 `deployment_status` 事件。 这些事件允许第三方集成接收对部署请求的响应，并在取得进展时更新部署的状态。 +GitHub 在创建新部署和部署状态时调度 `deployment` 和 `deployment_status` 事件。这些事件允许第三方集成接收对部署请求的响应，并在取得进展时更新部署的状态。 下面是一个说明这些交互的工作方式的简单序列图。 @@ -55,12 +55,12 @@ GitHub 在创建新部署和部署状态时调度 `deployment` 和 `deployment_s | | | | ``` -请记住，GitHub 从未真正访问过您的服务器。 与部署事件的交互取决于第三方集成。 多个系统可以侦听部署事件，由其中每个系统来决定它们是否负责将代码推送到服务器、构建本地代码等。 +请记住，GitHub 从未真正访问过您的服务器。与部署事件的交互取决于第三方集成。多个系统可以侦听部署事件，由其中每个系统来决定它们是否负责将代码推送到服务器、构建本地代码等。 请注意，`repo_deployment` [OAuth 范围](/developers/apps/scopes-for-oauth-apps) 授予对部署和部署状态的目标访问权限而不授予对存储库代码的访问权限，而 {% ifversion not ghae %}`public_repo` 和{% endif %}`repo` 范围也授予对代码的权限。 ### 非活动部署 -当你将部署的状态设置为 `success` 时，同一存储库中具有相同环境名称的所有先前非瞬态、非生产环境部署将变为 `inactive`。 为避免这种情况，你可以在创建部署状态时将 `auto_inactive` 设置为 `false`。 +当你将部署的状态设置为 `success` 时，同一存储库中具有相同环境名称的所有先前非瞬态、非生产环境部署将变为 `inactive`。为避免这种情况，你可以在创建部署状态时将 `auto_inactive` 设置为 `false`。 -可以通过将其 `state` 设置为 `inactive` 来传达瞬态环境不再存在。 将 `state` 设置为 `inactive` 会在 {% data variables.product.prodname_dotcom %} 中将部署显示为 `destroyed` 并删除对其的访问权限。 +可以通过将其 `state` 设置为 `inactive` 来传达瞬态环境不再存在。将 `state` 设置为 `inactive` 会在 {% data variables.product.prodname_dotcom %} 中将部署显示为 `destroyed` 并删除对其的访问权限。 diff --git a/translations/zh-CN/content/rest/deployments/environments.md b/translations/zh-CN/content/rest/deployments/environments.md index 70463a5ad2d4..8a6733e8c4ad 100644 --- a/translations/zh-CN/content/rest/deployments/environments.md +++ b/translations/zh-CN/content/rest/deployments/environments.md @@ -20,6 +20,6 @@ ms.locfileid: '147066376' --- ## 关于部署环境 API -有关环境的详细信息，请参阅“[使用环境进行部署](/actions/deployment/using-environments-for-deployment)”。 若要管理环境机密，请参阅“[机密](/rest/reference/actions#secrets)”。 +有关环境的详细信息，请参阅“[使用环境进行部署](/actions/deployment/using-environments-for-deployment)”。若要管理环境机密，请参阅“[机密](/rest/reference/actions#secrets)”。 {% data reusables.gated-features.environments %} diff --git a/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md b/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md index 4f0a9705a50e..862199944405 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md +++ b/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md @@ -16,4 +16,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147060041' --- -它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `404` 响应。 +它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `404` 响应。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/announcement.md b/translations/zh-CN/content/rest/enterprise-admin/announcement.md index 0ccd1c9da83e..9b99d8fc71d2 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/announcement.md +++ b/translations/zh-CN/content/rest/enterprise-admin/announcement.md @@ -16,4 +16,4 @@ ms.locfileid: '147883017' --- ## 公告 -公告 API 允许您管理企业中的全局公告横幅。 有关详细信息，请参阅“[为企业自定义用户消息](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)”。 +公告 API 允许您管理企业中的全局公告横幅。有关详细信息，请参阅“[为企业自定义用户消息](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)”。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md b/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md index 5c90ea5f85a0..7408ba9de870 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md +++ b/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md @@ -1,6 +1,6 @@ --- title: 全局 Webhook -intro: 全局 Webhook 安装在企业上。 您可以使用全局 web 挂钩来自动监视、响应或实施针对企业上的用户、组织、团队和仓库的规则。 +intro: 全局 Webhook 安装在企业上。您可以使用全局 web 挂钩来自动监视、响应或实施针对企业上的用户、组织、团队和仓库的规则。 versions: ghes: '*' ghae: '*' @@ -16,4 +16,4 @@ ms.locfileid: '147067224' --- 全局 Webhook 可以订阅[组织](/developers/webhooks-and-events/webhook-events-and-payloads#organization)、[用户](/developers/webhooks-and-events/webhook-events-and-payloads#user)、[存储库](/developers/webhooks-and-events/webhook-events-and-payloads#repository)、[团队](/developers/webhooks-and-events/webhook-events-and-payloads#team)、[成员](/developers/webhooks-and-events/webhook-events-and-payloads#member)、[成员身份](/developers/webhooks-and-events/webhook-events-and-payloads#membership)、[分支](/developers/webhooks-and-events/webhook-events-and-payloads#fork)和 [ping](/developers/webhooks-and-events/about-webhooks#ping-event) 事件类型。 -此 API 仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `404` 响应。 若要了解如何配置全局 Webhook，请参阅[关于全局 Webhook](/enterprise/admin/user-management/about-global-webhooks)。 +此 API 仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `404` 响应。若要了解如何配置全局 Webhook，请参阅[关于全局 Webhook](/enterprise/admin/user-management/about-global-webhooks)。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/index.md b/translations/zh-CN/content/rest/enterprise-admin/index.md index cef2d950094e..8325f14fe14e 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/index.md +++ b/translations/zh-CN/content/rest/enterprise-admin/index.md @@ -42,7 +42,7 @@ ms.locfileid: '147065591' {% note %} -注意：本文章适用于 {% data variables.product.prodname_ghe_cloud %}。 要查看 {% data variables.product.prodname_ghe_managed %} 或 {% data variables.product.prodname_ghe_server %} 版本，请使用 {% data ui.pages.article_version %} 下拉菜单。 +注意：本文章适用于 {% data variables.product.prodname_ghe_cloud %}。要查看 {% data variables.product.prodname_ghe_managed %} 或 {% data variables.product.prodname_ghe_server %} 版本，请使用 {% data ui.pages.article_version %} 下拉菜单。 {% endnote %} @@ -56,7 +56,7 @@ REST API 终结点{% ifversion ghes %}（[管理控制台](#management-console) {% data variables.product.api_url_pre %} ``` -{% ifversion fpt or ghec %} 当终结点包含 `{enterprise}` 时，将 `{enterprise}` 替换为企业帐户的句柄，该句柄包含在企业设置的 URL 中。 例如，如果企业帐户位于 `https://github.com/enterprises/octo-enterprise`，请用 `octo-enterprise` 替换 `{enterprise}`。 +{% ifversion fpt or ghec %} 当终结点包含 `{enterprise}` 时，将 `{enterprise}` 替换为企业帐户的句柄，该句柄包含在企业设置的 URL 中。例如，如果企业帐户位于 `https://github.com/enterprises/octo-enterprise`，请用 `octo-enterprise` 替换 `{enterprise}`。 {% endif %} {% ifversion ghes %} [管理控制台](#management-console) API 终结点仅以主机名为前缀： @@ -67,7 +67,7 @@ http(s)://hostname/ {% endif %} {% ifversion ghae or ghes %} ### 身份验证 -{% data variables.product.product_name %} 安装的 API 终结点接受与 GitHub.com API [相同的身份验证方法](/rest/overview/resources-in-the-rest-api#authentication)。 可通过 [OAuth 标记](/apps/building-integrations/setting-up-and-registering-oauth-apps/){% ifversion ghes %}（可使用[授权 API](/rest/reference/oauth-authorizations#create-a-new-authorization) 创建）{% endif %}或[基本身份验证](/rest/overview/resources-in-the-rest-api#basic-authentication)自行进行身份验证 。 {% ifversion ghes %} OAuth 标记用于企业特定的终结点时必须具有 `site_admin` [OAuth 范围](/developers/apps/scopes-for-oauth-apps#available-scopes)。{% endif %} +{% data variables.product.product_name %} 安装的 API 终结点接受与 GitHub.com API [相同的身份验证方法](/rest/overview/resources-in-the-rest-api#authentication)。可通过 [OAuth 标记](/apps/building-integrations/setting-up-and-registering-oauth-apps/){% ifversion ghes %}（可使用[授权 API](/rest/reference/oauth-authorizations#create-a-new-authorization) 创建）{% endif %}或[基本身份验证](/rest/overview/resources-in-the-rest-api#basic-authentication)自行进行身份验证。 {% ifversion ghes %} OAuth 标记用于企业特定的终结点时必须具有 `site_admin` [OAuth 范围](/developers/apps/scopes-for-oauth-apps#available-scopes)。{% endif %} 企业管理 API 终结点只有经过身份验证的 {% data variables.product.product_name %} 站点管理员{% ifversion ghes %}可以访问，但[管理控制台](#management-console) API 例外，它需要[管理控制台密码](/enterprise/admin/articles/accessing-the-management-console/){% endif %}。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/ldap.md b/translations/zh-CN/content/rest/enterprise-admin/ldap.md index d420968694d0..98ba717ea1e3 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/ldap.md +++ b/translations/zh-CN/content/rest/enterprise-admin/ldap.md @@ -13,4 +13,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147065336' --- -通过 LDAP 映射端点，您可以更新用户或团队所映射的识别名称 (DN) 。 请注意，仅当 {% data variables.product.product_name %} 设备 [启用了 LDAP 同步](/enterprise/admin/authentication/using-ldap)时，LDAP 终结点通常才有效。 即使已禁用 LDAP 同步，也可以在启用 LDAP 后使用[为用户更新 LDAP 映射](#update-ldap-mapping-for-a-user)终结点。 +通过 LDAP 映射端点，您可以更新用户或团队所映射的识别名称 (DN) 。请注意，仅当 {% data variables.product.product_name %} 设备 [启用了 LDAP 同步](/enterprise/admin/authentication/using-ldap)时，LDAP 终结点通常才有效。即使已禁用 LDAP 同步，也可以在启用 LDAP 后使用[为用户更新 LDAP 映射](#update-ldap-mapping-for-a-user)终结点。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/license.md b/translations/zh-CN/content/rest/enterprise-admin/license.md index 82dd5a59cfb0..fc3517f2a094 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/license.md +++ b/translations/zh-CN/content/rest/enterprise-admin/license.md @@ -15,4 +15,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147572646' --- -它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `404` 响应。 +它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `404` 响应。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/management-console.md b/translations/zh-CN/content/rest/enterprise-admin/management-console.md index db362a06d073..58a532a85a6a 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/management-console.md +++ b/translations/zh-CN/content/rest/enterprise-admin/management-console.md @@ -15,7 +15,7 @@ ms.locfileid: '147065536' --- {% tip %} -在对管理控制台进行 API 调用时，必须明确设置端口号。 如果企业启用了 TLS，则端口号为 `8443`；否则，端口号为 `8080`。 +在对管理控制台进行 API 调用时，必须明确设置端口号。如果企业启用了 TLS，则端口号为 `8443`；否则，端口号为 `8080`。 如果您不想提供端口号，则需要将工具配置为自动遵循重定向。 @@ -27,13 +27,13 @@ ms.locfileid: '147065536' 需要将[管理控制台密码](/enterprise/admin/articles/accessing-the-management-console/)作为身份验证令牌传递给除 [`/setup/api/start`](#create-a-github-enterprise-server-license) 之外的每个管理控制台 API 终结点。 -使用 `api_key` 参数在每个请求中发送此令牌。 例如： +使用 `api_key` 参数在每个请求中发送此令牌。例如： ```shell $ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' ``` -还可以使用标准 HTTP 身份验证发送此令牌。 例如： +还可以使用标准 HTTP 身份验证发送此令牌。例如： ```shell $ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' diff --git a/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md b/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md index 5ed0e29c8bdc..dcdc841cb84d 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md +++ b/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -25,4 +25,4 @@ ms.locfileid: '147063960' 强制执行的可能值为 `enabled`、`disabled` 和 `testing`。 `disabled` 表示预接收挂钩不会运行。 `enabled` 表示它将运行并拒绝任何导致非零状态的推送。 `testing` 表示脚本将运行但不会导致任何推送被拒绝。 -`configuration_url` 可能是指向此终结点或此挂钩的全局配置的链接。 只有站点管理员才能访问全局配置。 +`configuration_url` 可能是指向此终结点或此挂钩的全局配置的链接。只有站点管理员才能访问全局配置。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/orgs.md b/translations/zh-CN/content/rest/enterprise-admin/orgs.md index d74918c0a924..51940a4ab12c 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/orgs.md +++ b/translations/zh-CN/content/rest/enterprise-admin/orgs.md @@ -15,4 +15,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147061960' --- -它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `404` 响应。 +它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `404` 响应。 diff --git a/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md index 0bf4f54a0532..7847acbe9946 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md +++ b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md @@ -14,7 +14,7 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/11/2022 ms.locfileid: '147883260' --- -它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `404` 响应。 +它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `404` 响应。 ### 对象属性 diff --git a/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md index 6304bd246745..78bc45d0caec 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md +++ b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md @@ -13,7 +13,7 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/10/2022 ms.locfileid: '147066152' --- -它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `404` 响应。 +它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `404` 响应。 ### 对象属性 diff --git a/translations/zh-CN/content/rest/enterprise-admin/users.md b/translations/zh-CN/content/rest/enterprise-admin/users.md index f5a68de06394..aac4cfdaa409 100644 --- a/translations/zh-CN/content/rest/enterprise-admin/users.md +++ b/translations/zh-CN/content/rest/enterprise-admin/users.md @@ -14,4 +14,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147063168' --- -它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。 如果普通用户尝试访问它，他们将收到 `403` 响应。 +它仅适用于[经过身份验证的](/rest/overview/resources-in-the-rest-api#authentication)网站管理员。如果普通用户尝试访问它，他们将收到 `403` 响应。 diff --git a/translations/zh-CN/content/rest/gists/comments.md b/translations/zh-CN/content/rest/gists/comments.md index b00fc26d3150..c9c9493e808f 100644 --- a/translations/zh-CN/content/rest/gists/comments.md +++ b/translations/zh-CN/content/rest/gists/comments.md @@ -20,7 +20,7 @@ ms.locfileid: '147067530' --- ## 关于 Gist 评论 API -通过 Gist 评论 API，可以查看和修改 Gist 上的评论。 有关 Gist 的详细信息，请参阅“[使用 Gist 编辑和共享内容](/get-started/writing-on-github/editing-and-sharing-content-with-gists)”。 +通过 Gist 评论 API，可以查看和修改 Gist 上的评论。有关 Gist 的详细信息，请参阅“[使用 Gist 编辑和共享内容](/get-started/writing-on-github/editing-and-sharing-content-with-gists)”。 ### Gist 评论的自定义媒体类型 diff --git a/translations/zh-CN/content/rest/gists/gists.md b/translations/zh-CN/content/rest/gists/gists.md index 19330a50e2dd..8f3433dd3c10 100644 --- a/translations/zh-CN/content/rest/gists/gists.md +++ b/translations/zh-CN/content/rest/gists/gists.md @@ -18,21 +18,21 @@ ms.locfileid: '145129085' --- ## 关于 Gist API -通过 Gist API，可以查看和修改 Gist。 有关 Gist 的详细信息，请参阅“[使用 Gist 编辑和共享内容](/get-started/writing-on-github/editing-and-sharing-content-with-gists)”。 +通过 Gist API，可以查看和修改 Gist。有关 Gist 的详细信息，请参阅“[使用 Gist 编辑和共享内容](/get-started/writing-on-github/editing-and-sharing-content-with-gists)”。 ### 身份验证 -可以匿名读取公共 Gist {% ifversion ghae or ghes %}并为没有令牌的匿名用户创建它们。{% else %}，但是必须要登录到 GitHub 才能创建 Gist。{% endif %}要代表用户读取或写入 Gist，需要 Gist OAuth 作用域和令牌。 有关详细信息，请参阅“[OAuth 应用的作用域](/developers/apps/scopes-for-oauth-apps)”。 +可以匿名读取公共 Gist {% ifversion ghae or ghes %}并为没有令牌的匿名用户创建它们。{% else %}，但是必须要登录到 GitHub 才能创建 Gist。{% endif %}要代表用户读取或写入 Gist，需要 Gist OAuth 作用域和令牌。有关详细信息，请参阅“[OAuth 应用的作用域](/developers/apps/scopes-for-oauth-apps)”。 ### 截断 -Gist API 为 Gist 中的每个文件提供最多一兆字节的内容。 通过 API 为 Gist 返回的每个文件都有一个名为 `truncated` 的密钥。 如果 `truncated` 是 `true`，则文件太大，仅返回了 `content` 部分内容。 +Gist API 为 Gist 中的每个文件提供最多一兆字节的内容。通过 API 为 Gist 返回的每个文件都有一个名为 `truncated` 的密钥。如果 `truncated` 是 `true`，则文件太大，仅返回了 `content` 部分内容。 -如果需要文件的完整内容，可以向 `raw_url` 指定的 URL 发出 `GET` 请求。 请注意，对于超过十兆字节的文件，需要通过 `git_pull_url` 提供的 URL 克隆 Gist。 +如果需要文件的完整内容，可以向 `raw_url` 指定的 URL 发出 `GET` 请求。请注意，对于超过十兆字节的文件，需要通过 `git_pull_url` 提供的 URL 克隆 Gist。 -除了特定文件的内容被截断外，如果文件总数超过 300 个，则整个文件列表也可能被截断。 如果顶层 `truncated` 键为 `true`，则仅返回文件列表中的前 300 个文件。 如果需要获取 Gist 的所有文件，需要通过 `git_pull_url` 提供的 URL 克隆 Gist。 +除了特定文件的内容被截断外，如果文件总数超过 300 个，则整个文件列表也可能被截断。如果顶层 `truncated` 键为 `true`，则仅返回文件列表中的前 300 个文件。如果需要获取 Gist 的所有文件，需要通过 `git_pull_url` 提供的 URL 克隆 Gist。 ### Gist 的自定义媒体类型 diff --git a/translations/zh-CN/content/rest/git/blobs.md b/translations/zh-CN/content/rest/git/blobs.md index 68f05d18f229..1c0258209db2 100644 --- a/translations/zh-CN/content/rest/git/blobs.md +++ b/translations/zh-CN/content/rest/git/blobs.md @@ -20,7 +20,7 @@ ms.locfileid: '147060616' --- ## 关于 Git Blob API -Git Blob（二进制大对象）是用于将每个文件的内容存储在仓库中的对象类型。 文件的 SHA-1 哈希在 Blob 对象中计算和存储。 通过这些终结点，可以在 {% data variables.product.product_name %} 上读取 [blob 对象](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects)并将其写入 Git 数据库。 Blob 利用[这些自定义媒体类型](#custom-media-types-for-blobs)。 你可以在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 +Git Blob（二进制大对象）是用于将每个文件的内容存储在仓库中的对象类型。文件的 SHA-1 哈希在 Blob 对象中计算和存储。通过这些终结点，可以在 {% data variables.product.product_name %} 上读取 [blob 对象](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects)并将其写入 Git 数据库。Blob 利用[这些自定义媒体类型](#custom-media-types-for-blobs)。你可以在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 ### Blob 的自定义媒体类型 diff --git a/translations/zh-CN/content/rest/git/commits.md b/translations/zh-CN/content/rest/git/commits.md index 64690e1efe79..6f64a05b94a4 100644 --- a/translations/zh-CN/content/rest/git/commits.md +++ b/translations/zh-CN/content/rest/git/commits.md @@ -20,4 +20,4 @@ ms.locfileid: '147063480' --- ## 关于 Git 提交 API -Git 提交是层次结构（[Git 树](/rest/reference/git#trees)）和 Git 存储库中文件内容 ([Git blob](/rest/reference/git#blobs)) 的快照。 通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[提交对象](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects)并将其写入 Git 数据库。 +Git 提交是层次结构（[Git 树](/rest/reference/git#trees)）和 Git 存储库中文件内容 ([Git blob](/rest/reference/git#blobs)) 的快照。通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[提交对象](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects)并将其写入 Git 数据库。 diff --git a/translations/zh-CN/content/rest/git/index.md b/translations/zh-CN/content/rest/git/index.md index c771f1fb99f6..24be69042dac 100644 --- a/translations/zh-CN/content/rest/git/index.md +++ b/translations/zh-CN/content/rest/git/index.md @@ -26,4 +26,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/11/2022 ms.locfileid: '147882277' --- -Git 数据库 API 使您能够在 {% data variables.product.product_name %} 上的 Git 数据库中读取和写入原始 Git 对象，并列出和更新您的引用（分支头部和标记）。 有关使用 Git 数据库 API 的详细信息，请参阅 [Git 数据 API 入门](/rest/guides/getting-started-with-the-git-database-api)。 +Git 数据库 API 使您能够在 {% data variables.product.product_name %} 上的 Git 数据库中读取和写入原始 Git 对象，并列出和更新您的引用（分支头部和标记）。有关使用 Git 数据库 API 的详细信息，请参阅 [Git 数据 API 入门](/rest/guides/getting-started-with-the-git-database-api)。 diff --git a/translations/zh-CN/content/rest/git/refs.md b/translations/zh-CN/content/rest/git/refs.md index 4a1663ed2c91..76c842dba776 100644 --- a/translations/zh-CN/content/rest/git/refs.md +++ b/translations/zh-CN/content/rest/git/refs.md @@ -20,4 +20,4 @@ ms.locfileid: '147093052' --- ## 关于 Git 引用 API -Git 引用 (`git ref`) 是一个包含 Git 提交 SHA-1 哈希的文件。 当引用 Git 提交时，你可以使用 Git 引用，与哈希相比这是一个易于记住的名称。 可以重写 Git 引用指向新的提交。 分支是存储新 Git 提交哈希的 Git 引用。 通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[引用](https://git-scm.com/book/en/v1/Git-Internals-Git-References)并将其写入 Git 数据库。 +Git 引用 (`git ref`) 是一个包含 Git 提交 SHA-1 哈希的文件。当引用 Git 提交时，你可以使用 Git 引用，与哈希相比这是一个易于记住的名称。可以重写 Git 引用指向新的提交。分支是存储新 Git 提交哈希的 Git 引用。通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[引用](https://git-scm.com/book/en/v1/Git-Internals-Git-References)并将其写入 Git 数据库。 diff --git a/translations/zh-CN/content/rest/git/tags.md b/translations/zh-CN/content/rest/git/tags.md index 90d4c61adced..0581b7afc53b 100644 --- a/translations/zh-CN/content/rest/git/tags.md +++ b/translations/zh-CN/content/rest/git/tags.md @@ -20,4 +20,4 @@ ms.locfileid: '145129070' --- ## 关于 Git 标记 API -Git 标记类似于 [Git 引用](/rest/reference/git#refs)，但它指向的 Git 提交永远不会更改。 当您想要指向特定发行版时，Git 标记非常有用。 通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[标记对象](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags)并将其写入 Git 数据库。 Git 标记 API 仅支持[带批注的标记对象](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags)，不支持轻量级标记。 +Git 标记类似于 [Git 引用](/rest/reference/git#refs)，但它指向的 Git 提交永远不会更改。当您想要指向特定发行版时，Git 标记非常有用。通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[标记对象](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags)并将其写入 Git 数据库。Git 标记 API 仅支持[带批注的标记对象](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags)，不支持轻量级标记。 diff --git a/translations/zh-CN/content/rest/git/trees.md b/translations/zh-CN/content/rest/git/trees.md index 04d9345e8a46..cbe7a884395f 100644 --- a/translations/zh-CN/content/rest/git/trees.md +++ b/translations/zh-CN/content/rest/git/trees.md @@ -2,7 +2,7 @@ title: Git 树 shortTitle: Trees allowTitleToDifferFromFilename: true -intro: '通过Git 树 API，可以在 {% data variables.product.product_name %} 上读取树对象并将其写入 Git 数据库。' +intro: '通过 Git 树 API，可以在 {% data variables.product.product_name %} 上读取树对象并将其写入 Git 数据库。' versions: fpt: '*' ghes: '*' @@ -20,4 +20,4 @@ ms.locfileid: '147884467' --- ## 关于 Git 树 API -Git 树对象在 Git 仓库中的文件之间创建层次结构。 您可以使用 Git 树对象创建目录与其包含的文件之间的关系。 通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[树对象](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects)并将其写入 Git 数据库。 +Git 树对象在 Git 仓库中的文件之间创建层次结构。您可以使用 Git 树对象创建目录与其包含的文件之间的关系。通过这些终结点，可以在 {% data variables.product.product_name %} 上读取[树对象](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects)并将其写入 Git 数据库。 diff --git a/translations/zh-CN/content/rest/guides/basics-of-authentication.md b/translations/zh-CN/content/rest/guides/basics-of-authentication.md index ad83351f06c8..17d06559c4c7 100644 --- a/translations/zh-CN/content/rest/guides/basics-of-authentication.md +++ b/translations/zh-CN/content/rest/guides/basics-of-authentication.md @@ -19,7 +19,7 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/12/2022 ms.locfileid: '147887316' --- -在本节中，我们将重点介绍身份验证的基础知识。 具体而言，我们将（使用 [Sinatra][Sinatra]）创建 Ruby 服务器，该服务器以多种不同的方式实现应用程序的 [Web 流][webflow]。 +在本节中，我们将重点介绍身份验证的基础知识。具体而言，我们将（使用 [Sinatra][Sinatra]）创建 Ruby 服务器，该服务器以多种不同的方式实现应用程序的 [Web 流][webflow]。 {% tip %} @@ -29,18 +29,18 @@ ms.locfileid: '147887316' ## 注册应用程序 -首先需要[注册应用程序][new oauth app]。 每个注册的 OAuth 应用程序都分配有一个唯一的客户端 ID 和客户端密码。 -不应共享客户端密钥！ 这包括将该字符串签入存储库。 +首先需要 [注册应用程序][new oauth app]。每个注册的 OAuth 应用程序都分配有一个唯一的客户端 ID 和客户端密码。 +不应共享客户端密钥！这包括将该字符串签入存储库。 -可以随意填写每条信息，但授权回叫 URL 除外。 这往往是设置应用程序中最重要的部分。 它是在身份验证成功后，{% data variables.product.product_name %} 将用户返回到的回叫 URL。 +可以随意填写每条信息，但授权回叫 URL 除外。这往往是设置应用程序中最重要的部分。它是在身份验证成功后，{% data variables.product.product_name %} 将用户返回到的回叫 URL。 -由于我们运行的是常规 Sinatra 服务器，因此本地实例的位置设置为 `http://127.0.0.1:4567`。 让我们将回叫 URL 填写为 `http://127.0.0.1:4567/callback`。 +由于我们运行的是常规 Sinatra 服务器，因此本地实例的位置设置为 `http://127.0.0.1:4567`。让我们将回叫 URL 填写为 `http://127.0.0.1:4567/callback`。 ## 接受用户授权 {% data reusables.apps.deprecating_auth_with_query_parameters %} -现在开始设置我们简单的服务器。 创建名为 server.rb 的文件，并将其粘贴到其中： +现在开始设置我们简单的服务器。创建名为 server.rb 的文件，并将其粘贴到其中： ``` ruby require 'sinatra' @@ -55,7 +55,7 @@ get '/' do end ``` -客户端 ID 和客户端密钥来自[应用程序的配置页][app settings]。{% ifversion fpt or ghec %} 永远不应将这些值存储在 {% data variables.product.product_name %} 中或任何其他公共位置。{% endif %} 我们建议将它们存储为[环境变量][about env vars] - 这正是我们在这里所做的。 +客户端 ID 和客户端密钥来自 [应用程序的配置页][app settings]。{% ifversion fpt or ghec %} 永远不应将这些值存储在 {% data variables.product.product_name %} 中或任何其他公共位置。{% endif %} 我们建议将它们存储为 [环境变量][about env vars] - 这正是我们在这里所做的。 接下来，在 views/index.erb 中粘贴此内容： @@ -80,13 +80,13 @@ end （如果你不熟悉 Sinatra 的工作原理，建议你阅读 [Sinatra 指南][Sinatra guide]。） -另请注意，URL 使用 `scope` 查询参数来定义应用程序请求的[范围][oauth scopes]。 对于我们的应用程序，我们请求 `user:email` 范围来读取私人电子邮件地址。 +另请注意，URL 使用 `scope` 查询参数来定义应用程序请求的 [范围][oauth scopes]。对于我们的应用程序，我们请求 `user:email` 范围来读取私人电子邮件地址。 -将浏览器导航到 `http://127.0.0.1:4567`。 单击链接后，应该会转到 {% data variables.product.product_name %}，并显示如下所示的对话框：![GitHub 的 OAuth 提示](/assets/images/oauth_prompt.png) +将浏览器导航到 `http://127.0.0.1:4567`。单击链接后，应该会转到 {% data variables.product.product_name %}，并显示如下所示的对话框：![GitHub 的 OAuth 提示](/assets/images/oauth_prompt.png) -如果你相信自己，请单击“授权应用”。 哇！ Sinatra 显示 `404` 错误。 是什么原因呢？ +如果你相信自己，请单击“授权应用”。哇！Sinatra 显示 `404` 错误。是什么原因呢？ -还记得我们何时将回叫 URL 指定为了 `callback` 吗？ 我们没有为它提供路由，因此 {% data variables.product.product_name %} 在用户授权应用后不知道将他们放置在什么位置。 现在我们来解决这个问题！ +还记得我们何时将回叫 URL 指定为了 `callback` 吗？我们没有为它提供路由，因此 {% data variables.product.product_name %} 在用户授权应用后不知道将他们放置在什么位置。现在我们来解决这个问题！ ### 提供回调 @@ -112,11 +112,11 @@ end 在应用成功完成身份验证后，{% data variables.product.product_name %} 将提供一个临时的 `code` 值。 需要将此代码 `POST` 回 {% data variables.product.product_name %} 以换取 `access_token`。 为了简化 GET 和 POST HTTP 请求，我们将使用 [rest-client][REST Client]。 -请注意，您可能永远不会通过 REST 访问 API。 对于更重要的应用程序，可能应该使用[采用所选语言编写的库][libraries]。 +请注意，您可能永远不会通过 REST 访问 API。对于更重要的应用程序，可能应该使用 [采用所选语言编写的库][libraries]。 ### 检查授予的作用域 -用户可以通过直接更改 URL 来编辑您请求的范围。 这可以授予您的应用程序比您最初请求的更少的访问权限。 因此，在使用令牌发出任何请求之前，您应该检查用户为令牌授予的作用域。 有关请求的范围和已授予的范围的详细信息，请参阅“[OAuth 应用的范围](/developers/apps/scopes-for-oauth-apps#requested-scopes-and-granted-scopes)”。 +用户可以通过直接更改 URL 来编辑您请求的范围。这可以授予您的应用程序比您最初请求的更少的访问权限。因此，在使用令牌发出任何请求之前，您应该检查用户为令牌授予的作用域。有关请求的范围和已授予的范围的详细信息，请参阅“[OAuth 应用的范围](/developers/apps/scopes-for-oauth-apps#requested-scopes-and-granted-scopes)”。 已授予的范围作为交换令牌的响应的一部分返回。 @@ -132,15 +132,15 @@ get '/callback' do end ``` -在我们的应用程序中，我们使用 `scopes.include?` 来检查我们是否被授予了获取经过身份验证的用户的私人电子邮件地址所需的 `user:email` 范围。 如果应用程序请求了其他范围，我们也会进行相应检查。 +在我们的应用程序中，我们使用 `scopes.include?` 来检查我们是否被授予了获取经过身份验证的用户的私人电子邮件地址所需的 `user:email` 范围。如果应用程序请求了其他范围，我们也会进行相应检查。 -此外，由于作用域之间存在分层关系，因此你应该检查你是否被授予了最低层级的必需范围。 例如，如果应用程序请求 `user` 范围，则它可能仅被授予 `user:email` 范围。 在这种情况下，应用程序并未获得请求的范围，但已授予的作用域仍是足够的。 +此外，由于作用域之间存在分层关系，因此你应该检查你是否被授予了最低层级的必需范围。例如，如果应用程序请求 `user` 范围，则它可能仅被授予 `user:email` 范围。在这种情况下，应用程序并未获得请求的范围，但已授予的作用域仍是足够的。 仅在发出请求之前检查范围是不够的，因为用户可能会在检查与实际请求之间的时间段更改范围。 如果发生这种情况，预期成功的 API 调用可能会失败，并显示 `404` 或 `401` 状态，或者返回不同的信息子集。 为了帮助你正常处理这些情况，对于使用有效令牌发出的请求，所有 API 响应还包含一个 [`X-OAuth-Scopes` 标头][oauth scopes]。 -此标头包含用于发出请求的令牌的范围列表。 除此之外，OAuth 应用程序 API 还提供终结点以{% ifversion fpt or ghes or ghec %}[检查令牌有效性](/rest/reference/apps#check-a-token){% else %}[检查令牌有效性](/rest/reference/apps#check-an-authorization){% endif %}。 +此标头包含用于发出请求的令牌的范围列表。除此之外，OAuth 应用程序 API 还提供终结点以{% ifversion fpt or ghes or ghec %}[检查令牌有效性](/rest/reference/apps#check-a-token){% else %}[检查令牌有效性](/rest/reference/apps#check-an-authorization){% endif %}。 使用此信息来检测令牌范围的更改，并将可用的应用程序功能的更改告知用户。 ### 发出经过身份验证的请求 @@ -162,7 +162,7 @@ end erb :basic, :locals => auth_result ``` -我们可以用我们的结果做任何我们想做的事。 在这种情况下，我们只需将它们直接转储到 basic.erb 中： +我们可以用我们的结果做任何我们想做的事。在这种情况下，我们只需将它们直接转储到 basic.erb 中： ``` erb

Hello, <%= login %>!

@@ -183,14 +183,14 @@ erb :basic, :locals => auth_result ## 实现“持久”身份验证 -如果我们要求用户每次访问网页时都必须登录应用，这将是一个非常糟糕的模式。 例如，尝试直接导航到 `http://127.0.0.1:4567/basic`。 您会收到一个错误。 +如果我们要求用户每次访问网页时都必须登录应用，这将是一个非常糟糕的模式。例如，尝试直接导航到 `http://127.0.0.1:4567/basic`。您会收到一个错误。 -如果我们能够绕过整个“单击此处”的过程，并且记住，只要用户登录到 {% data variables.product.product_name %}，他们应该就能够访问此应用程序，应该怎么办呢？ 坚持此做法，因为这正是我们要做的。 +如果我们能够绕过整个“单击此处”的过程，并且记住，只要用户登录到 {% data variables.product.product_name %}，他们应该就能够访问此应用程序，应该怎么办呢？坚持此做法，因为这正是我们要做的。 -我们的上述小服务器相当简单。 为了加入一些智能身份验证功能，我们将切换到使用会话来存储令牌。 +我们的上述小服务器相当简单。为了加入一些智能身份验证功能，我们将切换到使用会话来存储令牌。 这将使身份验证对用户透明化。 -此外，由于我们在会话中保留范围，因此我们需要处理用户在经过我们检查后更新范围或撤消令牌的情况。 为此，我们将使用 `rescue` 块，并检查第一个 API 调用是否成功，以验证令牌是否仍然有效。 之后，我们将检查 `X-OAuth-Scopes` 响应头，以验证用户是否尚未撤销 `user:email` 范围。 +此外，由于我们在会话中保留范围，因此我们需要处理用户在经过我们检查后更新范围或撤消令牌的情况。为此，我们将使用 `rescue` 块，并检查第一个 API 调用是否成功，以验证令牌是否仍然有效。之后，我们将检查 `X-OAuth-Scopes` 响应头，以验证用户是否尚未撤销 `user:email` 范围。 创建名为 advanced_server.rb 的文件，并将以下行粘贴到其中： @@ -272,11 +272,11 @@ get '/callback' do end ``` -许多代码应该看起来很熟悉。 例如，我们仍使用 `RestClient.get` 来调用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API，仍将结果传递到 ERB 模板（在此处称为 `advanced.erb`）中进行呈现。 +许多代码应该看起来很熟悉。例如，我们仍使用 `RestClient.get` 来调用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API，仍将结果传递到 ERB 模板（在此处称为 `advanced.erb`）中进行呈现。 -此外，我们现在有 `authenticated?` 方法，用于检查用户是否已通过身份验证。 如果未通过，则调用 `authenticate!` 方法，该方法执行 OAuth 流并使用授予的令牌和范围更新会话。 +此外，我们现在有 `authenticated?` 方法，用于检查用户是否已通过身份验证。如果未通过，则调用 `authenticate!` 方法，该方法执行 OAuth 流并使用授予的令牌和范围更新会话。 -接下来，在视图中创建一个名为 advanced.erb 的文件，并将此标记粘贴到其中 ： +接下来，在视图中创建一个名为 advanced.erb 的文件，并将此标记粘贴到其中： ``` erb @@ -302,9 +302,9 @@ end ``` 从命令行调用 `ruby advanced_server.rb`，它会在端口 `4567`（在具有一个简单的 Sinatra 应用时使用的相同端口）上启动服务器。 -导航到 `http://127.0.0.1:4567` 时，应用将调用重定向到 `/callback` 的 `authenticate!`。 然后 `/callback` 将我们发送回 `/`，并且由于我们已经过身份验证，因此会呈现 advanced.erb。 +导航到 `http://127.0.0.1:4567` 时，应用将调用重定向到 `/callback` 的 `authenticate!`。然后 `/callback` 将我们发送回 `/`，并且由于我们已经过身份验证，因此会呈现 advanced.erb。 -我们只需将 {% data variables.product.product_name %} 中的回叫 URL 更改为 `/` 即可完全简化此往返路由。 但是，由于 server.rb 和 advanced.rb 都依赖于同一回叫 URL，因此我们必须执行一些操作来使其正常运行 。 +我们只需将 {% data variables.product.product_name %} 中的回叫 URL 更改为 `/` 即可完全简化此往返路由。但是，由于 server.rb 和 advanced.rb 都依赖于同一回叫 URL，因此我们必须执行一些操作来使其正常运行。 此外，如果我们从未授权此应用程序访问 {% data variables.product.product_name %} 数据，我们会在早期的弹出和警告窗口中看到相同的确认对话框。 diff --git a/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md b/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md index dfe5fd968ea0..62feea8a6c20 100644 --- a/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md +++ b/translations/zh-CN/content/rest/guides/best-practices-for-integrators.md @@ -19,25 +19,25 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/11/2022 ms.locfileid: '147882269' --- -有兴趣与 GitHub 平台集成吗？ [你有很多同伴](https://github.com/integrations)。 本指南将帮助你构建能够为用户提供最佳体验并确保与 API 进行可靠交互的应用。 +有兴趣与 GitHub 平台集成吗？ [你有很多同伴](https://github.com/integrations)。本指南将帮助你构建能够为用户提供最佳体验并确保与 API 进行可靠交互的应用。 ## 确保安全接收从 GitHub 交付的有效负载 -请务必保护[从 GitHub 发送的有效负载][event-types]。 虽然有效负载中不会传输个人信息（如密码），但泄露任何信息总是不好的。 有些信息可能比较敏感，包括提交者电子邮件地址或私有仓库的名称。 +请务必保护 [从 GitHub 发送的有效负载][event-types]。虽然有效负载中不会传输个人信息（如密码），但泄露任何信息总是不好的。有些信息可能比较敏感，包括提交者电子邮件地址或私有仓库的名称。 您可以采取以下几个步骤来确保安全接收由 GitHub 交付的工作负载： -1. 确保您的接收服务器在 HTTPS 连接上。 默认情况下，GitHub 在交付有效负载时会验证 SSL 证书。{% ifversion fpt or ghec %} -1. 可以将[我们在交付挂钩时使用的 IP 地址](/github/authenticating-to-github/about-githubs-ip-addresses)添加到服务器的允许列表中。 为确保始终检查 IP 地址是否正确，你可以[使用 `/meta` 终结点](/rest/reference/meta#meta)查找我们使用的地址。{% endif %} -1. 提供[密钥令牌](/webhooks/securing/)以确保有效负载肯定来自 GitHub。 通过实施密钥令牌，您可以确保服务器接收的任何数据绝对来自 GitHub。 理想情况下，你应该为你的服务的每个用户都提供一个不同的密钥令牌。 这样，即使某个令牌被泄露，也不至于影响其他用户。 +1. 确保您的接收服务器在 HTTPS 连接上。默认情况下，GitHub 在交付有效负载时会验证 SSL 证书。{% ifversion fpt or ghec %} +1. 可以将[我们在交付挂钩时使用的 IP 地址](/github/authenticating-to-github/about-githubs-ip-addresses)添加到服务器的允许列表中。为确保始终检查 IP 地址是否正确，你可以[使用 `/meta` 终结点](/rest/reference/meta#meta)查找我们使用的地址。{% endif %} +1. 提供[密钥令牌](/webhooks/securing/)以确保有效负载肯定来自 GitHub。通过实施密钥令牌，您可以确保服务器接收的任何数据绝对来自 GitHub。理想情况下，你应该为你的服务的每个用户都提供一个不同的密钥令牌。这样，即使某个令牌被泄露，也不至于影响其他用户。 ## 支持异步工作而非同步工作 -GitHub 要求在收到 Webhook 有效负载后 {% ifversion fpt or ghec %}10{% else %}30{% endif %} 秒内做出集成响应。 如果您的服务需要更长的时间才能完成，则 GitHub 将终止连接，并且有效负载将丢失。 +GitHub 要求在收到 Webhook 有效负载后 {% ifversion fpt or ghec %}10{% else %}30{% endif %} 秒内做出集成响应。如果您的服务需要更长的时间才能完成，则 GitHub 将终止连接，并且有效负载将丢失。 由于无法预测您的服务完成速度，因此您应该在后台作业中执行所有“实际工作”。 [Resque](https://github.com/resque/resque/)（用于 Ruby）、[RQ](http://python-rq.org/)（用于 Python）或 [RabbitMQ](http://www.rabbitmq.com/)（用于 Java）是可以处理后台作业的排队和处理的库的示例。 -请注意，即使后台作业正在运行，GitHub 仍要求你的服务器能够在{% ifversion fpt or ghec %}十{% else %}三十{% endif %}秒内做出响应。 您的服务器需要通过发送某种响应来确认它收到了有效负载。 您的服务必须尽快对有效负载执行任何验证，以便您能够准确地报告您的服务器是否会继续处理请求。 +请注意，即使后台作业正在运行，GitHub 仍要求你的服务器能够在{% ifversion fpt or ghec %}十{% else %}三十{% endif %}秒内做出响应。您的服务器需要通过发送某种响应来确认它收到了有效负载。您的服务必须尽快对有效负载执行任何验证，以便您能够准确地报告您的服务器是否会继续处理请求。 ## 响应 GitHub 时使用适当的 HTTP 状态代码 @@ -45,33 +45,33 @@ GitHub 要求在收到 Webhook 有效负载后 {% ifversion fpt or ghec %}10{% e ![最近交付视图](/assets/images/webhooks_recent_deliveries.png) -您应该使用适当的 HTTP 状态代码来通知用户。 你可以使用 `201` 或 `202` 等代码来确认收到了不会被处理的有效负载（例如，非默认分支交付的有效负载）。 针对灾难性故障预留 `500` 错误代码。 +您应该使用适当的 HTTP 状态代码来通知用户。你可以使用 `201` 或 `202` 等代码来确认收到了不会被处理的有效负载（例如，非默认分支交付的有效负载）。针对灾难性故障预留 `500` 错误代码。 ## 向用户提供尽可能多的信息 -用户可能会深入研究您发回 GitHub 的服务器响应。 请确保您的信息清晰明了。 +用户可能会深入研究您发回 GitHub 的服务器响应。请确保您的信息清晰明了。 ![查看有效负载响应](/assets/images/payload_response_tab.png) ## 遵循 API 发送给您的任何重定向 -GitHub 在资源发生移动时会通过提供重定向状态代码来明确告诉您。 您应该遵循这些重定向。 每个重定向响应都使用要转到的新 URI 来设置 `Location` 标头。 如果您收到了重定向，最好更新代码以遵循新的 URI，以防您请求我们可能已删除的无效路径。 +GitHub 在资源发生移动时会通过提供重定向状态代码来明确告诉您。您应该遵循这些重定向。每个重定向响应都使用要转到的新 URI 来设置 `Location` 标头。如果您收到了重定向，最好更新代码以遵循新的 URI，以防您请求我们可能已删除的无效路径。 我们提供了 [HTTP 状态代码列表](/rest#http-redirects)，你在设计应用以遵循重定向时需要注意这些代码。 ## 不要手动解析 URL -通常，API 响应包含 URL 形式的数据。 例如，当请求存储库时，我们会发送一个名为 `clone_url` 的键，其中包含可用来克隆存储库的 URL。 +通常，API 响应包含 URL 形式的数据。例如，当请求存储库时，我们会发送一个名为 `clone_url` 的键，其中包含可用来克隆存储库的 URL。 -为了应用程序的稳定性，您不应该尝试解析此数据，或者尝试猜测并构造未来 URL 的格式。 否则，如果我们决定更改该 URL，您的应用程序可能会中断。 +为了应用程序的稳定性，您不应该尝试解析此数据，或者尝试猜测并构造未来 URL 的格式。否则，如果我们决定更改该 URL，您的应用程序可能会中断。 -例如，在处理分页结果时，人们往往很想构造在末尾追加 `?page=` 的 URL。 要抑制这种冲动。 [我们的分页指南](/guides/traversing-with-pagination)提供了一些关于可靠跟踪分页结果的安全提示。 +例如，在处理分页结果时，人们往往很想构造在末尾追加 `?page=` 的 URL。要抑制这种冲动。 [我们的分页指南](/guides/traversing-with-pagination)提供了一些关于可靠跟踪分页结果的安全提示。 ## 在处理事件之前检查事件类型和操作 -有多种 [Webhook 事件类型][event-types]，并且每个事件可以有多个操作。 随着 GitHub 功能集的增长，我们会不时添加新的事件类型或向现有事件类型添加新的操作。 请确保您的应用程序在进行任何 web 挂钩处理之前明确检查事件的类型和操作。 `X-GitHub-Event` 请求标头可用于了解收到了哪个事件，以便进行适当处理。 同样，有效负载具有顶层 `action` 键，可用于了解对相关对象采取了哪些操作。 +有多种 [Webhook 事件类型][event-types]，并且每个事件可以有多个操作。随着 GitHub 功能集的增长，我们会不时添加新的事件类型或向现有事件类型添加新的操作。请确保您的应用程序在进行任何 web 挂钩处理之前明确检查事件的类型和操作。 `X-GitHub-Event` 请求标头可用于了解收到了哪个事件，以便进行适当处理。同样，有效负载具有顶层 `action` 键，可用于了解对相关对象采取了哪些操作。 -例如，如果你已将 GitHub Webhook 配置为“向我发送所有内容”，则在添加新的事件类型和操作时，你的应用程序就会开始接收它们。 因此，不建议使用任何类型的 catch-all else 子句。 以下面的代码为例： +例如，如果你已将 GitHub Webhook 配置为“向我发送所有内容”，则在添加新的事件类型和操作时，你的应用程序就会开始接收它们。因此，不建议使用任何类型的 catch-all else 子句。以下面的代码为例： ```ruby # Not recommended: a catch-all else clause @@ -90,9 +90,9 @@ def receive end ``` -在此代码实例中，如果收到 `repository` 或`issues` 事件，将会正确调用 `process_repository` 和 `process_issues` 方法。 但是，任何其他事件类型都会导致调用 `process_pull_requests`。 当添加新的事件类型时，这将导致不正确的行为 - 将以处理 `pull_request` 事件的方式来处理新的事件类型。 +在此代码实例中，如果收到 `repository` 或`issues` 事件，将会正确调用 `process_repository` 和 `process_issues` 方法。但是，任何其他事件类型都会导致调用 `process_pull_requests`。当添加新的事件类型时，这将导致不正确的行为 - 将以处理 `pull_request` 事件的方式来处理新的事件类型。 -因此，我们建议明确检查事件类型并采取相应行动。 在以下代码示例中，我们明确检查 `pull_request` 事件，而 `else` 子句仅记录我们已收到新事件类型： +因此，我们建议明确检查事件类型并采取相应行动。在以下代码示例中，我们明确检查 `pull_request` 事件，而 `else` 子句仅记录我们已收到新事件类型： ```ruby # Recommended: explicitly check each event type @@ -113,9 +113,9 @@ def receive end ``` -由于每个事件也可以有多个操作，因此建议对操作进行类似的检查。 例如，[`IssuesEvent`](/webhooks/event-payloads/#issues) 有多个可能的操作。 其中包括创建问题时的 `opened`、关闭问题时的 `closed` 以及将问题分配给某人时的 `assigned`。 +由于每个事件也可以有多个操作，因此建议对操作进行类似的检查。例如，[`IssuesEvent`](/webhooks/event-payloads/#issues) 有多个可能的操作。其中包括创建问题时的 `opened`、关闭问题时的 `closed` 以及将问题分配给某人时的 `assigned`。 -与添加事件类型一样，我们可以向现有事件添加新操作。 因此，再次强调，在检查事件的操作时不要使用任何类型的 catch-all else 子句。 相反，我们建议像检查事件类型一样明确检查事件操作。 下面的示例非常吻合我们在上文中针对事件类型的建议： +与添加事件类型一样，我们可以向现有事件添加新操作。因此，再次强调，在检查事件的操作时不要使用任何类型的 catch-all else 子句。相反，我们建议像检查事件类型一样明确检查事件操作。下面的示例非常吻合我们在上文中针对事件类型的建议： ```ruby # Recommended: explicitly check each action @@ -133,7 +133,7 @@ def process_issue(payload) end ``` -在此示例中，在调用 `process_closed` 方法之前会先检查 `closed` 操作。 任何未识别的操作都会被记录以供将来参考。 +在此示例中，在调用 `process_closed` 方法之前会先检查 `closed` 操作。任何未识别的操作都会被记录以供将来参考。 {% ifversion fpt or ghec or ghae %} @@ -141,20 +141,20 @@ end GitHub API [速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting)可确保 API 快速供每个人使用。 -如果您达到了速率限制，则应该停止发出请求，然后在允许的时候再试。 否则，可能会导致您的应用程序被禁用。 +如果您达到了速率限制，则应该停止发出请求，然后在允许的时候再试。否则，可能会导致您的应用程序被禁用。 -你可以随时[检查你的速率限制状态](/rest/reference/rate-limit)。 检查您的速率限制状态对您的速率限制不会产生任何影响。 +你可以随时[检查你的速率限制状态](/rest/reference/rate-limit)。检查您的速率限制状态对您的速率限制不会产生任何影响。 ## 处理二级费率限制 [二级速率限制](/rest/overview/resources-in-the-rest-api#secondary-rate-limits)是我们确保 API 可用性的另一种方式。 为了避免达到此限制，应确保您的应用程序遵循以下准则。 -* 发出经过身份验证的请求，或使用应用程序的客户端 ID 和密钥。 未经身份验证的请求会受到更严格的二级速率限制。 -* 依次为单个用户或客户端 ID 发出请求。 不要同时为单个用户或客户端 ID 发出多个请求。 +* 发出经过身份验证的请求，或使用应用程序的客户端 ID 和密钥。未经身份验证的请求会受到更严格的二级速率限制。 +* 依次为单个用户或客户端 ID 发出请求。不要同时为单个用户或客户端 ID 发出多个请求。 * 如果你要为单个用户或客户端 ID 发出大量的 `POST`、`PATCH`、`PUT` 或 `DELETE` 请求，则每两个请求之间至少应间隔一秒钟。 -* 当你受到限制时，请使用 `Retry-After` 响应标头来降低速率。 `Retry-After` 标头的值始终为整数，表示你在再次发出请求之前应等待的秒数。 例如，`Retry-After: 30` 表示你在发出更多请求之前应等待 30 秒。 -* 会触发通知的内容创建请求，例如问题、评论和拉取请求，可能会受到进一步限制，并且在响应中不包含 `Retry-After` 标头。 请以合理的速率创建此类内容，以避免受到进一步限制。 +* 当你受到限制时，请使用 `Retry-After` 响应标头来降低速率。 `Retry-After` 标头的值始终为整数，表示你在再次发出请求之前应等待的秒数。例如，`Retry-After: 30` 表示你在发出更多请求之前应等待 30 秒。 +* 会触发通知的内容创建请求，例如问题、评论和拉取请求，可能会受到进一步限制，并且在响应中不包含 `Retry-After` 标头。请以合理的速率创建此类内容，以避免受到进一步限制。 我们保留根据需要更改这些准则以确保可用性的权利。 @@ -164,7 +164,7 @@ GitHub API [速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting 尽管您的代码从未引入漏洞，但您可能会发现在尝试访问 API 时遇到连续错误。 -你应该确保与 API 正确交互，而不是忽略重复的 `4xx` 和 `5xx` 状态代码。 例如，如果某个终结点请求一个字符串，而你向其传递一个数值，则你将会收到 `5xx` 验证错误，并且你的调用不会成功。 同样，试图访问未经授权或不存在的终结点会导致 `4xx` 错误。 +你应该确保与 API 正确交互，而不是忽略重复的 `4xx` 和 `5xx` 状态代码。例如，如果某个终结点请求一个字符串，而你向其传递一个数值，则你将会收到 `5xx` 验证错误，并且你的调用不会成功。同样，试图访问未经授权或不存在的终结点会导致 `4xx` 错误。 故意忽略重复的验证错误可能会导致您的应用程序因滥用而被暂停。 diff --git a/translations/zh-CN/content/rest/guides/building-a-ci-server.md b/translations/zh-CN/content/rest/guides/building-a-ci-server.md index 81b1b552bd40..11a664ea441e 100644 --- a/translations/zh-CN/content/rest/guides/building-a-ci-server.md +++ b/translations/zh-CN/content/rest/guides/building-a-ci-server.md @@ -26,9 +26,9 @@ ms.locfileid: '145129064' * 在拉取请求被打开时运行我们的 CI 套件（我们将 CI 状态设置为待处理）。 * 在 CI 完成后，我们将相应地设置拉取请求的状态。 -我们的 CI 系统和主机服务器将是我们想象中的虚拟物。 它们可能是 Travis、Jenkins 或其他完全不同的工具。 本指南的重点是设置和配置负责管理通信的服务器。 +我们的 CI 系统和主机服务器将是我们想象中的虚拟物。它们可能是 Travis、Jenkins 或其他完全不同的工具。本指南的重点是设置和配置负责管理通信的服务器。 -如果尚未下载，请务必[下载 ngrok][ngrok]，并了解如何[使用它][using ngrok]。 我们发现它在暴露本地连接方面是一款非常有用的工具。 +如果尚未下载，请务必 [下载 ngrok][ngrok]，并了解如何 [使用它][using ngrok]。我们发现它在暴露本地连接方面是一款非常有用的工具。 注意：可以在 [platform-samples][platform samples] 存储库中下载此项目的完整源代码。 @@ -49,22 +49,22 @@ end （如果你不熟悉 Sinatra 的工作原理，建议你阅读 [Sinatra 指南][Sinatra]。） -启动此服务器。 默认情况下，Sinatra 在端口 `4567` 上启动，因此你还需要配置 ngrok 开始监听。 +启动此服务器。默认情况下，Sinatra 在端口 `4567` 上启动，因此你还需要配置 ngrok 开始监听。 为了使此服务器正常工作，我们需要使用 web 挂钩来设置一个仓库。 Web 挂钩应配置为在创建或合并拉取请求时触发。 -继续创建一个您可以自由支配的仓库。 我们可以推荐 [@octocat 的 Spoon/Knife 存储库](https://github.com/octocat/Spoon-Knife)吗？ +继续创建一个您可以自由支配的仓库。我们可以推荐 [@octocat 的 Spoon/Knife 存储库](https://github.com/octocat/Spoon-Knife)吗？ 之后，你将在自己的存储库中创建新的 web 挂钩，向其馈送 ngrok 给你的 URL，并选择 `application/x-www-form-urlencoded` 作为内容类型： ![新的 ngrok URL](/assets/images/webhook_sample_url.png) -单击“更新 Webhook”。 应该会看到响应 `Well, it worked!`。 -很好！ 单击“让我选择单个事件”，然后选择以下项： +单击“更新 Webhook”。应该会看到响应 `Well, it worked!`。 +很好！单击“让我选择单个事件”，然后选择以下项： * 状态 * 拉取请求 -在发生相关操作时，{% data variables.product.product_name %} 会将这些事件发送到我们的服务器。 现在将服务器更新为直接立即处理拉取请求场景： +在发生相关操作时，{% data variables.product.product_name %} 会将这些事件发送到我们的服务器。现在将服务器更新为直接立即处理拉取请求场景： ``` ruby post '/event_handler' do @@ -85,16 +85,16 @@ helpers do end ``` -这是怎么回事？ {% data variables.product.product_name %} 发送的每个事件都附有 `X-GitHub-Event` HTTP 标头。 我们现在只关注拉取请求事件。 我们将从其中获取信息的有效负载，并返回标题字段。 在理想情况下，我们的服务器会关注每次更新拉取请求时的情况（而不仅仅是打开时的情况）。 这将确保每个新推送都通过 CI 测试。 +这是怎么回事？ {% data variables.product.product_name %} 发送的每个事件都附有 `X-GitHub-Event` HTTP 标头。我们现在只关注拉取请求事件。我们将从其中获取信息的有效负载，并返回标题字段。在理想情况下，我们的服务器会关注每次更新拉取请求时的情况（而不仅仅是打开时的情况）。这将确保每个新推送都通过 CI 测试。 但就此演示而言，我们只需关注它被打开时的情况。 -要测试此概念验证，请在测试存储库的分支中进行一些更改，然后打开拉取请求。 您的服务器应该会做出相应的响应！ +要测试此概念验证，请在测试存储库的分支中进行一些更改，然后打开拉取请求。您的服务器应该会做出相应的响应！ ## 处理状态 -服务器就位后，我们就可以开始实现第一个要求，即设置（和更新）CI 状态。 请注意，无论何时更新服务器，都可以单击“重新交付”，发送相同的有效负载。 不需要每次进行更改时都发出新的拉取请求！ +服务器就位后，我们就可以开始实现第一个要求，即设置（和更新）CI 状态。请注意，无论何时更新服务器，都可以单击“重新交付”，发送相同的有效负载。不需要每次进行更改时都发出新的拉取请求！ -由于我们在与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互，因此我们将使用 [Octokit.rb][octokit.rb] 来管理我们的交互。 我们将使用[个人访问令牌][access token]配置该客户端： +由于我们在与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互，因此我们将使用 [Octokit.rb][octokit.rb] 来管理我们的交互。我们将使用 [个人访问令牌][access token] 配置该客户端： ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -121,7 +121,7 @@ end * 查找拉取请求的最后一个 SHA * 将状态设置为“待处理” -就这么简单！ 从这里，你可以运行任何需要的进程来执行测试套件。 也许你会将代码传递给 Jenkins，或者通过其 API 调用另一个 Web 服务，例如 [Travis][travis api]。 之后，请务必再次更新状态。 在本示例中，我们只需将其设置为 `"success"`： +就这么简单！从这里，你可以运行任何需要的进程来执行测试套件。也许你会将代码传递给 Jenkins，或者通过其 API 调用另一个 Web 服务，例如 [Travis][travis api]。之后，请务必再次更新状态。在本示例中，我们只需将其设置为 `"success"`： ``` ruby def process_pull_request(pull_request) @@ -142,7 +142,7 @@ end * 等待关于 CI 状态的响应 * 如果代码为绿色，我们将合并拉取请求 -所有这些通信都会流回我们的聊天室。 使用此示例并不需要构建自己的 CI 设置。 +所有这些通信都会流回我们的聊天室。使用此示例并不需要构建自己的 CI 设置。 始终可以依赖 [GitHub 集成][integrations]。 [deploy API]: /rest/reference/repos#deployments diff --git a/translations/zh-CN/content/rest/guides/delivering-deployments.md b/translations/zh-CN/content/rest/guides/delivering-deployments.md index 1c8761f0e7f9..915a9d4bc901 100644 --- a/translations/zh-CN/content/rest/guides/delivering-deployments.md +++ b/translations/zh-CN/content/rest/guides/delivering-deployments.md @@ -19,18 +19,18 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/11/2022 ms.locfileid: '145129063' --- -[部署 API][deploy API] 让 {% data variables.product.product_name %} 上托管的项目能够在你所拥有的服务器上启动这些部署。 结合 [状态 API][status API]，你将能够在代码登陆默认分支的那一刻协调部署。 +[部署 API][deploy API] 让 {% data variables.product.product_name %} 上托管的项目能够在你所拥有的服务器上启动这些部署。结合 [状态 API][status API]，你将能够在代码登陆默认分支的那一刻协调部署。 本指南将使用该 API 来演示您可以使用的设置。 在我们的场景中，我们将： -* 合并拉取请求. +* 合并拉取请求。 * 在 CI 完成后，我们将相应地设置拉取请求的状态。 * 合并拉取请求后，我们将在服务器上运行部署。 -我们的 CI 系统和主机服务器将是我们想象中的虚拟物。 它们可能是 Heroku、Amazon 或其他完全不同的东西。 本指南的重点是设置和配置负责管理通信的服务器。 +我们的 CI 系统和主机服务器将是我们想象中的虚拟物。它们可能是 Heroku、Amazon 或其他完全不同的东西。本指南的重点是设置和配置负责管理通信的服务器。 -如果尚未下载，请务必[下载 ngrok][ngrok]，并了解如何[使用它][using ngrok]。 我们发现它在暴露本地连接方面是一款非常有用的工具。 +如果尚未下载，请务必 [下载 ngrok][ngrok]，并了解如何 [使用它][using ngrok]。我们发现它在暴露本地连接方面是一款非常有用的工具。 注意：可以在 [platform-samples][platform samples] 存储库中下载此项目的完整源代码。 @@ -51,23 +51,23 @@ end （如果你不熟悉 Sinatra 的工作原理，建议你阅读 [Sinatra 指南][Sinatra]。） -启动此服务器。 默认情况下，Sinatra 在端口 `4567` 上启动，因此你还需要配置 ngrok 开始监听。 +启动此服务器。默认情况下，Sinatra 在端口 `4567` 上启动，因此你还需要配置 ngrok 开始监听。 为了使此服务器正常工作，我们需要使用 web 挂钩来设置一个仓库。 Web 挂钩应配置为在创建或合并拉取请求时触发。 -继续创建一个您可以自由支配的仓库。 我们可以推荐 [@octocat 的 Spoon/Knife 存储库](https://github.com/octocat/Spoon-Knife)吗？ +继续创建一个您可以自由支配的仓库。我们可以推荐 [@octocat 的 Spoon/Knife 存储库](https://github.com/octocat/Spoon-Knife)吗？ 之后，你将在自己的存储库中创建新的 web 挂钩，向其馈送 ngrok 给你的 URL，并选择 `application/x-www-form-urlencoded` 作为内容类型： ![新的 ngrok URL](/assets/images/webhook_sample_url.png) -单击“更新 Webhook”。 应该会看到响应 `Well, it worked!`。 -很好！ 单击“让我选择单个事件”，然后选择以下项： +单击“更新 Webhook”。应该会看到响应 `Well, it worked!`。 +很好！单击“让我选择单个事件”，然后选择以下项： * 部署 * 部署状态 * 拉取请求 -在发生相关操作时，{% data variables.product.product_name %} 会将这些事件发送到我们的服务器。 我们将服务器配置为刚好在立即合并拉取请求时处理： +在发生相关操作时，{% data variables.product.product_name %} 会将这些事件发送到我们的服务器。我们将服务器配置为刚好在立即合并拉取请求时处理： ``` ruby post '/event_handler' do @@ -82,9 +82,9 @@ post '/event_handler' do end ``` -这是怎么回事？ {% data variables.product.product_name %} 发送的每个事件都附有 `X-GitHub-Event` HTTP 标头。 我们现在只关注拉取请求事件。 当合并拉取请求（其状态为 `closed` 且 `merged` 为 `true`）时，我们将启动部署。 +这是怎么回事？ {% data variables.product.product_name %} 发送的每个事件都附有 `X-GitHub-Event` HTTP 标头。我们现在只关注拉取请求事件。当合并拉取请求（其状态为 `closed` 且 `merged` 为 `true`）时，我们将启动部署。 -要测试此概念验证，请在测试存储库的分支中进行一些更改，打开拉取请求，然后合并它。 您的服务器应该会做出相应的响应！ +要测试此概念验证，请在测试存储库的分支中进行一些更改，打开拉取请求，然后合并它。您的服务器应该会做出相应的响应！ ## 处理部署 @@ -114,13 +114,13 @@ def start_deployment(pull_request) end ``` -部署可以附加一些元数据，格式为 `payload` 和 `description`。 尽管这些值是可选的，但对用于记录和表示信息很有帮助。 +部署可以附加一些元数据，格式为 `payload` 和 `description`。尽管这些值是可选的，但对用于记录和表示信息很有帮助。 -创建新部署时，将触发完全独立的事件。 这就是为什么我们在 `deployment` 的事件处理程序中有一个新的 `switch` 案例。 在触发部署时，你可以根据此信息得到通知。 +创建新部署时，将触发完全独立的事件。这就是为什么我们在 `deployment` 的事件处理程序中有一个新的 `switch` 案例。在触发部署时，你可以根据此信息得到通知。 部署可能需要很长时间，因此我们需要侦听各种事件，例如部署的创建时间以及部署所处的状态。 -让我们模拟一个能够完成某些工作的部署，并注意它对输出的影响。 首先，让我们完成 `process_deployment` 方法： +让我们模拟一个能够完成某些工作的部署，并注意它对输出的影响。首先，让我们完成 `process_deployment` 方法： ``` ruby def process_deployment @@ -142,20 +142,20 @@ def update_deployment_status end ``` -我们来分析一下发生了什么。 `start_deployment` 会创建一个新部署，这会触发 `deployment` 事件。 从那里，我们将调用 `process_deployment` 模拟正在进行的工作。 在该处理过程中，我们还会调用 `create_deployment_status`，这样接收方就可以知道发生了什么情况，因为我们将状态切换为 `pending`。 +我们来分析一下发生了什么。 `start_deployment` 会创建一个新部署，这会触发 `deployment` 事件。从那里，我们将调用 `process_deployment` 模拟正在进行的工作。在该处理过程中，我们还会调用 `create_deployment_status`，这样接收方就可以知道发生了什么情况，因为我们将状态切换为 `pending`。 部署完成后，我们将状态设置为 `success`。 ## 结束语 -在 GitHub，我们多年来使用 [Heaven][heaven] 版本管理部署。 共同流程本质上与我们上面构建的服务器基本相同： +在 GitHub，我们多年来使用 [Heaven][heaven] 版本管理部署。共同流程本质上与我们上面构建的服务器基本相同： * 等待 CI 检查状态的响应（成功或失败） * 如果所需的检查成功，则合并拉取请求 * Heaven 提取合并的代码，并将其部署到暂存和生产服务器上 * 与此同时，Heaven 也会通过会议室中的 [Hubot][hubot] 会议向每个人通知构建情况 -就这么简单！ 使用此示例并不需要构建自己的部署设置。 +就这么简单！使用此示例并不需要构建自己的部署设置。 始终可以依赖 [GitHub 集成][integrations]。 [deploy API]: /rest/reference/repos#deployments diff --git a/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md b/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md index 31d7e6a56aed..5544cc1ac283 100644 --- a/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md +++ b/translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md @@ -19,21 +19,21 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '145129059' --- -向 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 发出经过身份验证的请求时，应用程序通常需要获取当前用户的仓库和组织。 在本指南中，我们将介绍如何可靠地发现这些资源。 +向 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 发出经过身份验证的请求时，应用程序通常需要获取当前用户的仓库和组织。在本指南中，我们将介绍如何可靠地发现这些资源。 -若要与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 交互，将使用 [Octokit.rb][octokit.rb]。 可以在 [platform-samples][platform samples] 存储库中找到此项目的完整源代码。 +若要与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 交互，将使用 [Octokit.rb][octokit.rb]。可以在 [platform-samples][platform samples] 存储库中找到此项目的完整源代码。 ## 入门 -在开始本示例之前，应阅读[“身份验证基础知识”][basics-of-authentication]指南（如果尚未阅读）。 下面的示例假定你[已注册 OAuth 应用程序][register-oauth-app]，并且你的[应用程序具有用户的 OAuth 标记][make-authenticated-request-for-user]。 +在开始本示例之前，应阅读 [“身份验证基础知识”][basics-of-authentication] 指南（如果尚未阅读）。下面的示例假定你 [已注册 OAuth 应用程序][register-oauth-app]，并且你的 [应用程序具有用户的 OAuth 标记][make-authenticated-request-for-user]。 ## 发现您的应用程序能够为用户访问的仓库 -用户除了拥有他们自己的个人仓库之外，可能还是其他用户和组织所拥有仓库上的协作者。 总的来说，这些仓库是用户有权访问的仓库：要么是用户具有读取或写入权限的私有仓库，要么是用户具有写入权限的{% ifversion fpt %}公共{% elsif ghec or ghes %}公共或内部{% elsif ghae %}内部{% endif %}仓库。 +用户除了拥有他们自己的个人仓库之外，可能还是其他用户和组织所拥有仓库上的协作者。总的来说，这些仓库是用户有权访问的仓库：要么是用户具有读取或写入权限的私有仓库，要么是用户具有写入权限的{% ifversion fpt %}公共{% elsif ghec or ghes %}公共或内部{% elsif ghae %}内部{% endif %}仓库。 -[OAuth 作用域][scopes]和[组织应用程序策略][oap]决定了你的应用可以为用户访问其中哪些存储库。 使用下面的工作流程来发现这些仓库。 +[OAuth 作用域][scopes] 和 [组织应用程序策略][oap] 决定了你的应用可以为用户访问其中哪些存储库。使用下面的工作流程来发现这些仓库。 -照常，首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库。 然后我们将配置 Octoberkit.rb，使其为我们自动处理[分页][pagination]。 +照常，首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库。然后我们将配置 Octoberkit.rb，使其为我们自动处理 [分页][pagination]。 ``` ruby require 'octokit' @@ -41,7 +41,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -接下来，我们将[为给定用户传递应用程序的 OAuth 标记][make-authenticated-request-for-user]： +接下来，我们将 [为给定用户传递应用程序的 OAuth 标记][make-authenticated-request-for-user]： ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -49,7 +49,7 @@ Octokit.auto_paginate = true client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -然后，我们便可以提取[应用程序可以为用户访问的存储库][list-repositories-for-current-user]： +然后，我们便可以提取 [应用程序可以为用户访问的存储库][list-repositories-for-current-user]： ``` ruby client.repositories.each do |repository| @@ -68,9 +68,9 @@ end ## 发现您的应用程序能够为用户访问的组织 -应用程序可以为用户执行各种与组织相关的任务。 若要执行这些任务，应用程序需要具有足够权限的 [OAuth 授权][scopes]。 例如，`read:org` 作用域允许你[列出团队][list-teams]，`user` 作用域允许你[公开用户的组织成员身份][publicize-membership]。 一旦用户将其中一个或多个作用域授予您的应用程序，您就可以获取用户的组织。 +应用程序可以为用户执行各种与组织相关的任务。若要执行这些任务，应用程序需要具有足够权限的 [OAuth 授权][scopes]。例如，`read:org` 作用域允许你 [列出团队][list-teams]，`user` 作用域允许你 [公开用户的组织成员身份][publicize-membership]。一旦用户将其中一个或多个作用域授予您的应用程序，您就可以获取用户的组织。 -与上述发现存储库的过程一样，我们首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库，并对其进行配置，以便为我们处理[分页][pagination]： +与上述发现存储库的过程一样，我们首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库，并对其进行配置，以便为我们处理 [分页][pagination]： ``` ruby require 'octokit' @@ -78,7 +78,7 @@ require 'octokit' Octokit.auto_paginate = true ``` -接下来，我们将[为给定用户传递应用程序的 OAuth 标记][make-authenticated-request-for-user]，以初始化 API 客户端： +接下来，我们将 [为给定用户传递应用程序的 OAuth 标记][make-authenticated-request-for-user]，以初始化 API 客户端： ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! @@ -86,7 +86,7 @@ Octokit.auto_paginate = true client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"] ``` -然后，我们可以[列出我们的应用程序可以为用户访问的组织][list-orgs-for-current-user]： +然后，我们可以 [列出我们的应用程序可以为用户访问的组织][list-orgs-for-current-user]： ``` ruby client.organizations.each do |organization| @@ -96,9 +96,9 @@ end ### 返回用户的所有组织成员资格 -如果你从头到尾阅读了文档，你可能注意到一种[允许列出用户的公共组织成员身份的 API 方法][list-public-orgs]。 大多数应用程序应避免使用这种 API 方法。 此方法仅返回用户的公共组织成员身份，而不会返回其私有组织成员身份。 +如果你从头到尾阅读了文档，你可能注意到一种 [允许列出用户的公共组织成员身份的 API 方法][list-public-orgs]。大多数应用程序应避免使用这种 API 方法。此方法仅返回用户的公共组织成员身份，而不会返回其私有组织成员身份。 -作为应用程序开发者，您通常希望您的应用程序被授权访问用户的所有组织。 上述工作流程恰好能满足您的要求。 +作为应用程序开发者，您通常希望您的应用程序被授权访问用户的所有组织。上述工作流程恰好能满足您的要求。 [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md index 3e59dd2d4efb..268044dfcbff 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md @@ -1,6 +1,6 @@ --- title: 检查 API 入门指南 -intro: 检查运行 API 使您能够构建 GitHub 应用程序，以针对仓库中的代码更改运行强大的检查。 您可以创建应用程序以执行持续集成 、代码分析或代码扫描服务，并提供有关提交的详细反馈。 +intro: 检查运行 API 使您能够构建 GitHub 应用程序，以针对仓库中的代码更改运行强大的检查。您可以创建应用程序以执行持续集成、代码分析或代码扫描服务，并提供有关提交的详细反馈。 versions: fpt: '*' ghes: '*' @@ -18,21 +18,21 @@ ms.locfileid: '147062224' --- ## 概述 -GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行注释以及重新运行测试，而不是提供二进制的通过/失败构建状态。 Checks API 功能专用于您的 GitHub 应用程序。 +GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行注释以及重新运行测试，而不是提供二进制的通过/失败构建状态。Checks API 功能专用于您的 GitHub 应用程序。 有关如何将检查 API 用于 {% data variables.product.prodname_github_app %} 的示例，请参阅“[使用 Checks API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)”。 ## 关于检查套件 -当有人向仓库推送代码时，GitHub 会为最新的提交创建一个检查套件。 检查套件是单个 GitHub 应用为特定提交而创建的[检查运行](/rest/reference/checks#check-runs)的集合。 检查套件汇总了套件所含检查运行的状态和结论。 +当有人向仓库推送代码时，GitHub 会为最新的提交创建一个检查套件。检查套件是单个 GitHub 应用为特定提交而创建的[检查运行](/rest/reference/checks#check-runs)的集合。检查套件汇总了套件所含检查运行的状态和结论。 ![检查套件工作流程](/assets/images/check_suites.png) -检查套件在其 `conclusion` 中报告优先级最高的检查运行 `conclusion`。 例如，如果三个检查运行的结论分别为 `timed_out`、`success` 和 `neutral`，则检查套件的结论将为 `timed_out`。 +检查套件在其 `conclusion` 中报告优先级最高的检查运行 `conclusion`。例如，如果三个检查运行的结论分别为 `timed_out`、`success` 和 `neutral`，则检查套件的结论将为 `timed_out`。 -默认情况下，当代码被推送到仓库时，GitHub 会自动创建一个检查套件。 此默认流程会将 `check_suite` 事件（使用 `requested` 操作）发送到具有 `checks:write` 权限的所有 GitHub 应用。 当 GitHub 应用收到 `check_suite` 事件时，它可以为最新的提交创建新的检查运行。 GitHub 根据检查运行的存储库和 SHA，自动将新的检查运行添加到适当的[检查套件](/rest/reference/checks#check-suites)中。 +默认情况下，当代码被推送到仓库时，GitHub 会自动创建一个检查套件。此默认流程会将 `check_suite` 事件（使用 `requested` 操作）发送到具有 `checks:write` 权限的所有 GitHub 应用。当 GitHub 应用收到 `check_suite` 事件时，它可以为最新的提交创建新的检查运行。GitHub 根据检查运行的存储库和 SHA，自动将新的检查运行添加到适当的[检查套件](/rest/reference/checks#check-suites)中。 -如果您不想使用默认的自动流程，您可以控制何时创建检查套件。 若要更改用于创建检查套件的默认设置，请使用[更新检查套件的存储库首选项](/rest/reference/checks#update-repository-preferences-for-check-suites)终结点。 对自动流程设置的所有更改都被记录在仓库的审核日志中。 如果已禁用自动流，则可以使用[创建检查套件](/rest/reference/checks#create-a-check-suite)终结点来创建一个检查套件。 应该继续使用[创建检查运行](/rest/reference/checks#create-a-check-run)终结点来提供对提交的反馈。 +如果您不想使用默认的自动流程，您可以控制何时创建检查套件。若要更改用于创建检查套件的默认设置，请使用[更新检查套件的存储库首选项](/rest/reference/checks#update-repository-preferences-for-check-suites)终结点。对自动流程设置的所有更改都被记录在仓库的审核日志中。如果已禁用自动流，则可以使用[创建检查套件](/rest/reference/checks#create-a-check-suite)终结点来创建一个检查套件。应该继续使用[创建检查运行](/rest/reference/checks#create-a-check-run)终结点来提供对提交的反馈。 {% data reusables.apps.checks-availability %} @@ -42,17 +42,17 @@ GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行 ## 关于检查运行 -检查运行是检查套件中的单个测试。 每个运行都包含状态和结论。 +检查运行是检查套件中的单个测试。每个运行都包含状态和结论。 ![检查运行工作流程](/assets/images/check_runs.png) -如果检查运行处于未完成状态超过 14 天，则检查运行的 `conclusion` 将变成 `stale`，并且通过 {% octicon "issue-reopened" aria-label="The issue-reopened icon" %} 在 {% data variables.product.prodname_dotcom %} 上显示为过时。 只有 {% data variables.product.prodname_dotcom %} 可以将检查运行标记为 `stale`。 有关检查运行可能得出的结论的详细信息，请参阅 [`conclusion` 参数](/rest/reference/checks#create-a-check-run--parameters)。 +如果检查运行处于未完成状态超过 14 天，则检查运行的 `conclusion` 将变成 `stale`，并且通过 {% octicon "issue-reopened" aria-label="The issue-reopened icon" %} 在 {% data variables.product.prodname_dotcom %} 上显示为过时。只有 {% data variables.product.prodname_dotcom %} 可以将检查运行标记为 `stale`。有关检查运行可能得出的结论的详细信息，请参阅 [`conclusion` 参数](/rest/reference/checks#create-a-check-run--parameters)。 -一旦收到 [`check_suite`](/webhooks/event-payloads/#check_suite) Webhook，即使检查尚未完成，也可以创建检查运行。 可以在检查运行完成时使用值 `queued`、`in_progress` 或 `completed` 来更新其 `status`，并且可以在更多详细信息可用时更新 `output`。 检查运行可以包含时间戳、指向外部站点上更多详细信息的链接、特定代码行的详细注释以及有关所执行分析的信息。 +一旦收到 [`check_suite`](/webhooks/event-payloads/#check_suite) Webhook，即使检查尚未完成，也可以创建检查运行。可以在检查运行完成时使用值 `queued`、`in_progress` 或 `completed` 来更新其 `status`，并且可以在更多详细信息可用时更新 `output`。检查运行可以包含时间戳、指向外部站点上更多详细信息的链接、特定代码行的详细注释以及有关所执行分析的信息。 ![检查运行注释](/assets/images/check_run_annotations.png) -还可以在 GitHub UI 中手动重新运行检查。 有关更多详细信息，请参阅“[关于状态检查](/articles/about-status-checks#checks)”。 发生这种情况时，创建检查运行的 GitHub 应用将收到请求新检查运行的 [`check_run`](/webhooks/event-payloads/#check_run) Webhook。 如果您创建检查运行时没有创建检查套件，GitHub 将自动为您创建检查套件。 +还可以在 GitHub UI 中手动重新运行检查。有关更多详细信息，请参阅“[关于状态检查](/articles/about-status-checks#checks)”。发生这种情况时，创建检查运行的 GitHub 应用将收到请求新检查运行的 [`check_run`](/webhooks/event-payloads/#check_run) Webhook。如果您创建检查运行时没有创建检查套件，GitHub 将自动为您创建检查套件。 {% data reusables.apps.checks-availability %} @@ -64,7 +64,7 @@ GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行 例如，代码分析应用程序可以使用请求的操作在拉取请求中显示一个按钮，以自动修复检测到的语法错误。 -若要创建可从你的应用请求额外操作的按钮，请在[创建检查运行](/rest/reference/checks/#create-a-check-run)时使用 [`actions` 对象](/rest/reference/checks#create-a-check-run--parameters)。 例如，下面的 `actions` 对象在拉取请求中显示一个按钮，标签为“修复此问题”。 该按钮在检查运行完成后显示。 +若要创建可从你的应用请求额外操作的按钮，请在[创建检查运行](/rest/reference/checks/#create-a-check-run)时使用 [`actions` 对象](/rest/reference/checks#create-a-check-run--parameters)。例如，下面的 `actions` 对象在拉取请求中显示一个按钮，标签为“修复此问题”。该按钮在检查运行完成后显示。 ```json "actions": [{ @@ -76,7 +76,7 @@ GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行 ![检查运行请求操作按钮](/assets/images/github-apps/github_apps_checks_fix_this_button.png) -当用户单击该按钮时，{% data variables.product.prodname_dotcom %} 会将 [`check_run.requested_action` Webhook](/webhooks/event-payloads/#check_run) 发送到你的应用。 当应用收到 `check_run.requested_action` Webhook 事件时，它可以在 Webhook 有效负载中查找 `requested_action.identifier` 键，以确定单击了哪个按钮，并执行请求的任务。 +当用户单击该按钮时，{% data variables.product.prodname_dotcom %} 会将 [`check_run.requested_action` Webhook](/webhooks/event-payloads/#check_run) 发送到你的应用。当应用收到 `check_run.requested_action` Webhook 事件时，它可以在 Webhook 有效负载中查找 `requested_action.identifier` 键，以确定单击了哪个按钮，并执行请求的任务。 关于如何使用检查 API 设置请求操作的详细示例，请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)”。 diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-git-database-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-git-database-api.md index ac54e9153501..fffc9f76898e 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-git-database-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-git-database-api.md @@ -20,7 +20,7 @@ ms.locfileid: '145129051' 这基本上允许您通过我们的 API 重新实现大量 Git 功能 - 通过直接在数据库中创建原始对象并更新分支引用，从技术上讲，您可以在不安装 Git 的情况下完成 Git 能做的任何事情。 -如果 Git 存储库为空或不可用，Git 数据库 API 函数将返回 `409 Conflict`。 仓库不可用通常意味着 {% data variables.product.product_name %} 正在创建仓库。 对于空存储库，可以使用“[创建或更新文件内容](/rest/reference/repos#create-or-update-file-contents)”终结点来创建内容并初始化存储库，以便可以使用 Git 数据库 API。 如果此响应状态仍然存在，请联系 {% data variables.contact.contact_support %}。 +如果 Git 存储库为空或不可用，Git 数据库 API 函数将返回 `409 Conflict`。仓库不可用通常意味着 {% data variables.product.product_name %} 正在创建仓库。对于空存储库，可以使用“[创建或更新文件内容](/rest/reference/repos#create-or-update-file-contents)”终结点来创建内容并初始化存储库，以便可以使用 Git 数据库 API。如果此响应状态仍然存在，请联系 {% data variables.contact.contact_support %}。 ![git 数据库概述](/assets/images/git-database-overview.png) @@ -32,7 +32,7 @@ ms.locfileid: '145129051' * 检索它指向的树 * 检索树中针对该特定文件路径的 blob 对象的内容 * 以某种方式更改内容并发布包含这些新内容的新 blob 对象，以获取 blob SHA -* 发布新的树对象， 将文件路径指针替换为新的 blob SHA， 以获取树 SHA +* 发布新的树对象，将文件路径指针替换为新的 blob SHA，以获取树 SHA * 通过作为父级的当前提交 SHA 和新的树 SHA，创建新的提交对象，以获取提交 SHA * 更新分支的引用以指向新的提交 SHA @@ -42,14 +42,14 @@ ms.locfileid: '145129051' {% warning %} -警告！ 请不要依赖于直接使用 Git 或 [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/reference/git#get-a-reference) 来更新 `merge` Git 引用，因为此内容会在没有警告的情况下过时。 +警告！请不要依赖于直接使用 Git 或 [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/reference/git#get-a-reference) 来更新 `merge` Git 引用，因为此内容会在没有警告的情况下过时。 {% endwarning %} -使用 API 需要明确请求拉取请求来创建一个 _测试_ 合并提交。 在 UI 中查看拉取请求并显示“合并”按钮时，或者使用 REST API [获取](/rest/reference/pulls#get-a-pull-request)、[创建](/rest/reference/pulls#create-a-pull-request)或 [编辑](/rest/reference/pulls#update-a-pull-request)拉取请求时，将创建一个 _测试_ 合并提交。 如果没有此请求，`merge` Git 引用将过期，直到有人查看拉取请求。 +使用 API 需要明确请求拉取请求来创建一个 _测试_ 合并提交。在 UI 中查看拉取请求并显示“合并”按钮时，或者使用 REST API [获取](/rest/reference/pulls#get-a-pull-request)、[创建](/rest/reference/pulls#create-a-pull-request)或 [编辑](/rest/reference/pulls#update-a-pull-request)拉取请求时，将创建一个 _测试_ 合并提交。如果没有此请求，`merge` Git 引用将过期，直到有人查看拉取请求。 如果当前正在使用会生成过时 `merge` Git 引用的轮询方法，GitHub 建议使用以下步骤从默认分支获取最新更改： 1. 接收拉取请求 web 挂钩。 2. 调用 [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/reference/pulls#get-a-pull-request) 以启动创建合并提交候选项的后台作业。 -3. 使用 [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/reference/pulls#get-a-pull-request) 轮询存储库以查看是否 `mergeable` 属性为 `true` 或 `false`。 只有在执行上述步骤后，才能直接使用 Git 或 [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/reference/git#get-a-reference) 更新 `merge` Git 引用。 +3. 使用 [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/reference/pulls#get-a-pull-request) 轮询存储库以查看是否 `mergeable` 属性为 `true` 或 `false`。只有在执行上述步骤后，才能直接使用 Git 或 [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/reference/git#get-a-reference) 更新 `merge` Git 引用。 diff --git a/translations/zh-CN/content/rest/guides/index.md b/translations/zh-CN/content/rest/guides/index.md index 6f681d6716de..9d27ba4a7b1e 100644 --- a/translations/zh-CN/content/rest/guides/index.md +++ b/translations/zh-CN/content/rest/guides/index.md @@ -30,6 +30,6 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '146200128' --- -文档的这一部分旨在让你使用实际的 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 应用程序开始运行。 我们将介绍你需要了解的所有内容，从身份验证到结果操作，再到将结果与其他应用集成。 +文档的这一部分旨在让你使用实际的 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 应用程序开始运行。我们将介绍你需要了解的所有内容，从身份验证到结果操作，再到将结果与其他应用集成。 每个教程都将包含一个项目，每个项目都将保存并记录在我们的公共[平台示例](https://github.com/github/platform-samples)存储库中。 ![章鱼猫](/assets/images/electrocat.png) diff --git a/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md b/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md index 6cbc24369aea..9e6b22f19bb6 100644 --- a/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md +++ b/translations/zh-CN/content/rest/guides/rendering-data-as-graphs.md @@ -18,15 +18,15 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/09/2022 ms.locfileid: '147875987' --- -在本指南中，我们将使用 API 来获取有关我们拥有的存储库以及构成这些存储库的编程语言的信息。 然后，我们将使用 [D3.js][D3.js] 库来以几种不同的方式可视化这些信息。 若要与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互，我们将使用出色的 Ruby 库 [Octokit][Octokit]。 +在本指南中，我们将使用 API 来获取有关我们拥有的存储库以及构成这些存储库的编程语言的信息。然后，我们将使用 [D3.js][D3.js] 库来以几种不同的方式可视化这些信息。若要与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行交互，我们将使用出色的 Ruby 库 [Octokit][Octokit]。 -在开始本示例之前，应阅读[“身份验证基础知识”][basics-of-authentication]指南（如果尚未阅读）。 可以在 [platform-samples][platform samples] 存储库中找到此项目的完整源代码。 +在开始本示例之前，应阅读 [“身份验证基础知识”][basics-of-authentication] 指南（如果尚未阅读）。可以在 [platform-samples][platform samples] 存储库中找到此项目的完整源代码。 我们马上开始！ ## 设置 OAuth 应用程序 -首先，在 {% data variables.product.product_name %} 上[注册新应用程序][new oauth application]。 将主 URL 和回叫 URL 设置为 `http://localhost:4567/`。 与 [以前一][basics-of-authentication]样，我们将使用 [sinatra-auth-github][sinatra auth github] 实现机架中间件来处理 API 的身份验证： +首先，在 {% data variables.product.product_name %} 上 [注册新应用程序][new oauth application]。将主 URL 和回叫 URL 设置为 `http://localhost:4567/`。与 [以前一][basics-of-authentication] 样，我们将使用 [sinatra-auth-github][sinatra auth github] 实现机架中间件来处理 API 的身份验证： ``` ruby require 'sinatra/auth/github' @@ -79,9 +79,9 @@ run Example::MyGraphApp ## 获取仓库信息 -这一次，为了与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 通信，我们将使用 [Octokit Ruby 库][Octokit]。 这比直接进行一大堆 REST 调用要容易得多。 另外，Octokit 是由 GitHubber 开发的，并且一直在积极维护，因此可以确保有效性。 +这一次，为了与 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 通信，我们将使用 [Octokit Ruby 库][Octokit]。这比直接进行一大堆 REST 调用要容易得多。另外，Octokit 是由 GitHubber 开发的，并且一直在积极维护，因此可以确保有效性。 -通过 Octokit 进行 API 身份验证非常简单。 只需将登录名和令牌传递到 `Octokit::Client` 构造函数： +通过 Octokit 进行 API 身份验证非常简单。只需将登录名和令牌传递到 `Octokit::Client` 构造函数： ``` ruby if !authenticated? @@ -91,7 +91,7 @@ else end ``` -我们来用仓库的数据做一些有趣的事情。 我们将看到它们使用的不同编程语言，并计算出哪些是最常用的。 为此，我们首先需要从 API 获取仓库列表。 +我们来用仓库的数据做一些有趣的事情。我们将看到它们使用的不同编程语言，并计算出哪些是最常用的。为此，我们首先需要从 API 获取仓库列表。 使用 Octokit 时，其代码如下所述： ``` ruby @@ -122,14 +122,14 @@ languages.to_s {"JavaScript"=>13, "PHP"=>1, "Perl"=>1, "CoffeeScript"=>2, "Python"=>1, "Java"=>3, "Ruby"=>3, "Go"=>1, "C++"=>1} ``` -到目前为止，进展不错，但结果不是很人性化。 可视化将非常有助于我们理解这些语言计数是如何分布的。 现在将这些计数输入到 D3 中，得到一个表示语言使用频率的简洁条形图。 +到目前为止，进展不错，但结果不是很人性化。可视化将非常有助于我们理解这些语言计数是如何分布的。现在将这些计数输入到 D3 中，得到一个表示语言使用频率的简洁条形图。 ## 可视化语言计数 D3.js（或仅 D3）是用于创建多种图表、图形和交互式可视化内容的综合库。 D3 的详细用法超出了本指南的范围，推荐阅读一篇不错的介绍性文章：[“面向大众的 D3”][D3 mortals]。 -D3 是一个JavaScript 库，喜欢以数组的形式处理数据。 因此，让我们将 Ruby 哈希转换为 JSON 数组，以供浏览器中的 JavaScript 使用。 +D3 是一个 JavaScript 库，喜欢以数组的形式处理数据。因此，让我们将 Ruby 哈希转换为 JSON 数组，以供浏览器中的 JavaScript 使用。 ``` ruby languages = [] @@ -140,7 +140,7 @@ end erb :lang_freq, :locals => { :languages => languages.to_json} ``` -我们只需遍历对象中的每个键值对，然后将它们推送到新的数组内。 我们之前没有这样做是因为我们不想在创建 `language_obj` 对象的过程中遍历它。 +我们只需遍历对象中的每个键值对，然后将它们推送到新的数组内。我们之前没有这样做是因为我们不想在创建 `language_obj` 对象的过程中遍历它。 现在，lang_freq.erb 将需要一些 JavaScript 来支持渲染条形图。 以后，只需使用此处提供的代码，如果想详细了解 D3 的工作原理，可以参考上面链接的资源： @@ -224,15 +224,15 @@ erb :lang_freq, :locals => { :languages => languages.to_json} ``` -呼！ 同样，不必担心这段代码的主要功能。 这里值得注意的是顶行--`var data = <%= languages %>;`--它表示我们正在将先前创建的 `languages` 数组传递到 ERB 中进行处理。 +呼！同样，不必担心这段代码的主要功能。这里值得注意的是顶行--`var data = <%= languages %>;`--它表示我们正在将先前创建的 `languages` 数组传递到 ERB 中进行处理。 -如“面向大众的 D3”所述，这未必是 D3 的最佳用法。 但它确实表明了如何配合使用该库与 Octokit，实现一些很棒的操作。 +如“面向大众的 D3”所述，这未必是 D3 的最佳用法。但它确实表明了如何配合使用该库与 Octokit，实现一些很棒的操作。 ## 结合不同的 API 调用 -现在是时候坦白了：存储库中的 `language` 属性仅标识定义的“主要”语言。 这意味着，如果存储库结合了多种语言，则代码字节数最多的语言将被视为主要语言。 +现在是时候坦白了：存储库中的 `language` 属性仅标识定义的“主要”语言。这意味着，如果存储库结合了多种语言，则代码字节数最多的语言将被视为主要语言。 -让我们结合使用几个 API 调用来真正呈现哪种语言在我们所有代码中写入的字节数最多。 相比简单的计数，[树状图][D3 treemap]应是直观展示编码语言使用量的好方法。 我们需要构造一个如下所示的对象数组： +让我们结合使用几个 API 调用来真正呈现哪种语言在我们所有代码中写入的字节数最多。相比简单的计数，[树状图][D3 treemap] 应是直观展示编码语言使用量的好方法。我们需要构造一个如下所示的对象数组： ``` json [ { "name": "language1", "size": 100}, @@ -241,7 +241,7 @@ erb :lang_freq, :locals => { :languages => languages.to_json} ] ``` -我们在前面已经获取了存储库列表，现在我们来检查每个存储库，然后调用[语言列表 API 方法][language API]： +我们在前面已经获取了存储库列表，现在我们来检查每个存储库，然后调用 [语言列表 API 方法][language API]： ``` ruby repos.each do |repo| @@ -273,7 +273,7 @@ end language_bytes = [ :name => "language_bytes", :elements => language_byte_count] ``` -（有关 D3 树状图的详细信息，请查看[此简单教程][language API]。） +（有关 D3 树状图的详细信息，请查看 [此简单教程][language API]。） 最后，我们将这些 JSON 信息传递到同一个 ERB 模板： @@ -331,7 +331,7 @@ erb :lang_freq, :locals => { :languages => languages.to_json, :language_byte_cou ``` -瞧！ 包含存储库语言信息的精美矩形，按相对比例显示，让你一目了然。 可能需要调整树状图的高度和宽度（作为前两个参数传递到上述 `drawTreemap`），使所有信息适当显示。 +瞧！包含存储库语言信息的精美矩形，按相对比例显示，让你一目了然。可能需要调整树状图的高度和宽度（作为前两个参数传递到上述 `drawTreemap`），使所有信息适当显示。 [D3.js]: http://d3js.org/ diff --git a/translations/zh-CN/content/rest/guides/traversing-with-pagination.md b/translations/zh-CN/content/rest/guides/traversing-with-pagination.md index 02f3bbece54f..5ae3eef19c3a 100644 --- a/translations/zh-CN/content/rest/guides/traversing-with-pagination.md +++ b/translations/zh-CN/content/rest/guides/traversing-with-pagination.md @@ -22,7 +22,7 @@ ms.locfileid: '145129043' {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 为开发人员提供了丰富的信息供他们使用。 大多数情况下，甚至可能会发现要求提供的信息太多，为了让服务器满意，API 会自动[对请求的项进行分页](/rest/overview/resources-in-the-rest-api#pagination)。 -在本指南中，我们将对搜索 API 进行一些调用，并使用分页对结果进行迭代。 可以在 [platform-samples][platform samples] 存储库中找到此项目的完整源代码。 +在本指南中，我们将对搜索 API 进行一些调用，并使用分页对结果进行迭代。可以在 [platform-samples][platform samples] 存储库中找到此项目的完整源代码。 {% data reusables.rest-api.dotcom-only-guide-note %} @@ -30,31 +30,31 @@ ms.locfileid: '145129043' 首先需要了解有关接收分页条目的一些事实： -1. 不同的 API 调用响应具有不同的默认值。 例如，对[列出公共存储库](/rest/reference/repos#list-public-repositories)的调用以 30 个为一组提供分页项，而对 GitHub 搜索 API 的调用以 100 个为一组提供项 +1. 不同的 API 调用响应具有不同的默认值。例如，对[列出公共存储库](/rest/reference/repos#list-public-repositories)的调用以 30 个为一组提供分页项，而对 GitHub 搜索 API 的调用以 100 个为一组提供项 2. 您可以指定要接收的条目数（最多 100 个）；但是， -3. 出于技术原因，并非每个端点的行为都相同。 例如，[事件](/rest/reference/activity#events)不允许设置接收项的最大值。 +3. 出于技术原因，并非每个端点的行为都相同。例如，[事件](/rest/reference/activity#events)不允许设置接收项的最大值。 请务必阅读关于如何处理特定端点分页结果的文档。 -API 调用的[链接标头](https://datatracker.ietf.org/doc/html/rfc5988)中提供了有关分页的信息。 例如，我们向搜索 API 发出 curl 请求，以了解 Mozilla 项目使用短语 `addClass` 的次数： +API 调用的[链接标头](https://datatracker.ietf.org/doc/html/rfc5988)中提供了有关分页的信息。例如，我们向搜索 API 发出 curl 请求，以了解 Mozilla 项目使用短语 `addClass` 的次数： ```shell $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla" ``` -`-I` 参数表示仅关注标头，而不关注实际内容。 在检查结果时，你会注意到链接标头中的一些信息如下所示： +`-I` 参数表示仅关注标头，而不关注实际内容。在检查结果时，你会注意到链接标头中的一些信息如下所示： Link: ; rel="next", ; rel="last" -我们来分解说明。 `rel="next"` 表示下一页是 `page=2`。 这是合理的，因为在默认情况下，所有分页查询都是从第 `1.` 页开始，`rel="last"` 提供了更多信息，指示结果的最后一页第 `34` 页。 +我们来分解说明。 `rel="next"` 表示下一页是 `page=2`。这是合理的，因为在默认情况下，所有分页查询都是从第 `1.` 页开始，`rel="last"` 提供了更多信息，指示结果的最后一页第 `34` 页。 因此，还有 33 页关于 `addClass` 的信息可供使用。 很好！ -始终依赖提供给你的这些链接关系。 不要试图猜测或构建自己的 URL。 +始终依赖提供给你的这些链接关系。不要试图猜测或构建自己的 URL。 ### 浏览页面 -现在你知道要接收多少页面，可以开始浏览页面以使用结果了。 可通过传入 `page` 参数来执行此操作。 默认情况下，`page` 始终从 `1` 开始。 让我们跳到第 14 页，看看会发生什么： +现在你知道要接收多少页面，可以开始浏览页面以使用结果了。可通过传入 `page` 参数来执行此操作。默认情况下，`page` 始终从 `1` 开始。让我们跳到第 14 页，看看会发生什么： ```shell $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla&page=14" @@ -67,11 +67,11 @@ $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla&page=14" ; rel="first", ; rel="prev" -正如预期的那样，`rel="next"` 是第 15 页，而 `rel="last"` 仍是第 34 页。 但现在我们得到了更多信息：`rel="first"` 表示第一页的 URL，更重要的是，可通过 `rel="prev"` 知道上一页的页码。 使用此信息，可以构建一些 UI，让用户在 API 调用中的第一个、上一个、下一个或最后一个结果列表之间跳转。 +正如预期的那样，`rel="next"` 是第 15 页，而 `rel="last"` 仍是第 34 页。但现在我们得到了更多信息：`rel="first"` 表示第一页的 URL，更重要的是，可通过 `rel="prev"` 知道上一页的页码。使用此信息，可以构建一些 UI，让用户在 API 调用中的第一个、上一个、下一个或最后一个结果列表之间跳转。 ### 更改接收的条目数量 -通过传递 `per_page` 参数，可以指定希望每个页面返回的项数，最多 100 个项。 让我们尝试询问关于 `addClass` 的 50 个项： +通过传递 `per_page` 参数，可以指定希望每个页面返回的项数，最多 100 个项。让我们尝试询问关于 `addClass` 的 50 个项： ```shell $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla&per_page=50" @@ -82,13 +82,13 @@ $ curl -I "https://api.github.com/search/code?q=addClass+user:mozilla&per_page=5 Link: ; rel="next", ; rel="last" -你可能已经猜到了，`rel="last"` 信息表示最后一页现在是第 20 页。 这是因为我们要求每页提供有关我们结果的更多信息。 +你可能已经猜到了，`rel="last"` 信息表示最后一页现在是第 20 页。这是因为我们要求每页提供有关我们结果的更多信息。 ## 使用信息 你不希望仅仅为了能够使用分页而进行低级别的 curl 调用，因此让我们编写一个小的 Ruby 脚本，该脚本可完成上面所描述的所有内容。 -照常，首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库，并传入[个人访问令牌][personal token]： +照常，首先需要 [GitHub 的 Octokit.rb][octokit.rb] Ruby 库，并传入 [个人访问令牌][personal token]： ``` ruby require 'octokit' @@ -98,15 +98,15 @@ require 'octokit' client = Octokit::Client.new :access_token => ENV['MY_PERSONAL_TOKEN'] ``` -接下来，将使用 Octokit 的 `search_code` 方法执行搜索。 与使用 `curl` 不同的是，我们还可以立即检索结果的数量，所以我们输入以下代码： +接下来，将使用 Octokit 的 `search_code` 方法执行搜索。与使用 `curl` 不同的是，我们还可以立即检索结果的数量，所以我们输入以下代码： ``` ruby results = client.search_code('addClass user:mozilla') total_count = results.total_count ``` -现在，我们来获取最后一页的页码，类似于链接标头中的 `page=34>; rel="last"` 信息。 Octokit.rb 通过一个名为“[超媒体链接关系][hypermedia-relations]”的实现来支持分页信息。 -我们不会对这种关系展开详细讨论，只想提醒你，`results` 变量中的每个元素都有一个称为 `rels` 的哈希，它可以包含有关 `:next`、`:last`、`:first` 和 `:prev` 的信息，具体取决于所得到的结果。 这些关系还包含通过调用 `rels[:last].href` 所得 URL 的相关信息。 +现在，我们来获取最后一页的页码，类似于链接标头中的 `page=34>; rel="last"` 信息。Octokit.rb 通过一个名为“[超媒体链接关系][hypermedia-relations]”的实现来支持分页信息。 +我们不会对这种关系展开详细讨论，只想提醒你，`results` 变量中的每个元素都有一个称为 `rels` 的哈希，它可以包含有关 `:next`、`:last`、`:first` 和 `:prev` 的信息，具体取决于所得到的结果。这些关系还包含通过调用 `rels[:last].href` 所得 URL 的相关信息。 知道了这一点后，我们来获取最后一个结果的页码，并将所有这些信息呈现给用户： @@ -117,8 +117,8 @@ number_of_pages = last_response.rels[:last].href.match(/page=(\d+).*$/)[1] puts "There are #{total_count} results, on #{number_of_pages} pages!" ``` -最后，我们来遍历结果。 可使用循环 `for i in 1..number_of_pages.to_i` 来实现此目的，但是，让我们遵循 `rels[:next]` 标头以从每个页面检索信息。 为简单起见，我们只获取每个页面中第一个结果的文件路径。 为此，我们需要一个循环；在每个循环结束时，我们将根据 `rels[:next]` 信息来检索下一页的数据集。 -当没有 `rels[:next]` 信息可供使用（也就是说，我们位于 `rels[:last]`）时，循环将结束。 它应如下所示： +最后，我们来遍历结果。可使用循环 `for i in 1..number_of_pages.to_i` 来实现此目的，但是，让我们遵循 `rels[:next]` 标头以从每个页面检索信息。为简单起见，我们只获取每个页面中第一个结果的文件路径。为此，我们需要一个循环；在每个循环结束时，我们将根据 `rels[:next]` 信息来检索下一页的数据集。 +当没有 `rels[:next]` 信息可供使用（也就是说，我们位于 `rels[:last]`）时，循环将结束。它应如下所示： ``` ruby puts last_response.data.items.first.path @@ -128,7 +128,7 @@ until last_response.rels[:next].nil? end ``` -使用 Octokit.rb 更改每页的条目数非常简单。 只需将 `per_page` 选项哈希传递给初始客户端构造。 之后，代码应保持不变： +使用 Octokit.rb 更改每页的条目数非常简单。只需将 `per_page` 选项哈希传递给初始客户端构造。之后，代码应保持不变： ``` ruby require 'octokit' diff --git a/translations/zh-CN/content/rest/guides/working-with-comments.md b/translations/zh-CN/content/rest/guides/working-with-comments.md index 902b7d95c3d1..8790001202c4 100644 --- a/translations/zh-CN/content/rest/guides/working-with-comments.md +++ b/translations/zh-CN/content/rest/guides/working-with-comments.md @@ -18,17 +18,17 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/10/2022 ms.locfileid: '145129040' --- -对于任何拉取请求，{% data variables.product.product_name %} 提供三种类型的注释视图：针对整个拉取请求的[拉取请求注释][PR comment]、针对拉取请求内的[特定行的注释][PR line comment]，以及针对拉取请求内的[特定提交的注释][commit comment]。 +对于任何拉取请求，{% data variables.product.product_name %} 提供三种类型的注释视图：针对整个拉取请求的 [拉取请求注释][PR comment]、针对拉取请求内的 [特定行的注释][PR line comment]，以及针对拉取请求内的 [特定提交的注释][commit comment]。 每种类型的评论都会经过 API {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} 的不同部分。 -在本指南中，我们将探讨如何访问和处理每种注释。 对于每个示例，我们将使用在“octocat”存储库上[发出的此示例拉取请求][sample PR]。 和往常一样，可以在[平台示例存储库][platform-samples]中找到示例。 +在本指南中，我们将探讨如何访问和处理每种注释。对于每个示例，我们将使用在“octocat”存储库上 [发出的此示例拉取请求][sample PR]。和往常一样，可以在 [平台示例存储库][platform-samples] 中找到示例。 ## 拉取请求注释 -若要访问针对拉取请求的注释，请浏览[问题 API][issues]。 -乍一看这似乎不符合直觉。 但是，一旦你理解了拉取请求只是包含代码的问题，使用问题 API 来针对拉取请求创建注释就合情合理了。 +若要访问针对拉取请求的注释，请浏览 [问题 API][issues]。 +乍一看这似乎不符合直觉。但是，一旦你理解了拉取请求只是包含代码的问题，使用问题 API 来针对拉取请求创建注释就合情合理了。 -我们将演示如何使用 [Octokit.rb][octokit.rb] 创建 Ruby 脚本来提取拉取请求注释。 你还需要创建[个人访问令牌][personal token]。 +我们将演示如何使用 [Octokit.rb][octokit.rb] 创建 Ruby 脚本来提取拉取请求注释。你还需要创建 [个人访问令牌][personal token]。 以下代码应该可以帮助你开始使用 Octokit.rb 访问拉取请求中的注释： @@ -48,11 +48,11 @@ client.issue_comments("octocat/Spoon-Knife", 1176).each do |comment| end ``` -在这里，我们专门调用问题 API 来获取注释 (`issue_comments`)，同时提供存储库的名称 (`octocat/Spoon-Knife`)，以及我们感兴趣的拉取请求 ID (`1176`)。 之后，只需遍历注释以获取有关每个注释的信息即可。 +在这里，我们专门调用问题 API 来获取注释 (`issue_comments`)，同时提供存储库的名称 (`octocat/Spoon-Knife`)，以及我们感兴趣的拉取请求 ID (`1176`)。之后，只需遍历注释以获取有关每个注释的信息即可。 ## 拉取请求行注释 -在差异视图中，你可以针对在拉取请求中进行的某个更改的特定方面开启讨论。 这些注释出现在已更改文件中的各个行上。 此讨论的终结点 URL 来自[拉取请求评审 API][PR Review API]。 +在差异视图中，你可以针对在拉取请求中进行的某个更改的特定方面开启讨论。这些注释出现在已更改文件中的各个行上。此讨论的终结点 URL 来自 [拉取请求评审 API][PR Review API]。 以下代码将获取文件中所做的所有拉取请求注释（给定一个拉取请求编号）： @@ -74,15 +74,15 @@ client.pull_request_comments("octocat/Spoon-Knife", 1176).each do |comment| end ``` -您会注意到，它与上面的示例非常相似。 此视图与拉取请求注释之间的不同之处在于对话的焦点。 -对拉取请求的注释应予以保留，以供讨论或就代码的总体方向提出意见。 在拉取请求评审中所做的注释应该以在文件中实施特定更改的方式进行专门处理。 +您会注意到，它与上面的示例非常相似。此视图与拉取请求注释之间的不同之处在于对话的焦点。 +对拉取请求的注释应予以保留，以供讨论或就代码的总体方向提出意见。在拉取请求评审中所做的注释应该以在文件中实施特定更改的方式进行专门处理。 ## 提交注释 -最后一类注释专门针对单个提交。 因此，它们使用[提交注释 API][commit comment API]。 +最后一类注释专门针对单个提交。因此，它们使用 [提交注释 API][commit comment API]。 要检索对提交的注释，您需要使用该提交的 SHA1。 -换句话说，您不能使用与拉取请求相关的任何标识符。 下面是一个示例： +换句话说，您不能使用与拉取请求相关的任何标识符。下面是一个示例： ``` ruby require 'octokit' diff --git a/translations/zh-CN/content/rest/interactions/index.md b/translations/zh-CN/content/rest/interactions/index.md index 10e19227ac07..e31bd6eac460 100644 --- a/translations/zh-CN/content/rest/interactions/index.md +++ b/translations/zh-CN/content/rest/interactions/index.md @@ -21,4 +21,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/12/2022 ms.locfileid: '147886780' --- -用户通过评论、开设议题和创建拉取请求与仓库进行交互。 交互 API 允许具有公共仓库所有者或具有管理员访问权限的用户临时将与公共仓库的交互限于特定类型的用户。 +用户通过评论、开设议题和创建拉取请求与仓库进行交互。交互 API 允许具有公共仓库所有者或具有管理员访问权限的用户临时将与公共仓库的交互限于特定类型的用户。 diff --git a/translations/zh-CN/content/rest/interactions/orgs.md b/translations/zh-CN/content/rest/interactions/orgs.md index 150afbef3468..7c28cfc28a8b 100644 --- a/translations/zh-CN/content/rest/interactions/orgs.md +++ b/translations/zh-CN/content/rest/interactions/orgs.md @@ -24,4 +24,4 @@ ms.locfileid: '147062464' * 组织中的 {% data reusables.interactions.contributor-user-limit-definition %}。 * 组织中的 {% data reusables.interactions.collaborator-user-limit-definition %}。 -在组织级别设置交互限制将覆盖为组织拥有的各个仓库设置的任何交互限制。 要为组织拥有的个别存储库设置不同的交互限制，请改为使用[存储库](#repository)交互终结点。 +在组织级别设置交互限制将覆盖为组织拥有的各个仓库设置的任何交互限制。要为组织拥有的个别存储库设置不同的交互限制，请改为使用[存储库](#repository)交互终结点。 diff --git a/translations/zh-CN/content/rest/interactions/repos.md b/translations/zh-CN/content/rest/interactions/repos.md index b67d466ca45b..8591ca18ba86 100644 --- a/translations/zh-CN/content/rest/interactions/repos.md +++ b/translations/zh-CN/content/rest/interactions/repos.md @@ -24,4 +24,4 @@ ms.locfileid: '147064664' * 仓库中的 {% data reusables.interactions.contributor-user-limit-definition %}。 * 仓库中的 {% data reusables.interactions.collaborator-user-limit-definition %}。 -如果对拥有该仓库的用户或组织启用了交互限制，单个仓库的限制就不能更改。 而应使用[用户](#user)或[组织](#organization)交互终结点来更改交互限制。 +如果对拥有该仓库的用户或组织启用了交互限制，单个仓库的限制就不能更改。而应使用[用户](#user)或[组织](#organization)交互终结点来更改交互限制。 diff --git a/translations/zh-CN/content/rest/interactions/user.md b/translations/zh-CN/content/rest/interactions/user.md index 1c6e418ee71d..6cd922c89ba6 100644 --- a/translations/zh-CN/content/rest/interactions/user.md +++ b/translations/zh-CN/content/rest/interactions/user.md @@ -24,4 +24,4 @@ ms.locfileid: '147066896' * 与仓库交互产生的 {% data reusables.interactions.contributor-user-limit-definition %}。 * 与仓库交互产生的 {% data reusables.interactions.collaborator-user-limit-definition %}。 -在用户级别设置交互限制将覆盖为用户拥有的各个仓库设置的任何交互限制。 要为用户拥有的个别存储库设置不同的交互限制，请使用[存储库](#repository)交互终结点。 +在用户级别设置交互限制将覆盖为用户拥有的各个仓库设置的任何交互限制。要为用户拥有的个别存储库设置不同的交互限制，请使用[存储库](#repository)交互终结点。 diff --git a/translations/zh-CN/content/rest/issues/events.md b/translations/zh-CN/content/rest/issues/events.md index 62ebdcdc29a3..9c20849a6f0c 100644 --- a/translations/zh-CN/content/rest/issues/events.md +++ b/translations/zh-CN/content/rest/issues/events.md @@ -20,6 +20,6 @@ ms.locfileid: '147876070' --- ## 关于问题事件 API -问题事件 API 可以返回问题和拉取请求中的活动所触发的不同类型的事件。 有关可从问题事件 API 接收的特定事件的详细信息，请参阅“[问题事件类型](/developers/webhooks-and-events/issue-event-types)”。 有关可以从议题事件 API 接收的特定事件的更多信息，请参阅“议题事件类型”。 有关详细信息，请参阅“[事件 API](/developers/webhooks-and-events/github-event-types)”。 +问题事件 API 可以返回问题和拉取请求中的活动所触发的不同类型的事件。有关可从问题事件 API 接收的特定事件的详细信息，请参阅“[问题事件类型](/developers/webhooks-and-events/issue-event-types)”。有关可以从议题事件 API 接收的特定事件的更多信息，请参阅“议题事件类型”。有关详细信息，请参阅“[事件 API](/developers/webhooks-and-events/github-event-types)”。 {% data reusables.pull_requests.issues-pr-shared-api %} diff --git a/translations/zh-CN/content/rest/issues/timeline.md b/translations/zh-CN/content/rest/issues/timeline.md index efb74200a821..b20326d8d4b5 100644 --- a/translations/zh-CN/content/rest/issues/timeline.md +++ b/translations/zh-CN/content/rest/issues/timeline.md @@ -20,7 +20,7 @@ ms.locfileid: '147061872' --- ## 关于时间线事件 API -时间线事件 API 可以返回问题和拉取请求中的时间线活动所触发的不同类型的事件。 有关可从议题事件 API 接收的特定事件的详细信息，请参阅“[议题事件类型](/developers/webhooks-and-events/issue-event-types)”。 有关可以从议题事件 API 接收的特定事件的更多信息，请参阅“议题事件类型”。 有关详细信息，请参阅“[GitHub 事件 API](/developers/webhooks-and-events/github-event-types)”。 +时间线事件 API 可以返回问题和拉取请求中的时间线活动所触发的不同类型的事件。有关可从议题事件 API 接收的特定事件的详细信息，请参阅“[议题事件类型](/developers/webhooks-and-events/issue-event-types)”。有关可以从议题事件 API 接收的特定事件的更多信息，请参阅“议题事件类型”。有关详细信息，请参阅“[GitHub 事件 API](/developers/webhooks-and-events/github-event-types)”。 您可以使用此 API 显示有关议题和拉取请求的信息，或确定应向谁通知议题评论。 diff --git a/translations/zh-CN/content/rest/licenses.md b/translations/zh-CN/content/rest/licenses.md index 184edbefa8b5..1a54270e768e 100644 --- a/translations/zh-CN/content/rest/licenses.md +++ b/translations/zh-CN/content/rest/licenses.md @@ -20,7 +20,7 @@ ms.locfileid: '147064864' --- ## 关于许可证 API -许可 API 使用[开源 Ruby Gem 许可接收方](https://github.com/benbalter/licensee) 来尝试标识项目的许可。 许可接收方将项目的 `LICENSE` 文件（如果有）的内容与已知许可的简短列表相匹配。 因此，API 不考虑项目依赖项的许可或其他记录项目许可的方式，例如对文档中许可名称的引用。 +许可 API 使用[开源 Ruby Gem 许可接收方](https://github.com/benbalter/licensee) 来尝试标识项目的许可。许可接收方将项目的 `LICENSE` 文件（如果有）的内容与已知许可的简短列表相匹配。因此，API 不考虑项目依赖项的许可或其他记录项目许可的方式，例如对文档中许可名称的引用。 如果许可匹配，则返回的许可密钥和名称符合 [SPDX 规范](https://spdx.org/)。 @@ -35,8 +35,8 @@ ms.locfileid: '147064864' {% warning %} -GitHub 有很多功能， 但它不是律师事务所。 因此，GitHub 不提供法律建议。 使用许可 API 或向我们发送电子邮件并不构成法律意见，也不形成律师-客户关系。 如果您对特定许可可以做什么和不能做什么有任何疑问，您应该在继续之前先咨询自己的法律顾问。 事实上，在做出任何可能具有法律后果或影响您合法权利的决定之前，您都应该咨询自己的律师。 +GitHub 有很多功能，但它不是律师事务所。因此，GitHub 不提供法律建议。使用许可 API 或向我们发送电子邮件并不构成法律意见，也不形成律师-客户关系。如果您对特定许可可以做什么和不能做什么有任何疑问，您应该在继续之前先咨询自己的法律顾问。事实上，在做出任何可能具有法律后果或影响您合法权利的决定之前，您都应该咨询自己的律师。 -GitHub 创建了许可 API，旨在帮助用户获取有关开源许可以及使用它们的项目的信息。 我们希望它有帮助，但请记住，我们不是律师（至少大多数人不是），像其他人一样，我们也会犯错。 因此，GitHub“按原样”提供 API，对提供或通过其提供的任何信息或许可不做任何保证，并对使用 API 所造成的损害不承担责任。 +GitHub 创建了许可 API，旨在帮助用户获取有关开源许可以及使用它们的项目的信息。我们希望它有帮助，但请记住，我们不是律师（至少大多数人不是），像其他人一样，我们也会犯错。因此，GitHub“按原样”提供 API，对提供或通过其提供的任何信息或许可不做任何保证，并对使用 API 所造成的损害不承担责任。 {% endwarning %} diff --git a/translations/zh-CN/content/rest/metrics/statistics.md b/translations/zh-CN/content/rest/metrics/statistics.md index 5a5d4867d6de..c10932b1dcfa 100644 --- a/translations/zh-CN/content/rest/metrics/statistics.md +++ b/translations/zh-CN/content/rest/metrics/statistics.md @@ -24,7 +24,7 @@ ms.locfileid: '147066128' ### 谈一谈缓存 -计算存储库统计信息是一项昂贵的操作，所以我们尽可能返回缓存的数据。 如果你查询存储库的统计信息时数据尚未缓存，你将会收到 `202` 响应；同时触发后台作业以开始编译这些统计信息。 稍等片刻，待作业完成，然后再次提交请求。 如果作业已完成，该请求将返回 `200` 响应，响应正文中包含统计信息。 +计算存储库统计信息是一项昂贵的操作，所以我们尽可能返回缓存的数据。如果你查询存储库的统计信息时数据尚未缓存，你将会收到 `202` 响应；同时触发后台作业以开始编译这些统计信息。稍等片刻，待作业完成，然后再次提交请求。如果作业已完成，该请求将返回 `200` 响应，响应正文中包含统计信息。 仓库统计信息由仓库默认分支的 SHA 缓存；推送到默认分支将重置统计信息缓存。 diff --git a/translations/zh-CN/content/rest/metrics/traffic.md b/translations/zh-CN/content/rest/metrics/traffic.md index bf5ba25ff85d..5a65bfa77354 100644 --- a/translations/zh-CN/content/rest/metrics/traffic.md +++ b/translations/zh-CN/content/rest/metrics/traffic.md @@ -18,4 +18,4 @@ ms.locfileid: '147064847' --- ## 关于存储库流量 API -对于你具有推送访问权限的存储库，存储库流量 API 提供对存储库图中提供的信息的访问权限。 有关详细信息，请参阅“[查看存储库的流量](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)”。 +对于你具有推送访问权限的存储库，存储库流量 API 提供对存储库图中提供的信息的访问权限。有关详细信息，请参阅“[查看存储库的流量](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)”。 diff --git a/translations/zh-CN/content/rest/migrations/orgs.md b/translations/zh-CN/content/rest/migrations/orgs.md index 90f2c71fc3c7..083a4e0af4a1 100644 --- a/translations/zh-CN/content/rest/migrations/orgs.md +++ b/translations/zh-CN/content/rest/migrations/orgs.md @@ -20,6 +20,6 @@ ms.locfileid: '147883487' --- ## 关于组织迁移 API -迁移 API 仅适用于经过身份验证的组织所有者。 有关详细信息，请参阅“[组织中的角色](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)”和“[其他身份验证方法](/rest/overview/other-authentication-methods)”。 +迁移 API 仅适用于经过身份验证的组织所有者。有关详细信息，请参阅“[组织中的角色](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)”和“[其他身份验证方法](/rest/overview/other-authentication-methods)”。 {% data variables.migrations.organization_migrations_intro %} diff --git a/translations/zh-CN/content/rest/migrations/source-imports.md b/translations/zh-CN/content/rest/migrations/source-imports.md index 3644b3e9bee1..b5bab270a7d8 100644 --- a/translations/zh-CN/content/rest/migrations/source-imports.md +++ b/translations/zh-CN/content/rest/migrations/source-imports.md @@ -16,7 +16,7 @@ ms.locfileid: '147065768' --- ## 关于源导入 API -{% data variables.migrations.source_imports_intro %} 如果导入中存在大型文件，则典型的源导入将开始导入，然后（可选）更新作者和/或更新使用 Git LFS 的首选项。 还可以创建一个用于侦听 [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) 的 Webhook 来了解导入状态。 +{% data variables.migrations.source_imports_intro %} 如果导入中存在大型文件，则典型的源导入将开始导入，然后（可选）更新作者和/或更新使用 Git LFS 的首选项。还可以创建一个用于侦听 [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) 的 Webhook 来了解导入状态。 在此图中可以看到更详细的示例： diff --git a/translations/zh-CN/content/rest/migrations/users.md b/translations/zh-CN/content/rest/migrations/users.md index 2ec781d36de4..3551d64d9991 100644 --- a/translations/zh-CN/content/rest/migrations/users.md +++ b/translations/zh-CN/content/rest/migrations/users.md @@ -20,10 +20,10 @@ ms.locfileid: '145101203' --- ## 关于用户迁移 API -用户迁移 API 仅适用于经过身份验证的帐户所有者。 有关详细信息，请参阅“[其他身份验证方法](/rest/overview/other-authentication-methods)”。 +用户迁移 API 仅适用于经过身份验证的帐户所有者。有关详细信息，请参阅“[其他身份验证方法](/rest/overview/other-authentication-methods)”。 {% data variables.migrations.user_migrations_intro %} 有关可下载的迁移数据列表，请参阅“[下载用户迁移存档](#download-a-user-migration-archive)”。 -要下载存档，您需要先开始用户迁移。 在迁移状态为 `exported` 后，便可下载迁移。 +要下载存档，您需要先开始用户迁移。在迁移状态为 `exported` 后，便可下载迁移。 -创建迁移存档后，该存档可供下载七天。 但是，如果您喜欢，您可以更早删除用户迁移存档。 当迁移为 `exported` 时，可以解锁存储库以再次开始使用，如果你不再需要源数据，则可删除存储库。 +创建迁移存档后，该存档可供下载七天。但是，如果您喜欢，您可以更早删除用户迁移存档。当迁移为 `exported` 时，可以解锁存储库以再次开始使用，如果你不再需要源数据，则可删除存储库。 diff --git a/translations/zh-CN/content/rest/oauth-authorizations.md b/translations/zh-CN/content/rest/oauth-authorizations.md index 20f4a3d8c904..4a9ca3047f47 100644 --- a/translations/zh-CN/content/rest/oauth-authorizations.md +++ b/translations/zh-CN/content/rest/oauth-authorizations.md @@ -17,6 +17,6 @@ ms.locfileid: '147444667' --- ## 关于 OAuth 授权 API -您可以使用此 API 来管理 OAuth 应用程序对您帐户的访问权限。 只能使用用户名和密码（而非令牌）通过[基本身份验证](/rest/overview/other-authentication-methods#basic-authentication)访问此 API。 +您可以使用此 API 来管理 OAuth 应用程序对您帐户的访问权限。只能使用用户名和密码（而非令牌）通过[基本身份验证](/rest/overview/other-authentication-methods#basic-authentication)访问此 API。 如果你活你的用户启用了双因素身份验证，请确保了解如何[使用双因素身份验证](/rest/overview/other-authentication-methods#working-with-two-factor-authentication)。 diff --git a/translations/zh-CN/content/rest/orgs/blocking.md b/translations/zh-CN/content/rest/orgs/blocking.md index bc53b56ee15b..0a10c81339d6 100644 --- a/translations/zh-CN/content/rest/orgs/blocking.md +++ b/translations/zh-CN/content/rest/orgs/blocking.md @@ -15,4 +15,4 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '147065783' --- -用于对调用进行身份验证的令牌必须具有 `admin:org` 范围才可对组织进行任何阻止调用。 否则，响应将返回 `HTTP 404`。 +用于对调用进行身份验证的令牌必须具有 `admin:org` 范围才可对组织进行任何阻止调用。否则，响应将返回 `HTTP 404`。 diff --git a/translations/zh-CN/content/rest/orgs/webhooks.md b/translations/zh-CN/content/rest/orgs/webhooks.md index 81ab8007bc20..2659e7667977 100644 --- a/translations/zh-CN/content/rest/orgs/webhooks.md +++ b/translations/zh-CN/content/rest/orgs/webhooks.md @@ -26,7 +26,7 @@ ms.locfileid: '147066840' ### 作用域和限制 -对组织 web 挂钩的所有操作都需要经过身份验证的用户是所管理组织的管理员。 此外，OAuth 标记需要 `admin:org_hook` 作用域。 有关详细信息，请参阅“[OAuth 应用的作用域](/developers/apps/scopes-for-oauth-apps)”。 +对组织 web 挂钩的所有操作都需要经过身份验证的用户是所管理组织的管理员。此外，OAuth 标记需要 `admin:org_hook` 作用域。有关详细信息，请参阅“[OAuth 应用的作用域](/developers/apps/scopes-for-oauth-apps)”。 为了保护 web 挂钩配置中可能存在的敏感数据，我们还强制实施以下访问控制规则： @@ -35,10 +35,10 @@ ms.locfileid: '147066840' ### 接收 web 挂钩 -为了让 {% data variables.product.product_name %} 发送 web 挂钩有效负载，您的服务器需要能够从 Internet 访问。 我们还强烈建议使用 SSL，以便我们可以通过 HTTPS 发送加密的有效负载。 +为了让 {% data variables.product.product_name %} 发送 web 挂钩有效负载，您的服务器需要能够从 Internet 访问。我们还强烈建议使用 SSL，以便我们可以通过 HTTPS 发送加密的有效负载。 有关更多最佳做法，请[参阅我们的指南](/guides/best-practices-for-integrators/)。 #### Web 挂钩标头 -{% data variables.product.product_name %} 发送时将附带几个 HTTP 标头，以区分事件类型和有效负载标识符。 有关详细信息，请参阅 [Webhook标头](/webhooks/event-payloads/#delivery-headers)。 +{% data variables.product.product_name %} 发送时将附带几个 HTTP 标头，以区分事件类型和有效负载标识符。有关详细信息，请参阅 [Webhook 标头](/webhooks/event-payloads/#delivery-headers)。 diff --git a/translations/zh-CN/content/rest/overview/api-previews.md b/translations/zh-CN/content/rest/overview/api-previews.md index 4f8ac731724b..88f3e58a18a4 100644 --- a/translations/zh-CN/content/rest/overview/api-previews.md +++ b/translations/zh-CN/content/rest/overview/api-previews.md @@ -16,9 +16,9 @@ ms.locfileid: '147876003' --- API 预览允许您试用新的 API 以及对现有 API 方法的更改（在它们被纳入正式的 GitHub API 之前）。 -在预览期间，我们可以根据开发者的反馈更改某些功能。 如果我们确实进行了更改，我们将在[开发者博客](https://developer.github.com/changes/)上公布这些更改，而不会事先通知。 +在预览期间，我们可以根据开发者的反馈更改某些功能。如果我们确实进行了更改，我们将在[开发者博客](https://developer.github.com/changes/)上公布这些更改，而不会事先通知。 -要访问 API 预览，需要在请求的 `Accept` 标头中提供自定义[媒体类型](/rest/overview/media-types)。 每个预览的功能文档可指定要提供的自定义媒体类型。 +要访问 API 预览，需要在请求的 `Accept` 标头中提供自定义[媒体类型](/rest/overview/media-types)。每个预览的功能文档可指定要提供的自定义媒体类型。 {% ifversion ghes < 3.3 %} @@ -89,7 +89,7 @@ API 预览允许您试用新的 API 以及对现有 API 方法的更改（在它 ## 全局 web 挂钩 -为[组织](/webhooks/event-payloads/#organization)和[用户](/webhooks/event-payloads/#user)事件类型启用[全局 Webhook](/rest/reference/enterprise-admin#global-webhooks/)。 此 API 预览仅适用于 {% data variables.product.prodname_ghe_server %}。 +为[组织](/webhooks/event-payloads/#organization)和[用户](/webhooks/event-payloads/#user)事件类型启用[全局 Webhook](/rest/reference/enterprise-admin#global-webhooks/)。此 API 预览仅适用于 {% data variables.product.prodname_ghe_server %}。 自定义媒体类型：`superpro-preview` 公布日期：[2017-12-12](/rest/reference/enterprise-admin#global-webhooks) @@ -129,7 +129,7 @@ REST API 对[问题事件](/rest/reference/issues#events)和[问题时间表事 ## 部署状态 -现在可以更新[部署状态](/rest/reference/deployments#create-a-deployment-status)的 `environment` 并使用 `in_progress` 和 `queued` 状态。 创建部署状态时，现在可以使用 `auto_inactive` 参数将旧的 `production` 部署标记为 `inactive`。 +现在可以更新[部署状态](/rest/reference/deployments#create-a-deployment-status)的 `environment` 并使用 `in_progress` 和 `queued` 状态。创建部署状态时，现在可以使用 `auto_inactive` 参数将旧的 `production` 部署标记为 `inactive`。 自定义媒体类型：`flash-preview` 公布日期：[2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) @@ -140,7 +140,7 @@ REST API 对[问题事件](/rest/reference/issues#events)和[问题时间表事 ## 仓库创建权限 -现在，您可以配置组织成员是否可以创建仓库以及他们可以创建哪些类型的仓库。 有关详细信息，请参阅“[更新组织](/rest/reference/orgs#update-an-organization)”。 +现在，您可以配置组织成员是否可以创建仓库以及他们可以创建哪些类型的仓库。有关详细信息，请参阅“[更新组织](/rest/reference/orgs#update-an-organization)”。 自定义媒体类型：`surtur-preview` 公布日期：[2019-12-03](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/) @@ -150,7 +150,7 @@ REST API 对[问题事件](/rest/reference/issues#events)和[问题时间表事 {% ifversion ghes < 3.4 %} ## 内容附件 -现在，您可以在 GitHub 中使用 {% data variables.product.prodname_unfurls %} API 提供有关链接到注册域的 URL 的更多信息。 有关详细信息，请参阅“[使用内容附件](/apps/using-content-attachments/)”。 +现在，您可以在 GitHub 中使用 {% data variables.product.prodname_unfurls %} API 提供有关链接到注册域的 URL 的更多信息。有关详细信息，请参阅“[使用内容附件](/apps/using-content-attachments/)”。 自定义媒体类型：`corsair-preview` 公布日期：[2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/) @@ -159,7 +159,7 @@ REST API 对[问题事件](/rest/reference/issues#events)和[问题时间表事 ## 启用和禁用页面 -可以使用[页面 API](/rest/reference/repos#pages) 中的新终结点来启用或禁用页面。 若要了解有关页面的详细信息，请参阅“[GitHub 页面基础知识](/categories/github-pages-basics)”。 +可以使用[页面 API](/rest/reference/repos#pages) 中的新终结点来启用或禁用页面。若要了解有关页面的详细信息，请参阅“[GitHub 页面基础知识](/categories/github-pages-basics)”。 自定义媒体类型：`switcheroo-preview` 公布日期：[2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) diff --git a/translations/zh-CN/content/rest/overview/libraries.md b/translations/zh-CN/content/rest/overview/libraries.md index 061bc432eeee..c5cbfe1ec8d9 100644 --- a/translations/zh-CN/content/rest/overview/libraries.md +++ b/translations/zh-CN/content/rest/overview/libraries.md @@ -72,7 +72,7 @@ ms.locfileid: '146769155' | 库名称 | 存储库 | 详细信息 | |---|---|---| |GitHub API for Java| [org.kohsuke.github（来自 github-api）](http://github-api.kohsuke.org/)|定义 GitHub API 的面向对象的表示。| -|JCabi GitHub API|[github.jcabi.com（个人网站）](http://github.jcabi.com)|基于 JavaScript API (JSR-353)，可简化使用运行时 GitHub stub 的测试，并覆盖整个API。| +|JCabi GitHub API|[github.jcabi.com（个人网站）](http://github.jcabi.com)|基于 JavaScript API (JSR-353)，可简化使用运行时 GitHub stub 的测试，并覆盖整个 API。| ### JavaScript diff --git a/translations/zh-CN/content/rest/overview/media-types.md b/translations/zh-CN/content/rest/overview/media-types.md index 41d767741b84..09c448c78980 100644 --- a/translations/zh-CN/content/rest/overview/media-types.md +++ b/translations/zh-CN/content/rest/overview/media-types.md @@ -17,7 +17,7 @@ ms.contentlocale: zh-CN ms.lasthandoff: 09/05/2022 ms.locfileid: '146681123' --- -自定义媒体类型在 API 中用于让使用者选择他们想要接收的数据格式。 可在发出请求时将以下一种或多种类型添加到 `Accept` 标头来实现此功能。 媒体类型特定于资源，允许它们独立更改并支持其他资源不支持的格式。 +自定义媒体类型在 API 中用于让使用者选择他们想要接收的数据格式。可在发出请求时将以下一种或多种类型添加到 `Accept` 标头来实现此功能。媒体类型特定于资源，允许它们独立更改并支持其他资源不支持的格式。 所有 {% data variables.product.product_name %} 媒体类型如下所示： @@ -30,7 +30,7 @@ API 支持的最基本媒体类型是： {% note %} -注意：过去，我们建议在 `Accept` 标头中包含 `v3`。 现在不再需要此操作，对你的 API 请求没有影响。 +注意：过去，我们建议在 `Accept` 标头中包含 `v3`。现在不再需要此操作，对你的 API 请求没有影响。 {% endnote %} @@ -46,25 +46,25 @@ API 支持的最基本媒体类型是： application/vnd.github.raw+json -返回原始 Markdown 正文。 响应将包括 `body`。 这是在不传递任何特定媒体类型时的默认值。 +返回原始 Markdown 正文。响应将包括 `body`。这是在不传递任何特定媒体类型时的默认值。 ### 文本 application/vnd.github.text+json -返回 Markdown 正文的纯文本表示形式。 响应将包括 `body_text`。 +返回 Markdown 正文的纯文本表示形式。响应将包括 `body_text`。 ### HTML application/vnd.github.html+json -返回从正文的 Markdown 中渲染的 HTML。 响应将包括 `body_html`。 +返回从正文的 Markdown 中渲染的 HTML。响应将包括 `body_html`。 ### 完全 application/vnd.github.full+json -返回 raw、text 和 HTML 表示形式。 响应将包括 `body`、`body_text` 和 `body_html`： +返回 raw、text 和 HTML 表示形式。响应将包括 `body`、`body_text` 和 `body_html`： ## Git blob 属性 @@ -75,7 +75,7 @@ API 支持的最基本媒体类型是： application/vnd.github+json application/json -返回 Blob 的 JSON 表示形式，`content` 为 base64 编码的字符串。 这是在未传递任何参数时的默认值。 +返回 Blob 的 JSON 表示形式，`content` 为 base64 编码的字符串。这是在未传递任何参数时的默认值。 ### 原始 @@ -105,13 +105,13 @@ API 支持的最基本媒体类型是： application/vnd.github.raw -返回文件的原始内容。 这是在不传递任何特定媒体类型时的默认值。 +返回文件的原始内容。这是在不传递任何特定媒体类型时的默认值。 ### HTML application/vnd.github.html -对于 Markdown 或 AsciiDoc 等标记文件，可以使用 `.html` 媒体类型检索呈现的 HTML。 使用开源[标记库](https://github.com/github/markup)将标记语言呈现给 HTML。 +对于 Markdown 或 AsciiDoc 等标记文件，可以使用 `.html` 媒体类型检索呈现的 HTML。使用开源[标记库](https://github.com/github/markup)将标记语言呈现给 HTML。 ## Gists @@ -119,7 +119,7 @@ API 支持的最基本媒体类型是： application/vnd.github.raw -返回 gist 的原始内容。 这是在不传递任何特定媒体类型时的默认值。 +返回 gist 的原始内容。这是在不传递任何特定媒体类型时的默认值。 ### base64 diff --git a/translations/zh-CN/content/rest/overview/openapi-description.md b/translations/zh-CN/content/rest/overview/openapi-description.md index f30b9d151841..b1b6ebb4e936 100644 --- a/translations/zh-CN/content/rest/overview/openapi-description.md +++ b/translations/zh-CN/content/rest/overview/openapi-description.md @@ -16,17 +16,17 @@ ms.locfileid: '145101171' --- ## 关于 OpenAPI 描述 -[OpenAPI](https://swagger.io/docs/specification/about/) 是用于描述 REST API 的标准规范。 OpenAPI 描述允许人类和计算机无需首先阅读文档或了解实现实现即可发现 API 的功能。 {% data variables.product.company_short %} 已经以 OpenAPI 3.0 标准文档的形式公开其 REST API。 +[OpenAPI](https://swagger.io/docs/specification/about/) 是用于描述 REST API 的标准规范。OpenAPI 描述允许人类和计算机无需首先阅读文档或了解实现实现即可发现 API 的功能。 {% data variables.product.company_short %} 已经以 OpenAPI 3.0 标准文档的形式公开其 REST API。 ## 获取 {% data variables.product.company_short %} OpenAPI 描述 可以在开放源代码 [REST API OpenAPI 说明](https://github.com/github/rest-api-description)存储库中找到说明。 -我们以两种格式提供描述。 捆绑版本适用于大多数情况，因为它包括可重用且可读的 OpenAPI 组件。 如果您的工具不支持对组件的内联引用，我们还提供完全取消引用的版本。 +我们以两种格式提供描述。捆绑版本适用于大多数情况，因为它包括可重用且可读的 OpenAPI 组件。如果您的工具不支持对组件的内联引用，我们还提供完全取消引用的版本。 ## 使用 {% data variables.product.company_short %} OpenAPI 描述 -OpenAPI 描述有很多用途。 例如，可以： +OpenAPI 描述有很多用途。例如，可以： * 生成您自己的 API 客户端。 * 验证并测试 {% data variables.product.company_short %} REST API 集成。 diff --git a/translations/zh-CN/content/rest/overview/troubleshooting.md b/translations/zh-CN/content/rest/overview/troubleshooting.md index f08db1b0ad21..eda5200015e6 100644 --- a/translations/zh-CN/content/rest/overview/troubleshooting.md +++ b/translations/zh-CN/content/rest/overview/troubleshooting.md @@ -22,15 +22,15 @@ ms.locfileid: '147717675' ## 现有存储库的 `404` 错误 一般来说，客户端没有正确通过身份验证时，我们会发送 `404` 错误。 -在这些情况下，你可能会看到 `403 Forbidden`。 但是，由于我们不想提供有关专用存储库的任何信息，API 会改为返回 `404` 错误。 +在这些情况下，你可能会看到 `403 Forbidden`。但是，由于我们不想提供有关专用存储库的任何信息，API 会改为返回 `404` 错误。 -若要进行故障排除，请确保[正确进行身份验证](/guides/getting-started/)、[OAuth 访问令牌具有所需的范围](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)、[第三方应用程序限制][oap-guide]不会阻止访问，并且[令牌未过期或已吊销](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation)。 +若要进行故障排除，请确保[正确进行身份验证](/guides/getting-started/)、[OAuth 访问令牌具有所需的范围](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)、[第三方应用程序限制][oap-guide] 不会阻止访问，并且[令牌未过期或已吊销](/github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation)。 ## 并非所有结果都返回 -大多数 API 调用访问资源列表（例如，用户、问题等）支持分页 。 如果你发出请求但收到的结果集不完整，你可能只会看到第一页。 为了获得更多结果，你需要请求剩余的页面。 +大多数 API 调用访问资源列表（例如，用户、问题等）支持分页。如果你发出请求但收到的结果集不完整，你可能只会看到第一页。为了获得更多结果，你需要请求剩余的页面。 -请务必不要尝试和猜测分页 URL 的格式。 并非每个 API 调用都使用相同的结构， 而是从[链接标头](/rest#pagination)中提取分页信息，该标头随每个请求一起发送。 +请务必不要尝试和猜测分页 URL 的格式。并非每个 API 调用都使用相同的结构，而是从[链接标头](/rest#pagination)中提取分页信息，该标头随每个请求一起发送。 [oap-guide]: https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/ @@ -41,7 +41,7 @@ ms.locfileid: '147717675' ### 使用 `username`/`password` 进行基本身份验证 -如果使用的是 `username` 和 `password` 进行 API 调用，则它们将无法再进行身份验证。 例如： +如果使用的是 `username` 和 `password` 进行 API 调用，则它们将无法再进行身份验证。例如： ```bash curl -u my_user:my_password https://api.github.com/user/repos diff --git a/translations/zh-CN/content/rest/packages.md b/translations/zh-CN/content/rest/packages.md index d677790c89a4..ed0169d01703 100644 --- a/translations/zh-CN/content/rest/packages.md +++ b/translations/zh-CN/content/rest/packages.md @@ -18,13 +18,13 @@ ms.locfileid: '147059920' --- ## 关于 {% data variables.product.prodname_registry %} API -{% data variables.product.prodname_registry %} API 允许您使用 REST API 管理包。 要了解有关还原或删除包的详细信息，请参阅“[还原和删除包](/packages/learn-github-packages/deleting-and-restoring-a-package)”。 +{% data variables.product.prodname_registry %} API 允许您使用 REST API 管理包。要了解有关还原或删除包的详细信息，请参阅“[还原和删除包](/packages/learn-github-packages/deleting-and-restoring-a-package)”。 -要使用此 API ，您必须使用个人访问令牌进行验证。 +要使用此 API，您必须使用个人访问令牌进行验证。 - 要访问包元数据，令牌必须包含 `read:packages` 范围。 - 要删除包和包版本，令牌必须包含 `read:packages` 和 `delete:packages` 范围。 - 要还原包和包版本，令牌必须包含 `read:packages` 和 `write:packages` 范围。 -如果你的 `package_type` 为 `npm`、`maven`、`rubygems` 或 `nuget`，则令牌还必须包含 `repo` 范围，因为你的包从 {% data variables.product.prodname_dotcom %} 存储库继承权限。 如果包在 {% data variables.product.prodname_container_registry %} 中，则你的 `package_type` 为 `container`，包和令牌不需要 `repo` 范围即可访问或管理此 `package_type`。 `container` 包提供与存储库不同的精细权限。 有关详细信息，请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)”。 +如果你的 `package_type` 为 `npm`、`maven`、`rubygems` 或 `nuget`，则令牌还必须包含 `repo` 范围，因为你的包从 {% data variables.product.prodname_dotcom %} 存储库继承权限。如果包在 {% data variables.product.prodname_container_registry %} 中，则你的 `package_type` 为 `container`，包和令牌不需要 `repo` 范围即可访问或管理此 `package_type`。 `container` 包提供与存储库不同的精细权限。有关详细信息，请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)”。 -如果您想使用 {% data variables.product.prodname_registry %} API 访问已启用 SSO 的组织中的资源，则必须对个人访问令牌启用 SSO。 有关详细信息，请参阅 {% data variables.product.prodname_ghe_cloud %} 文档中的“[授权个人访问令牌以用于 SAML 单一登录](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}”。{% else %}."{% endif %} +如果您想使用 {% data variables.product.prodname_registry %} API 访问已启用 SSO 的组织中的资源，则必须对个人访问令牌启用 SSO。有关详细信息，请参阅 {% data variables.product.prodname_ghe_cloud %} 文档中的“[授权个人访问令牌以用于 SAML 单一登录](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}”。{% else %}."{% endif %} diff --git a/translations/zh-CN/content/rest/pulls/comments.md b/translations/zh-CN/content/rest/pulls/comments.md index 58e0103834a8..08076a96a613 100644 --- a/translations/zh-CN/content/rest/pulls/comments.md +++ b/translations/zh-CN/content/rest/pulls/comments.md @@ -20,7 +20,7 @@ ms.locfileid: '147067728' --- ## 关于拉取请求评审评论 API -拉取请求审查评论是在拉取请求审查期间对统一差异的一部分所发表的评论。 提交评论和议题评论不同于拉取请求审查评论。 将提交评论直接应用于提交，然后应用议题评论而不引用统一差异的一部分。 有关详细信息，请参阅“[创建提交评论](/rest/reference/commits#create-a-commit-comment)”和“[创建问题评论](/rest/reference/issues#create-an-issue-comment)”。 +拉取请求审查评论是在拉取请求审查期间对统一差异的一部分所发表的评论。提交评论和议题评论不同于拉取请求审查评论。将提交评论直接应用于提交，然后应用议题评论而不引用统一差异的一部分。有关详细信息，请参阅“[创建提交评论](/rest/reference/commits#create-a-commit-comment)”和“[创建问题评论](/rest/reference/issues#create-an-issue-comment)”。 ### 拉取请求审查评论的自定义媒体类型 diff --git a/translations/zh-CN/content/rest/pulls/pulls.md b/translations/zh-CN/content/rest/pulls/pulls.md index c43e7ba6d1ce..ab251cb91b66 100644 --- a/translations/zh-CN/content/rest/pulls/pulls.md +++ b/translations/zh-CN/content/rest/pulls/pulls.md @@ -18,9 +18,9 @@ ms.locfileid: '145101145' --- ## 关于拉取 API -拉取请求 API 允许您列出、查看、编辑、创建甚至合并拉取请求。 可通过[问题注释 API](/rest/reference/issues#comments) 管理对拉取请求的注释。 +拉取请求 API 允许您列出、查看、编辑、创建甚至合并拉取请求。可通过[问题注释 API](/rest/reference/issues#comments) 管理对拉取请求的注释。 -每个拉取请求都是一个议题，但并非每个议题都是拉取请求。 因此，[问题 API](/rest/reference/issues) 中为这两项功能提供了“共享”操作，如操作代理人、标签和里程碑。 +每个拉取请求都是一个议题，但并非每个议题都是拉取请求。因此，[问题 API](/rest/reference/issues) 中为这两项功能提供了“共享”操作，如操作代理人、标签和里程碑。 ### 拉取请求的自定义媒体类型 @@ -35,7 +35,7 @@ ms.locfileid: '145101145' 有关详细信息，请参阅“[自定义媒体类型](/rest/overview/media-types)”。 -如果 diff 损坏，请联系 {% data variables.contact.contact_support %}。 在您的消息中包括仓库名称和拉取请求 ID。 +如果 diff 损坏，请联系 {% data variables.contact.contact_support %}。在您的消息中包括仓库名称和拉取请求 ID。 ### 链接关系 diff --git a/translations/zh-CN/content/rest/pulls/review-requests.md b/translations/zh-CN/content/rest/pulls/review-requests.md index 86dcfa669e16..0884fadfd3d6 100644 --- a/translations/zh-CN/content/rest/pulls/review-requests.md +++ b/translations/zh-CN/content/rest/pulls/review-requests.md @@ -18,4 +18,4 @@ ms.locfileid: '147060608' --- ## 关于评审请求 API -拉取请求作者以及仓库所有者和协作者可以向具有仓库写入权限的任何人请求拉取请求审查。 每个被请求的审查者将收到您要求他们审查拉取请求的通知。 +拉取请求作者以及仓库所有者和协作者可以向具有仓库写入权限的任何人请求拉取请求审查。每个被请求的审查者将收到您要求他们审查拉取请求的通知。 diff --git a/translations/zh-CN/content/rest/rate-limit.md b/translations/zh-CN/content/rest/rate-limit.md index 424491350602..03b213cf8419 100644 --- a/translations/zh-CN/content/rest/rate-limit.md +++ b/translations/zh-CN/content/rest/rate-limit.md @@ -20,13 +20,13 @@ ms.locfileid: '147081046' --- ## 关于速率限制 API -REST API 概述文档介绍了[速率限制规则](/rest/overview/resources-in-the-rest-api#rate-limiting)。 您可以随时使用下面描述的速率限制 API 来检查您当前的速率限制状态。 +REST API 概述文档介绍了[速率限制规则](/rest/overview/resources-in-the-rest-api#rate-limiting)。您可以随时使用下面描述的速率限制 API 来检查您当前的速率限制状态。 ### 了解您的速率限制状态 -搜索 API 具有[自定义速率限制](/rest/reference/search#rate-limit)，与管理 REST API 其余部分的速率限制不同。 GraphQL API 也有[自定义速率限制](/graphql/overview/resource-limitations#rate-limit)，它与 REST API 中的速率限制不同且计算方式也不同。 +搜索 API 具有[自定义速率限制](/rest/reference/search#rate-limit)，与管理 REST API 其余部分的速率限制不同。GraphQL API 也有[自定义速率限制](/graphql/overview/resource-limitations#rate-limit)，它与 REST API 中的速率限制不同且计算方式也不同。 -出于这些原因，速率限制 API 响应对速率限制进行分类。 在 `resources` 下，你将看到四个对象： +出于这些原因，速率限制 API 响应对速率限制进行分类。在 `resources` 下，你将看到四个对象： * `core` 对象提供 REST API 中所有非搜索相关资源的速率限制状态。 diff --git a/translations/zh-CN/content/rest/reactions.md b/translations/zh-CN/content/rest/reactions.md index c6791045bbfe..b094e4738ca0 100644 --- a/translations/zh-CN/content/rest/reactions.md +++ b/translations/zh-CN/content/rest/reactions.md @@ -20,6 +20,6 @@ ms.locfileid: '147063432' --- ## 关于反应 API -可以使用反应 API 创建和管理对评论的反应。 创建反应时，`content` 参数的允许值如下（对应的表情符号供参考）： +可以使用反应 API 创建和管理对评论的反应。创建反应时，`content` 参数的允许值如下（对应的表情符号供参考）： {% data reusables.repositories.reaction_list %} diff --git a/translations/zh-CN/content/rest/releases/releases.md b/translations/zh-CN/content/rest/releases/releases.md index 5caa4c9f8032..a4ca6aec9f5c 100644 --- a/translations/zh-CN/content/rest/releases/releases.md +++ b/translations/zh-CN/content/rest/releases/releases.md @@ -18,6 +18,6 @@ ms.locfileid: '147067896' --- {% note %} -发布 API 将替换下载 API。 您可以从返回发行版和发行版资产的 API 端点检索下载次数和浏览器下载 URL。 +发布 API 将替换下载 API。您可以从返回发行版和发行版资产的 API 端点检索下载次数和浏览器下载 URL。 {% endnote %} diff --git a/translations/zh-CN/content/rest/repos/contents.md b/translations/zh-CN/content/rest/repos/contents.md index b17bde48a43e..0cb0a2fa92f3 100644 --- a/translations/zh-CN/content/rest/repos/contents.md +++ b/translations/zh-CN/content/rest/repos/contents.md @@ -31,12 +31,12 @@ ms.locfileid: '147060328' 使用 `.raw` 媒体类型检索文件的内容。 -对于 Markdown 或 AsciiDoc 等标记文件，可以使用 `.html` 媒体类型检索呈现的 HTML。 使用我们的开源[标记库](https://github.com/github/markup)将标记语言呈现为 HTML。 +对于 Markdown 或 AsciiDoc 等标记文件，可以使用 `.html` 媒体类型检索呈现的 HTML。使用我们的开源[标记库](https://github.com/github/markup)将标记语言呈现为 HTML。 [所有对象](/rest/reference/repos#get-repository-content)都支持以下自定义媒体类型： application/vnd.github.VERSION.object -无论内容类型如何，使用 `object` 媒体类型参数以一致的对象格式检索内容。 例如，响应不是目录的对象数组，而是具有包含对象数组的 `entries` 属性的对象。 +无论内容类型如何，使用 `object` 媒体类型参数以一致的对象格式检索内容。例如，响应不是目录的对象数组，而是具有包含对象数组的 `entries` 属性的对象。 可在[此处](/rest/overview/media-types)阅读有关 API 中媒体类型使用情况的更多信息。 diff --git a/translations/zh-CN/content/rest/scim.md b/translations/zh-CN/content/rest/scim.md index b3f75976f1ea..c63991100768 100644 --- a/translations/zh-CN/content/rest/scim.md +++ b/translations/zh-CN/content/rest/scim.md @@ -19,19 +19,19 @@ ms.locfileid: '147883041' ### 组织的 SCIM 预配 -SCIM API 由 SCIM 启用的身份提供程序 (IdP) 用来自动预配 {% data variables.product.product_name %} 组织成员身份。 {% ifversion fpt or ghec %} {% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 基于 [ 的 2.0 版 SCIM 标准](http://www.simplecloud.info/)。 IdP 应使用的 {% data variables.product.product_name %} SCIM 终结点是：`{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`。 +SCIM API 由 SCIM 启用的身份提供程序 (IdP) 用来自动预配 {% data variables.product.product_name %} 组织成员身份。 {% ifversion fpt or ghec %} {% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 基于 [ 的 2.0 版 SCIM 标准](http://www.simplecloud.info/)。IdP 应使用的 {% data variables.product.product_name %} SCIM 终结点是：`{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`。 {% note %} **注意：** - - SCIM API 仅适用于启用了 [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) 的 [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) 使用的个人组织。 有关 SCIM 的详细信息，请参阅“[关于组织的 SCIM](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)”。 + - SCIM API 仅适用于启用了 [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) 的 [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) 使用的个人组织。有关 SCIM 的详细信息，请参阅“[关于组织的 SCIM](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)”。 - SCIM API 不能与企业帐户或 {% data variables.product.prodname_emu_org %} 一起使用。 {% endnote %} ### 向 SCIM API 验证调用 -您必须验证为 {% data variables.product.product_name %} 组织的所有者才可使用其 SCIM API。 该 API 要求将 [OAuth 2.0 持有者](/developers/apps/authenticating-with-github-apps)令牌包含在 `Authorization` 标头中。 还可以使用个人访问令牌，但必须先[授权它与 SAML SSO 组织一起使用](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)。 +您必须验证为 {% data variables.product.product_name %} 组织的所有者才可使用其 SCIM API。该 API 要求将 [OAuth 2.0 持有者](/developers/apps/authenticating-with-github-apps)令牌包含在 `Authorization` 标头中。还可以使用个人访问令牌，但必须先[授权它与 SAML SSO 组织一起使用](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)。 ### SAML 和 SCIM 数据的映射 @@ -45,13 +45,13 @@ SCIM API 由 SCIM 启用的身份提供程序 (IdP) 用来自动预配 {% data v `name.givenName`|`string` | 用户的名字。 `name.familyName`|`string` | 用户的姓氏。 `emails` | `array` | 用户电子邮件列表。 -`externalId` | `string` | 此标识符由 SAML 提供程序生成，并且被 SAML 提供程序用作唯一 ID 来匹配 GitHub 用户。 可以在 SAML 提供程序上查找用户的 `externalID`，也可以使用[列出 SCIM 预配的身份](#list-scim-provisioned-identities)终结点并筛选其他已知属性，例如用户的 GitHub 用户名或电子邮件地址。 +`externalId` | `string` | 此标识符由 SAML 提供程序生成，并且被 SAML 提供程序用作唯一 ID 来匹配 GitHub 用户。可以在 SAML 提供程序上查找用户的 `externalID`，也可以使用[列出 SCIM 预配的身份](#list-scim-provisioned-identities)终结点并筛选其他已知属性，例如用户的 GitHub 用户名或电子邮件地址。 `id` | `string` | GitHub SCIM 端点生成的标识符。 `active` | `boolean` | 用于表示身份是处于活动状态 (true) 还是应解除预配 (false)。 {% note %} -注意：SCIM API 的终结点 URL 区分大小写。 例如，`Users` 终结点中的第一个字母必须大写： +注意：SCIM API 的终结点 URL 区分大小写。例如，`Users` 终结点中的第一个字母必须大写： ```shell GET /scim/v2/organizations/{org}/Users/{scim_user_id} diff --git a/translations/zh-CN/content/rest/search.md b/translations/zh-CN/content/rest/search.md index edba6c6283cc..c09d4bd23ebe 100644 --- a/translations/zh-CN/content/rest/search.md +++ b/translations/zh-CN/content/rest/search.md @@ -20,45 +20,45 @@ ms.locfileid: '147110359' --- ## 关于搜索 API -搜索 API 可帮助您搜索要查找的特定条目。 例如，您可以在仓库中找到用户或特定文件。 就像您在 Google 上执行搜索一样。 它旨在帮助您找到要查找的一个或几个结果。 就像在 Google 上搜索一样，有时您希望查看几页搜索结果，以便找到最能满足您需求的条目。 为了满足这一需求，{% data variables.product.product_name %} 搜索 API 为每个搜索提供最多 1,000 个结果。 +搜索 API 可帮助您搜索要查找的特定条目。例如，您可以在仓库中找到用户或特定文件。就像您在 Google 上执行搜索一样。它旨在帮助您找到要查找的一个或几个结果。就像在 Google 上搜索一样，有时您希望查看几页搜索结果，以便找到最能满足您需求的条目。为了满足这一需求，{% data variables.product.product_name %} 搜索 API 为每个搜索提供最多 1,000 个结果。 -您可以使用查询缩小搜索范围。 若要详细了解搜索查询语法，请参阅“[构造搜索查询](/rest/reference/search#constructing-a-search-query)”。 +您可以使用查询缩小搜索范围。若要详细了解搜索查询语法，请参阅“[构造搜索查询](/rest/reference/search#constructing-a-search-query)”。 ### 排列搜索结果 -除非提供另一个排序选项作为查询参数，否则将按照最佳匹配的原则对结果进行降序排列。 多种因素相结合，将最相关的条目顶到结果列表的顶部。 +除非提供另一个排序选项作为查询参数，否则将按照最佳匹配的原则对结果进行降序排列。多种因素相结合，将最相关的条目顶到结果列表的顶部。 ### 速率限制 {% data reusables.enterprise.rate_limit %} -搜索 API 有自定义速率限制。 对于使用[基本身份验证](/rest#authentication)、[OAuth](/rest#authentication) 或[客户端 ID 和机密](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications)的请求，每分钟最多可发出 30 个请求。 对于未经身份验证的请求，速率限制允许每分钟最多发出 10 个请求。 +搜索 API 有自定义速率限制。对于使用[基本身份验证](/rest#authentication)、[OAuth](/rest#authentication) 或[客户端 ID 和机密](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications)的请求，每分钟最多可发出 30 个请求。对于未经身份验证的请求，速率限制允许每分钟最多发出 10 个请求。 有关确定当前速率限制状态的详细信息，请参阅[速率限制文档](/rest/reference/rate-limit)。 ### 构造搜索查询 -搜索 API 中的每个终结点都使用[查询参数](https://en.wikipedia.org/wiki/Query_string)对 {% data variables.product.product_name %} 执行搜索。 有关包含端点和查询参数的示例，请参阅搜索 API 中的各个端点。 +搜索 API 中的每个终结点都使用[查询参数](https://en.wikipedia.org/wiki/Query_string)对 {% data variables.product.product_name %} 执行搜索。有关包含端点和查询参数的示例，请参阅搜索 API 中的各个端点。 -查询可以包含在 {% data variables.product.product_name %} 上支持的搜索限定符的任意组合中。 搜索查询的格式为： +查询可以包含在 {% data variables.product.product_name %} 上支持的搜索限定符的任意组合中。搜索查询的格式为： ``` SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N ``` -例如，如果要搜索 `defunkt` 拥有的在自述文件中包含单词 `GitHub` 和 `Octocat` 的所有存储库，可在“搜索存储库”终结点中使用以下查询 ： +例如，如果要搜索 `defunkt` 拥有的在自述文件中包含单词 `GitHub` 和 `Octocat` 的所有存储库，可在“搜索存储库”终结点中使用以下查询： ``` GitHub Octocat in:readme user:defunkt ``` -注意：请务必使用语言的首选 HTML 编码器构造查询字符串。 例如： +注意：请务必使用语言的首选 HTML 编码器构造查询字符串。例如： ```javascript // JavaScript const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); ``` -有关可用限定符及其格式的完整列表和使用示例，请参阅“[在 GitHub 上搜索](/search-github/searching-on-github)”。 有关如何使用运算符匹配特定数量、日期或排除结果，请参阅“[了解搜索语法](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)”。 +有关可用限定符及其格式的完整列表和使用示例，请参阅“[在 GitHub 上搜索](/search-github/searching-on-github)”。有关如何使用运算符匹配特定数量、日期或排除结果，请参阅“[了解搜索语法](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)”。 ### 查询长度限制 @@ -70,22 +70,22 @@ const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:def ### 超时和不完整的结果 -为了让所有人都能快速使用搜索 API，可以限制任何单个查询能够运行的时长。 对于[超出时间限制](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/)的查询，API 将返回超时之前已找到的匹配项，并且响应的 `incomplete_results` 属性设为 `true`。 +为了让所有人都能快速使用搜索 API，可以限制任何单个查询能够运行的时长。对于[超出时间限制](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/)的查询，API 将返回超时之前已找到的匹配项，并且响应的 `incomplete_results` 属性设为 `true`。 达到超时并不意味着搜索结果不完整， 可能已找到更多结果，也可能没有找到。 ### 访问错误或缺少搜索结果 -需要成功完成身份验证并对搜索查询中的存储库具有访问权限，否则，你将看到 `422 Unprocessable Entry` 错误和“验证失败”消息。 例如，如果查询中包含 `repo:`、`user:` 或 `org:` 限定符，但这些限定符请求的资源是你登录 {% data variables.product.prodname_dotcom %} 后无权访问的资源，则搜索将失败。 +需要成功完成身份验证并对搜索查询中的存储库具有访问权限，否则，你将看到 `422 Unprocessable Entry` 错误和“验证失败”消息。例如，如果查询中包含 `repo:`、`user:` 或 `org:` 限定符，但这些限定符请求的资源是你登录 {% data variables.product.prodname_dotcom %} 后无权访问的资源，则搜索将失败。 当搜索查询请求多个资源时，响应将只包含你有权访问的资源，并且不会提供列出未返回资源的错误消息。 -例如，如果搜索查询要搜索 `octocat/test` 和 `codertocat/test` 存储库，但你只拥有对 `octocat/test` 的访问权限，则响应将显示对 `octocat/test` 的搜索结果，而不会显示对 `codertocat/test` 的搜索结果。 此行为类似于 {% data variables.product.prodname_dotcom %} 上的搜索方式。 +例如，如果搜索查询要搜索 `octocat/test` 和 `codertocat/test` 存储库，但你只拥有对 `octocat/test` 的访问权限，则响应将显示对 `octocat/test` 的搜索结果，而不会显示对 `codertocat/test` 的搜索结果。此行为类似于 {% data variables.product.prodname_dotcom %} 上的搜索方式。 ### 文本匹配元数据 -在 GitHub 上，您可以使用搜索结果中的代码段和高亮显示提供的上下文。 搜索 API 提供额外的元数据，允许您在显示搜索结果时高亮显示匹配搜索词。 +在 GitHub 上，您可以使用搜索结果中的代码段和高亮显示提供的上下文。搜索 API 提供额外的元数据，允许您在显示搜索结果时高亮显示匹配搜索词。 ![代码片段高亮显示](/assets/images/text-match-search-api.png) @@ -97,15 +97,15 @@ const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:def application/vnd.github.text-match+json ``` -提供 `text-match` 媒体类型时，你将在 JSON 有效负载中收到一个额外的键，名为 `text_matches`，它提供有关搜索词在文本中的位置以及包含该搜索词的 `property` 的信息。 在 `text_matches` 数组中，每个对象都包含以下属性： +提供 `text-match` 媒体类型时，你将在 JSON 有效负载中收到一个额外的键，名为 `text_matches`，它提供有关搜索词在文本中的位置以及包含该搜索词的 `property` 的信息。在 `text_matches` 数组中，每个对象都包含以下属性： 名称 | 说明 -----|-----------| `object_url` | 包含匹配某个搜索词的字符串属性的资源 URL。 `object_type` | 在给定 `object_url` 中存在的资源类型的名称。 -`property` | 在 `object_url` 中存在的资源属性的名称。 属性是与某个搜索词相匹配的字符串。 （在从 `object_url` 返回的 JSON 中，`fragment` 的完整内容存在于具有此名称的属性中。） -`fragment` | `property` 值的子集。 这是与一个或多个搜索词匹配的文本片段。 -`matches` | 存在于 `fragment` 中的一个或多个搜索词组成的数组。 索引（即“偏移量”）与片段相关。 （它们与 `property` 的完整内容无关。） +`property` | 在 `object_url` 中存在的资源属性的名称。属性是与某个搜索词相匹配的字符串。 （在从 `object_url` 返回的 JSON 中，`fragment` 的完整内容存在于具有此名称的属性中。） +`fragment` | `property` 值的子集。这是与一个或多个搜索词匹配的文本片段。 +`matches` | 存在于 `fragment` 中的一个或多个搜索词组成的数组。索引（即“偏移量”）与片段相关。 （它们与 `property` 的完整内容无关。） #### 示例 @@ -117,11 +117,11 @@ curl -H 'Accept: application/vnd.github.text-match+json' \ +language:python+state:open&sort=created&order=asc' ``` -对于每个搜索结果，响应将包含一个 `text_matches` 数组。 在下面的 JSON 中，`text_matches` 数组中有两个对象。 +对于每个搜索结果，响应将包含一个 `text_matches` 数组。在下面的 JSON 中，`text_matches` 数组中有两个对象。 -第一个文本匹配出现在问题的 `body` 属性中。 我们从议题正文中看到了文本片段。 搜索词 (`windows`) 在该片段中出现了两次，我们有每次出现时的索引。 +第一个文本匹配出现在问题的 `body` 属性中。我们从议题正文中看到了文本片段。搜索词 (`windows`) 在该片段中出现了两次，我们有每次出现时的索引。 -第二个文本匹配出现在其中一个问题注释的 `body` 属性中。 我们有议题注释的 URL。 当然，我们从注释正文中看到了文本片段。 搜索词 (`windows`) 在该片段中出现了一次。 +第二个文本匹配出现在其中一个问题注释的 `body` 属性中。我们有议题注释的 URL。当然，我们从注释正文中看到了文本片段。搜索词 (`windows`) 在该片段中出现了一次。 ```json { diff --git a/translations/zh-CN/content/rest/secret-scanning.md b/translations/zh-CN/content/rest/secret-scanning.md index 3e5179cbccf4..1b41ad486f67 100644 --- a/translations/zh-CN/content/rest/secret-scanning.md +++ b/translations/zh-CN/content/rest/secret-scanning.md @@ -23,7 +23,7 @@ ms.locfileid: '147880122' 使用 {% data variables.product.prodname_secret_scanning %} API，你可以： -- 为存储库启用或禁用 {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %} 和推送保护{% endif %}。 有关详细信息，请参阅“[存储库](/rest/repos/repos#update-a-repository)”，并展开 REST API 文档中的“`security_and_analysis` 对象的属性”部分。 -- 从存储库检索和更新 {% data variables.product.prodname_secret_scanning_GHAS %} 警报。 有关更多详细信息，请参阅以下部分。 +- 为存储库启用或禁用 {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %} 和推送保护{% endif %}。有关详细信息，请参阅“[存储库](/rest/repos/repos#update-a-repository)”，并展开 REST API 文档中的“`security_and_analysis` 对象的属性”部分。 +- 从存储库检索和更新 {% data variables.product.prodname_secret_scanning_GHAS %} 警报。有关更多详细信息，请参阅以下部分。 有关 {% data variables.product.prodname_secret_scanning %} 的详细信息，请参阅“[关于 {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)”。 diff --git a/translations/zh-CN/content/rest/teams/discussion-comments.md b/translations/zh-CN/content/rest/teams/discussion-comments.md index 261973525a92..f1d9ddf3318a 100644 --- a/translations/zh-CN/content/rest/teams/discussion-comments.md +++ b/translations/zh-CN/content/rest/teams/discussion-comments.md @@ -20,6 +20,6 @@ ms.locfileid: '147884451' --- ## 关于团队讨论评论 API -团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论上的评论。 有关详细信息，请参阅“[关于团队讨论](/organizations/collaborating-with-your-team/about-team-discussions/)”。 +团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公共讨论上的评论。有关详细信息，请参阅“[关于团队讨论](/organizations/collaborating-with-your-team/about-team-discussions/)”。 {% data reusables.organizations.team-api %} diff --git a/translations/zh-CN/content/rest/teams/discussions.md b/translations/zh-CN/content/rest/teams/discussions.md index a056cdac6906..8ebe105ce5bc 100644 --- a/translations/zh-CN/content/rest/teams/discussions.md +++ b/translations/zh-CN/content/rest/teams/discussions.md @@ -20,6 +20,6 @@ ms.locfileid: '147060552' --- ## 关于团队讨论 API -您可以使用团队讨论进行不特定于存储库或项目的对话。 团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公开讨论帖。 有关详细信息，请参阅“[关于团队讨论](//organizations/collaborating-with-your-team/about-team-discussions/)”。 若要详细了解如何对讨论帖子发表评论，请参阅[团队讨论评论 API](/rest/reference/teams#discussion-comments)。 +您可以使用团队讨论进行不特定于存储库或项目的对话。团队[组织](/rest/reference/orgs)的任何成员都可以创建和阅读公开讨论帖。有关详细信息，请参阅“[关于团队讨论](//organizations/collaborating-with-your-team/about-team-discussions/)”。若要详细了解如何对讨论帖子发表评论，请参阅[团队讨论评论 API](/rest/reference/teams#discussion-comments)。 {% data reusables.organizations.team-api %} diff --git a/translations/zh-CN/content/rest/teams/external-groups.md b/translations/zh-CN/content/rest/teams/external-groups.md index 34762196b250..a62e27510fe5 100644 --- a/translations/zh-CN/content/rest/teams/external-groups.md +++ b/translations/zh-CN/content/rest/teams/external-groups.md @@ -23,7 +23,7 @@ ms.locfileid: '147059968' **注意：** -- 外部组 API 仅适用于属于使用 {% data variables.product.prodname_emus %} 的企业中的组织。 有关详细信息，请参阅“[关于企业托管用户](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)”。 -- 如果您的组织使用团队同步，则可以使用团队同步 API。 有关详细信息，请参阅“[团队同步 API](#team-synchronization)”。 +- 外部组 API 仅适用于属于使用 {% data variables.product.prodname_emus %} 的企业中的组织。有关详细信息，请参阅“[关于企业托管用户](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)”。 +- 如果您的组织使用团队同步，则可以使用团队同步 API。有关详细信息，请参阅“[团队同步 API](#team-synchronization)”。 {% endnote %} {% endif %} diff --git a/translations/zh-CN/content/rest/teams/members.md b/translations/zh-CN/content/rest/teams/members.md index 918abb8f498a..234805766659 100644 --- a/translations/zh-CN/content/rest/teams/members.md +++ b/translations/zh-CN/content/rest/teams/members.md @@ -24,7 +24,7 @@ ms.locfileid: '147876166' {% ifversion fpt or ghes or ghec %} {% note %} -注意：如果为具有组织身份提供程序 (IdP) 的团队设置了团队同步，当尝试使用 API 更改团队的成员身份时，则会看到错误。 如果您有权访问 IdP 中的组成员身份，可以通过身份提供程序管理 GitHub 团队成员身份，该提供程序会自动添加和删除组织的成员。 有关详细信息，请参阅“[在标识提供者与 GitHub 之间同步团队](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)”。 +注意：如果为具有组织身份提供程序 (IdP) 的团队设置了团队同步，当尝试使用 API 更改团队的成员身份时，则会看到错误。如果您有权访问 IdP 中的组成员身份，可以通过身份提供程序管理 GitHub 团队成员身份，该提供程序会自动添加和删除组织的成员。有关详细信息，请参阅“[在标识提供者与 GitHub 之间同步团队](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)”。 {% endnote %} diff --git a/translations/zh-CN/content/rest/teams/team-sync.md b/translations/zh-CN/content/rest/teams/team-sync.md index 331f4c7a2a3f..5f06b8acb768 100644 --- a/translations/zh-CN/content/rest/teams/team-sync.md +++ b/translations/zh-CN/content/rest/teams/team-sync.md @@ -16,12 +16,12 @@ ms.locfileid: '147067160' --- ## 关于团队同步 API -要使用此 API，经过身份验证的用户必须是团队维护员或与团队关联的组织的所有者。 用于身份验证的令牌还需要获得授权才能与 IdP (SSO) 提供程序一起使用。 有关详细信息，请参阅“[授权用于 SAML 单一登录组织的个人访问令牌](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)”。 +要使用此 API，经过身份验证的用户必须是团队维护员或与团队关联的组织的所有者。用于身份验证的令牌还需要获得授权才能与 IdP (SSO) 提供程序一起使用。有关详细信息，请参阅“[授权用于 SAML 单一登录组织的个人访问令牌](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)”。 -您可以通过 IdP 通过团队同步管理 GitHub 团队成员。 必须启用团队同步才能使用团队同步 API。 有关详细信息，请参阅“[在标识提供者与 GitHub 之间同步团队](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)”。 +您可以通过 IdP 通过团队同步管理 GitHub 团队成员。必须启用团队同步才能使用团队同步 API。有关详细信息，请参阅“[在标识提供者与 GitHub 之间同步团队](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)”。 {% note %} -注意：团队同步 API 不能与 {% data variables.product.prodname_emus %} 一起使用。 若要详细了解如何管理 {% data variables.product.prodname_emu_org %}，请参阅“[外部组 API](/enterprise-cloud@latest/rest/reference/teams#external-groups)”。 +注意：团队同步 API 不能与 {% data variables.product.prodname_emus %} 一起使用。若要详细了解如何管理 {% data variables.product.prodname_emu_org %}，请参阅“[外部组 API](/enterprise-cloud@latest/rest/reference/teams#external-groups)”。 {% endnote %} diff --git a/translations/zh-CN/content/rest/users/gpg-keys.md b/translations/zh-CN/content/rest/users/gpg-keys.md index 404c6f5131a6..611010b11a0a 100644 --- a/translations/zh-CN/content/rest/users/gpg-keys.md +++ b/translations/zh-CN/content/rest/users/gpg-keys.md @@ -18,6 +18,6 @@ ms.locfileid: '147877182' --- ## 关于用户 GPG 密钥 API -在 `public_key` 响应字段中返回的数据不是 GPG 格式的密钥。 当用户上传 GPG 密钥时，将对密钥进行剖析，然后提取并存储加密公钥。 此加密密钥是本页面上的 API 所返回的密钥。 此密钥不适合直接用于 GPG 等程序。 +在 `public_key` 响应字段中返回的数据不是 GPG 格式的密钥。当用户上传 GPG 密钥时，将对密钥进行剖析，然后提取并存储加密公钥。此加密密钥是本页面上的 API 所返回的密钥。此密钥不适合直接用于 GPG 等程序。 {% data reusables.user-settings.user-api %} diff --git a/translations/zh-CN/content/rest/webhooks/index.md b/translations/zh-CN/content/rest/webhooks/index.md index 32fd9f115747..00584a0c61d7 100644 --- a/translations/zh-CN/content/rest/webhooks/index.md +++ b/translations/zh-CN/content/rest/webhooks/index.md @@ -31,24 +31,24 @@ ms.locfileid: '147882341' ## 接收 web 挂钩 -为了让 {% data variables.product.product_name %} 发送 web 挂钩有效负载，您的服务器需要能够从 Internet 访问。 我们还强烈建议使用 SSL，以便我们可以通过 HTTPS 发送加密的有效负载。 +为了让 {% data variables.product.product_name %} 发送 web 挂钩有效负载，您的服务器需要能够从 Internet 访问。我们还强烈建议使用 SSL，以便我们可以通过 HTTPS 发送加密的有效负载。 ### Web 挂钩标头 -{% data variables.product.product_name %} 发送时将附带几个 HTTP 标头，以区分事件类型和有效负载标识符。 有关详细信息，请参阅 [Webhook 标头](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers)。 +{% data variables.product.product_name %} 发送时将附带几个 HTTP 标头，以区分事件类型和有效负载标识符。有关详细信息，请参阅 [Webhook 标头](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers)。 ## PubSubHubbub -GitHub 还可以用作所有存储库的 [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) 中心。 PSHB 是一个简单的发布/订阅协议，允许服务器注册在主题更新时接收更新。 这些更新随 HTTP POST 请求一起发送到回调 URL。 +GitHub 还可以用作所有存储库的 [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) 中心。PSHB 是一个简单的发布/订阅协议，允许服务器注册在主题更新时接收更新。这些更新随 HTTP POST 请求一起发送到回调 URL。 GitHub 仓库推送的主题 URL 采用以下格式： `https://github.com/{owner}/{repo}/events/{event}` -事件可以是任何可用的 web 挂钩事件。 有关详细信息，请参阅“[Webhook 事件和有效负载](/developers/webhooks-and-events/webhook-events-and-payloads)”。 +事件可以是任何可用的 web 挂钩事件。有关详细信息，请参阅“[Webhook 事件和有效负载](/developers/webhooks-and-events/webhook-events-and-payloads)”。 ### 响应格式 -默认格式是[现有接收后挂钩应具有的格式](/post-receive-hooks/)：作为 POST 中的 `payload` 参数发送的 JSON 正文。 还可以指定接收带有 `Accept` 标头或 `.json` 扩展名的原始 JSON 正文。 +默认格式是[现有接收后挂钩应具有的格式](/post-receive-hooks/)：作为 POST 中的 `payload` 参数发送的 JSON 正文。还可以指定接收带有 `Accept` 标头或 `.json` 扩展名的原始 JSON 正文。 Accept: application/json https://github.com/{owner}/{repo}/events/push.json @@ -62,7 +62,7 @@ GitHub 仓库推送的主题 URL 采用以下格式： ### 订阅 -GitHub PubSubHubbub 终结点为：`{% data variables.product.api_url_code %}/hub`。 使用 cURL 的成功请求如下所示： +GitHub PubSubHubbub 终结点为：`{% data variables.product.api_url_code %}/hub`。使用 cURL 的成功请求如下所示： ``` shell curl -u "user" -i \ @@ -72,13 +72,13 @@ curl -u "user" -i \ -F "hub.callback=http://postbin.org/123" ``` -PubSubHubbub 请求可以多次发送。 如果挂钩已经存在，它将根据请求进行修改。 +PubSubHubbub 请求可以多次发送。如果挂钩已经存在，它将根据请求进行修改。 #### 参数 名称 | 类型 | 说明 -----|------|-------------- ``hub.mode``|`string` | “必需”。 `subscribe` 或 `unsubscribe`。 -``hub.topic``|`string` |“必需”。 要订阅的 GitHub 仓库的 URI。 路径的格式必须为 `/{owner}/{repo}/events/{event}`。 +``hub.topic``|`string` |“必需”。要订阅的 GitHub 仓库的 URI。路径的格式必须为 `/{owner}/{repo}/events/{event}`。 ``hub.callback``|`string` | 要接收主题更新的 URI。 -``hub.secret``|`string` | 用于生成传出正文内容的哈希签名的共享密钥。 可通过比较原始请求正文与 {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` 或 `X-Hub-Signature-256` 标头{% elsif ghae %}`X-Hub-Signature-256` 标头的内容来验证来自 GitHub 的推送{% endif %}。 有关更多详细信息，请参阅 [PubSubHubbub 文档](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify)。 +``hub.secret``|`string` | 用于生成传出正文内容的哈希签名的共享密钥。可通过比较原始请求正文与 {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` 或 `X-Hub-Signature-256` 标头{% elsif ghae %}`X-Hub-Signature-256` 标头的内容来验证来自 GitHub 的推送{% endif %}。有关更多详细信息，请参阅 [PubSubHubbub 文档](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify)。