Various comments on specification - Githubissues

WASAPI-Community / data-transfer-apis

WASAPI data transfer APIs

42 stars 6 forks source link

Various comments on specification #5

Open justinlittman opened 7 years ago

justinlittman commented 7 years ago

/webdata related

"Includes extra" needs clearer explanation.
Are implementers required to support /webdata without parameters? This can potentially be a huge resultset.
Recommend that in /webdata reply, checksum should be a map, not string.
What is the format of a locations string?
There might be some benefit to some standardized, but optional, /webdata parameters.
There might be some benefit to a standardized datetime format for /webdata parameters.

/jobs related

The URI for a job should be included in the various responses that list or detail jobs.
Perhaps GET /jobs should provide a summary of each job instead of the full job detail (including files).
Query parameter should be a map instead of a querystring.

General

Is it possible to implement /webdata without /jobs (or vice versa)?
Pagination is needed.