Project

General

Profile

bug #7167

dwca-export-controller documentation issues

Added by Andreas Kohlbecker about 1 year ago. Updated about 1 year ago.

Status:
New
Priority:
New
Category:
cdmlib-remote
Target version:
Start date:
01/11/2018
Due date:
% Done:

0%

Severity:
normal
Found in Version:
Tags:

Description

  • the contoller method exportGetExplanation() which is mapped to /dwca returns an html page which will in future contain the documentation of the webservice. The documentation however is in general produced through swagger. Therefore this method seems to be a concurrent approach to produce webservice documentation. I advocate for removing this method and to add proper swagger annotations where needed.
  • swagger annotations are at least need for all request parameters of the type UuidList. All these appear as List<String> in swagger, so the user does not know what to pass to the web service.
  • Passing an invalid uuid as classification causes a Error 400 Bad Request with no further information on the cause, better error reporting is neede here

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 40 MB)