action #95075
closed
Find jobs matching search parameters over /api/v1/jobs (especially documentation) size:S
Added by okurz almost 3 years ago.
Updated almost 3 years ago.
Category:
Feature requests
Description
Motivation¶
As an application developer I want to find openQA job results matching search parameters over API so that I can integrate openQA test results into my application
Acceptance criteria¶
- AC1: Application developers can find a place where they can learn how to use the openQA API to find openQA job results matching search parameters, at least "build" and "job group (id/name)"
Suggestions¶
- Understand what is currently already possible to find tests based on parameters. E.g.
curl -s "https://openqa.suse.de/api/v1/jobs?latest=1&scope=relevant&distri=sle&groupid=385&build=MR:244015:clamav" | jq . shows four jobs as example
- Make sure that a user would be able to find this information, e.g. from openQA internal help as well as documentation
Out of scope¶
- Actual implementation of any search parameters except for "build" and "job group (id/name)" which are mentioned here -> if you find any reasonable please report separately
- Related to action #92125: Move "MR" on submission tests into a separate job group added
Maybe we could take this opportunity to establish a data file with API routes and their parameters.
It would include the validation of the parameters as well as documentation and examples.
We aren't using OpenAPI, but we can still use a data file. Once we have the stuff in data instead of scattered through code and documentation, we can easily port the data format to a different one, should we ever use something like OpenAPI.
And we avoid having to update different places in our code/docs.
I created a new ticket: #95084
- Related to action #95084: Create a data file with openQA API routes, parameters, docs added
I like the idea of such programming-language-agnostic definition of API routes and parameters. I suggest to take this ticket as one example which would need to be covered by such data file. We can still continue with this ticket in the non-structured documentation way and from then on continue in #95084 how it could be done in the way that you suggest.
- Subject changed from Find jobs matching search parameters over /api/v1/jobs (especially documentation) to Find jobs matching search parameters over /api/v1/jobs (especially documentation) size:S
- Status changed from New to Workable
- Status changed from Workable to In Progress
- Due date set to 2021-07-23
Setting due date based on mean cycle time of SUSE QE Tools
- Status changed from In Progress to Feedback
The PR has been merged, waiting for the documentation to be updated.
- Status changed from Feedback to Resolved
Also available in: Atom
PDF