search

EEXCESS / recommender

EEXCESS stands for: Enhancing Europe’s eXchange in Cultural Educational and Scientific reSources and is funded by the EU under GA No. 600601
http://eexcess.eu/
3 stars 4 forks source link

Fully document the REST-API #3

Open schloett opened 9 years ago

schloett commented 9 years ago

Please document the API in such a way, that an external developer is able to work with it. At the moment, the description is based on an example for request and response. For developers, who are not involved in EEXCESS (and partially even for those), it is almost impossible to figure out the meaning and effect of the particular attributes. Moreover, the range of expected values is unclear for example at the attribute "timeRange". In addition, it would be nice to have URLs of the servers available.

hziak commented 9 years ago

added comments to the fields and explained possible implications

schloett commented 8 years ago

The documentation does not seem to be sufficient yet. See #10, #32 or https://github.com/EEXCESS/eexcess/issues/11 for example.