Project

General

Profile

Actions

action #95084

open

Create a data file with openQA API routes, parameters, docs

Added by tinita over 3 years ago. Updated about 1 year ago.

Status:
New
Priority:
Low
Assignee:
-
Category:
Feature requests
Target version:
Start date:
2021-07-05
Due date:
% Done:

0%

Estimated time:

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 validation object 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).


Related issues 2 (0 open2 closed)

Related to openQA Project - action #16282: [tools][sprint 201711.2] documentation: Better API documentationResolvedacarvajal2017-01-27

Actions
Related to openQA Project - action #95075: Find jobs matching search parameters over /api/v1/jobs (especially documentation) size:SResolvedmkittler2021-07-052021-07-23

Actions
Actions #1

Updated by tinita over 3 years ago

  • Related to action #16282: [tools][sprint 201711.2] documentation: Better API documentation added
Actions #2

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.

Actions #3

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
Actions #4

Updated by tinita about 1 year ago

  • Description updated (diff)
Actions

Also available in: Atom PDF