Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
Under List workflow runs for a repository, for the query parameter created
, the date range syntax has been linked i.e. Query for dates:
# syntax
created:<START-DATE>..<END-DATE>
# example
created:2023-02-10..2023-02-12
But, this doesn't work.
The syntax that works is with =
:
created=<START-DATE>..<END-DATE>
created=2023-02-10..2023-02-12
Example
Tested with a public repo like this (created:2023-02-12..2023-02-13
):
curl \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/repos/iamazeem/test/actions/runs?created:2023-02-12..2023-02-13" \
| jq .total_count
# output: 8
Also, tested with other ranges and it always returns the total number of workflows runs i.e. 8 (at the time of writing).
However, it returns the correct number of workflows when tested with =
(created=2023-02-12..2023-02-13
):
curl \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/repos/iamazeem/test/actions/runs?created=2023-02-12..2023-02-13" \
| jq .total_count
# output: 3
The same has been tested and verified with multiple ranges with :
and =
.
And, =
always work.
Seems like the syntax with :
works for GitHub directly:
https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories
But, it doesn't work for GHA API.
Maybe, the article needs to be updated or the link needs to be fixed.
Additional information
No response