REST: Difference between revisions

From OSSelot
Jump to navigation Jump to search
(Created initial content)
 
(Added RDF-XML)
Line 1: Line 1:
==Obtain curation data via a REST interface==
==Obtain curation data via a REST interface==
====Available formats====
====Available formats====
Currently, the curated data are available in [[JSON]], [[SPDX2TV]] and [[YAML]] format.
Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.
====Scheme====
====Scheme====
This REST interface uses HTTP protocol at port 3262 and the following scheme:
This REST interface uses HTTP protocol at port 3262 and the following scheme:
Line 7: Line 7:
http://www.osselot.org:3262/<format>/<package>/<version>
http://www.osselot.org:3262/<format>/<package>/<version>
</pre>
</pre>
where <format> may be any of "json", "spdx" or "yaml". The version must be given when [[SPDX2TV]] or [[YAML]] format is used. Only [[JSON]] format permits to retrieve all curated versions of a software package with a single REST call.
where <format> may be any of "json", "spdx", "xml" or "yaml". The version must be given when [[RDF-XML]], [[SPDX2TV]] or [[YAML]] format is used. Only [[JSON]] format permits to retrieve all curated versions of a software package with a single REST call.

Revision as of 00:12, 27 July 2023

Obtain curation data via a REST interface

Available formats

Currently, the curated data are available in JSON, RDF-XML, SPDX2TV and YAML format.

Scheme

This REST interface uses HTTP protocol at port 3262 and the following scheme:

http://www.osselot.org:3262/<format>/<package>/<version>

where <format> may be any of "json", "spdx", "xml" or "yaml". The version must be given when RDF-XML, SPDX2TV or YAML format is used. Only JSON format permits to retrieve all curated versions of a software package with a single REST call.