dmwm / PHEDEX

CMS data-placement suite
8 stars 18 forks source link

Inconsistent documentation/validation in BlockTestFiles API #1081

Closed nataliaratnikova closed 7 years ago

nataliaratnikova commented 7 years ago

The documentation says: required: one of test or node

while the implementation in the parameters validation requires test or block ,see
https://github.com/dmwm/PHEDEX/blob/master/perl_lib/PHEDEX/Web/API/BlockTestFiles.pm#L124

Not sure what was the intention here => ask the transfer operations whether they lookup more frequently by node or by block.

As for the mandatory "test" input parameter, this is an internal test Id assigned during the test injection and a regular user does not normally have a way to know it.

nataliaratnikova commented 7 years ago

Require one of: node or block parameters, do not require test, as the user does not normally have a way to know it.
Fixed both validation configuration and the documentation to be consistent.