REST: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
CarstenEmde (talk | contribs) m (Switched to the generic host interface at rest.osselot.org) |
||
| Line 3: | Line 3: | ||
Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format. | Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format. | ||
====Scheme==== | ====Scheme==== | ||
This REST interface | This REST interface is available through standard HTTP protocol and the following scheme: | ||
<pre> | <pre> | ||
http:// | http://rest.osselot.org/<format>/<package>/<version> | ||
</pre> | </pre> | ||
Alternatively and if needed, the SSL-enabled port | Alternatively and if needed, the SSL-enabled port can be used in which case the scheme has the form | ||
<pre> | <pre> | ||
https:// | 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. | ||
Revision as of 13:54, 2 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.