Actions
coordination #170080
opencoordination #154768: [saga][epic][ux] State-of-art user experience for openQA
coordination #166556: [epic] Improved test reviewer user experience - Restart filtered jobs from /tests/overview
openQA API help cuts off possible query parameters for /jobs
Status:
New
Priority:
Normal
Assignee:
-
Category:
Feature requests
Target version:
QA (public, currently private due to #173521) - future
Start date:
2024-11-19
Due date:
% Done:
0%
Estimated time:
Description
Observation¶
Our API help page, e.g. https://openqa.opensuse.org/help_me_with_the_api_please, for the explanation of "+/jobs" (GET) ends the explanation with "These options are currently available: ". The explanation is defined in https://github.com/os-autoinst/openQA/blob/ac8129f853e1e4e3d75353faec2dd2a3d42df871/lib/OpenQA/WebAPI/Controller/API/V1/Job.pm#L48 which also lists the "limit" parameter but that is not rendered on the help text but should.
Acceptance criteria¶
- AC1: https://openqa.opensuse.org/help_me_with_the_api_please mentions the possible query parameters to specify on the API route /api/v1/jobs (GET)
Suggestions¶
- Reconsider how the markup of the POD section is done in https://github.com/os-autoinst/openQA/blob/ac8129f853e1e4e3d75353faec2dd2a3d42df871/lib/OpenQA/WebAPI/Controller/API/V1/Job.pm#L48 or change how the POD text is rendered in mojolicious
- Look for other similar problematic areas
No data to display
Actions