Project

General

Profile

Actions

action #80492

closed

[easy] API help document says "Deletes …" for routes like "test_suites/:id" PUT and POST and looks inconsistent

Added by okurz about 4 years ago. Updated about 4 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Feature requests
Target version:
Start date:
2020-11-27
Due date:
2020-12-12
% Done:

0%

Estimated time:

Description

Observation

On https://openqa.opensuse.org/not_found one sees

+/test_suites/:id       PUT     test_suitesid   Deletes a table …

Problems

  • It says "delete" for the PUT method, also POST
  • there is no "apiv1_…" in the route name
  • Looks like the same text is put on all methods here
  • Maybe same problem appears for other routes

Suggestions

  • Find the route definitions in https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/WebAPI.pm#L389
  • Crosscheck and correct the "name" parameter
  • Correct the comment that is defined in lib/OpenQA/WebAPI/Controller/API/V1/Table.pm and either incorrectly read out or needs to be updated. likely the method "_verify_table_usage" has just in the middle between the correct comment for "update" and the method definition it self
Actions

Also available in: Atom PDF