[FOSSology] REST access to fossology

[Philippe PM Martin]

Hello, This message is a response to bob.gobei...@hp.com  who asked me to describe how I would like REST access to fossology to work. This is a short description of what I see as needed in the field of automated procedures. When writing automated tasks procedures, it is very convenient to be able to: drive a server such as fossology from remote query the same server for results which can be in turn consumed by automated tasks. In order to do so, we need a REST access providing at least possibility to : Drive Fossology serveur Operations which would be nice to launch from remote are: Upload stuff including from SVN repo via REST access For SVN :  http://my.fossology.org/repo/upload?name='xx'?archive='https://svn_server/svn/...'?protocol=svn?... For FTP :  http://my.fossology.org/repo/upload?name='xx'?archive='ftp://ftp_server/...'?... For HTTP: http://my.fossology.org/repo/upload?name='xx'?archive='http://http_server/...'?... Today, these operations can only be done via Web UI or cp2foss, except for the SVN upload Launch jobs  via REST access http://my.fossology.org/repo/runjob?uploadId='xx' As done today via Web UI or fossjobs -U uploadId delete upload via REST access To be completed. Query Fossology server REST Queries should return results in XML format which is more appropriate for automatic processing. Queries of interest could be: Lists of all available functionalities could be handily found here (HTML for human): http://my.fossology.org/repo/api server props query http://my.fossology.org/repo/api/xml returns : FOSSology version X.Y.Z as returned by http://my.fossology.org/repo/?mod=about in HTML get licence analysis summary for an upload identified by name http://my.fossology.org/repo/upload/upload_name/api/xml as returned by http://my.fossology.org/repo/?mod=license&upload=xx&item=yy in HTML get job history for an upload identified by name http://my.fossology.org/repo/jobs/upload_name/api/xml as returned by http://my.fossology.org/repo/?mod=showjobs&show=summary&history=1&folder=1&upload=xx in HTML .....    to be completed. This kind of REST operations can be found in Hudson for example (http://hudson-ci.org/) which is Web UI oriented but provides also remote access. Of course, we have still to find a decent way to authenticate while doing these operations and if it is nice to POST requests and to GET results, it would be smart to be notified when an analysis ends. fo_notify can send mail but a fossology agent notifier triggering the retrieval of the analysis results via an URL (web trigger) would be great too. Regards, -- Phil MARTIN -- -------------------------------------------------------------------------- Philippe MARTIN Philippe.PM.Martin%alcatel-lucent.fr ALCATEL-LUCENT CPG/CTO/RDC/Systems & Software Engineering Route de Villejust Tel : 01 30 77 28 23 91620 NOZAY --------------------------------------------------------------------------

_______________________________________________
fossology mailing list
fossology@fossology.org
http://fossology.org/mailman/listinfo/fossology