REST: Difference between revisions

From OSSelot
Jump to navigation Jump to search
m (Switched to the generic host interface at rest.osselot.org)
(Added scheme to retrieve all versions at once with JSON)
Line 11: Line 11:
https://rest.osselot.org/<format>/<package>/<version>
https://rest.osselot.org/<format>/<package>/<version>
</pre>
</pre>
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.
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. When this is intended the scheme has the form
 
<pre>
https://rest.osselot.org/json/<package>
</pre>
and the various versions will be encapsulated in a JSON super object.
<html>
<html>
<script src="/scripts/osadl.js">
<script src="/scripts/osadl.js">

Revision as of 15:19, 6 August 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 is available through standard HTTP protocol and the following scheme:

http://rest.osselot.org/<format>/<package>/<version>

Alternatively and if needed, the SSL-enabled port can be used in which case the scheme has the form

https://rest.osselot.org/<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. When this is intended the scheme has the form

https://rest.osselot.org/json/<package>

and the various versions will be encapsulated in a JSON super object.

Use the below select box and search field to define a data format and enter the name of a software package. Then select one of the available software versions to immediately run the REST interface for the given package and display the O curation data in a new window