Add description part for api routes at not_found page

[krauselukas]

Related to https://progress.opensuse.org/issues/16282

The thought was to make a first step relating this ticket and add a description part to the already existing api routes table on the not_found page.

[codecov]

Codecov Report

Merging #1439 into master will increase coverage by 13.46%.
The diff coverage is 100%.

@@             Coverage Diff             @@
##           master    #1439       +/-   ##
===========================================
+ Coverage   74.08%   87.55%   +13.46%     
===========================================
  Files         105      105               
  Lines        7918     7921        +3     
===========================================
+ Hits         5866     6935     +1069     
+ Misses       2052      986     -1066

Impacted Files	Coverage Δ
lib/OpenQA/WebAPI.pm	91.93% <100%> (+2.03%)	⬆️
lib/OpenQA/WebAPI/Plugin/Helpers.pm	98.28% <0%> (+0.57%)	⬆️
lib/OpenQA/Schema/Result/ScreenshotLinks.pm	39.62% <0%> (+5.66%)	⬆️
lib/OpenQA/Schema/Result/Needles.pm	79.04% <0%> (+5.71%)	⬆️
lib/OpenQA/WebAPI/Controller/API/V1/Job.pm	79.31% <0%> (+6.03%)	⬆️
lib/OpenQA/Utils.pm	90.31% <0%> (+7.18%)	⬆️
lib/OpenQA/Schema/Result/JobModules.pm	91.16% <0%> (+7.9%)	⬆️
lib/OpenQA/Scheduler/FakeApp.pm	95.65% <0%> (+8.69%)	⬆️
lib/OpenQA/Schema/Result/Workers.pm	96.25% <0%> (+8.75%)	⬆️
... and 13 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af71d0a...5d722f4. Read the comment docs.

[coolo]

this really deserves a test case - and IMO a default. Most of the s will contain undef and IMO result in tons of warnings

[Martchus]

@krauselukas As @coolo already mentioned, this will produce tons of warnings if you don't check for undefined. Do you still have time to work on this? I'm asking since you changed the team.

If not, I can take over if this approach for implementing better API documentation is desired. It actually goes into the same direction as I my proposal in the ticket (extending route introspection).

[krauselukas]

@Martchus go for it, i planned to finish all my PR's, but this could take a while, so you are more then welcome to take over :) thank you!

[Martchus]

Ok, then I'll finish this. Shouldn't be much effort (only a few things to fix).

[foursixnine]

Superseded by #1439

[Martchus]

You mean by #1455

[foursixnine]

:P Yeah, that one :)