github api (gh api) 工作流程运行端点不使用查询参数

Question

当我运行这个时，我得到结果

gh api repos/myorg/myrepo/actions/workflows/my-workflow.yaml/runs

。我希望只从主分支获取运行，而不是事后进行过滤。 根据文档“使用以下参数时，此端点将为每次搜索返回最多 1,000 个结果：actor、branch、check_suite_id、created、event、head_sha、status。”

但是，如果我添加

-f 'branch=master'

、

-F 'branch=master'

、

-f branch=master

或

-F branch=master

，我只会得到 404:

gh: Not Found (HTTP 404)
  "message": "Not Found",
  "documentation_url": "https://docs.github.com/rest",
  "status": "404"
}

分行名称正确。参数有什么问题？包含标头也不起作用并给出 404:

gh api \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  repos/myorg/myrepo/actions/workflows/my-workflow.yaml/runs -f "branch=master"

（我在这里用泛型替换了组织、存储库和工作流程名称。）

Answer 1

此端点需要 HTTP GET 请求，但如果您向 GitHub CLI 请求添加参数，它会自动切换到 POST，请参阅手册：

默认的 HTTP 请求方法通常为

GET

，如果添加任何参数则为

POST

。使用

--method

覆盖该方法。

所以：

gh api repos/myorg/myrepo/actions/workflows/my-workflow.yaml/runs \
    -f 'branch=master' \
    -X GET

其中

-X

是

--method

的缩写。