[Schema Inaccuracy] Github action, create datetime query not working

Open
#2,542 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start with the Actions workflow-runs endpoint and the referenced Understanding the search syntax documentation; compare the datetime query example with related issue #2195. Determine whether the API description or documentation is inaccurate, and consider the issue done when the supported date-range behavior is accurately represented.

Written by the indexing model from the issue text.

Description

feature fundamentals-and-support P3 shield waiting for review

Schema Inaccuracy

I would like to query all workflow runs since a datetime, it does not work as expected.

Expected

Requesting API:

https://api.github.com/repos/{user]/{repo}/actions/runs?created=2023-05-11T00:00:00+08:00..*

It should return all the workflows that were created after 2023-05-11T00:00:00, timezone UTC+8.

Actually, it returns:

{
  "total_count": 0,
  "workflow_runs": []
}

Seems the API does not support time? The doc Understanding the search syntax is very very misleading, 😞

Reproduction Steps

Requesting API is mentioned above. BTW is it possible to query all the workflow runs in the past time range, like 24hours?

Related issue: #2195
Reference: https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.