github-api-v3 - “Validation failed” 安装GitHub App 搜索私有(private)仓库报错

Question

我创建了一个 GitHub 应用程序并将其安装在我的帐户中，允许它访问我帐户中的私有(private)存储库。 GitHub 应用程序具有元数据的读取权限。然后，我按照此处的步骤生成了一个 JWT 并使用它来创建安装访问 token 。我尝试使用此 token 使用 GitHub 搜索 API 在上述私有(private)存储库中搜索关键字，如下所示:

https://api.github.com/search/code?q=abc+in:file+repo:username/private-repo

但是，这会返回以下响应。

{
    "message": "Validation Failed",
    "errors": [
        {
            "message": "The listed users and repositories cannot be searched either because the resources do not exist or you do not have permission to view them.",
            "resource": "Search",
            "field": "q",
            "code": "invalid"
        }
    ],
    "documentation_url": "https://docs.github.com/v3/search/"
}

我尝试使用此访问 token 获取此 GitHub 应用程序安装的存储库，并在响应中成功返回私有(private)存储库。我认为这意味着安装可以访问私有(private)存储库并且 token 按预期工作。使用的 API:https://api.github.com/installation/repositories。

为什么搜索失败了？

Answer 1

在 GitHub 支持下提交了一张票。他们的回应:

The query failed because the GitHub App does not have permission toread the content of the private repository. The Metadata readpermission will allow you to search for repositories but does not havesufficient scope to read the content of the repository(private).

docs在元数据下列出搜索 API，但它应该在内容权限下。向 GitHub 应用程序授予 Content read 权限解决了这个问题。