action #95084
opencoordination #154768: [saga][epic][ux] State-of-art user experience for openQA
coordination #154771: [epic] Improved test developer user experience
Create a data file with openQA API routes, parameters, docs
0%
Description
We have several places where information on our API is stored.
- WebAPI.pm includes the route definitions for Mojolicious.
- In the actual methods, we have the
validationobject to define parameter validation. - In our documentation we have some API examples
Changing or adding things to the API often results in forgetting docs and/or validation.
Having the definitions all in one place avoids that, and can serve as documentation as well, or at least we can generate documentation from it.
Having the definitions in a data format allows to easily port to other data formats in the future, e.g. openAPI (also known as Swagger).
Updated by tinita over 3 years ago
- Related to action #16282: [tools][sprint 201711.2] documentation: Better API documentation added
Updated by livdywan over 3 years ago
I like the idea. It would be great to have a reference YAML (or equivalent). We might even be able to automated tests to for example check that API changes come with documentation changes.
Updated by okurz over 3 years ago
- Related to action #95075: Find jobs matching search parameters over /api/v1/jobs (especially documentation) size:S added
Updated by livdywan about 1 month ago
- Related to action #177033: Provide a clean rendering of openQA API docs added
Updated by tinita 22 days ago
- Related to action #177708: documentation: Better API documentation, e.g. with openAPI added