Project

General

Profile

Actions
Copy link

action #177033

open

coordination #154768: [saga][epic][ux] State-of-art user experience for openQA

coordination #154771: [epic] Improved test developer user experience

Provide a clean rendering of openQA API docs

Added by livdywan about 1 month ago. Updated 22 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Feature requests
Target version:
QA (public) - future
Start date:
Due date:
% Done:

0%

Estimated time:

Description

Motivation

We have some API documentation in code which is visible via non-existing routes e.g. https://openqa.opensuse.org/foo but this is not very easy to read and many routes are missing documentation.

Suggestions

  • Provide a new view that shows available routes in the web UI
  • Start with api/v1/routes and add a new route that includes descriptions
  • File follow-up tickets for missing documentation

Related issues 2 (2 open — 0 closed)

Related to openQA Project (public) - action #95084: Create a data file with openQA API routes, parameters, docsNew2021-07-05

Actions
Related to openQA Project (public) - action #177708: documentation: Better API documentation, e.g. with openAPINew2017-01-27

Actions
Actions
Copy link
 #1

Updated by livdywan about 1 month ago

  • Related to action #95084: Create a data file with openQA API routes, parameters, docs added
Actions
Copy link
 #2

Updated by livdywan about 1 month ago

  • Description updated (diff)
Actions
Copy link
 #3

Updated by livdywan about 1 month ago

  • Description updated (diff)
Actions
Copy link
 #4

Updated by okurz about 1 month ago

  • Target version set to future
Actions
Copy link
 #5

Updated by okurz 22 days ago

  • Parent task set to #154771
Actions
Copy link
 #6

Updated by okurz 22 days ago

  • Related to action #177708: documentation: Better API documentation, e.g. with openAPI added
Actions
Copy link

Also available in: Atom PDF