REST - Revision history

CarstenEmde: Added OpenAPI specification

2025-09-30T13:17:07Z

Added OpenAPI specification

← Older revision		Revision as of 15:17, 30 September 2025
Line 32:		Line 32:
	</span>		</span>
	</html>		</html>
			====OpenAPI schema====
			The OpenAPI schema is available [https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/refs/heads/main/openapi.yaml here] and should also be listed on the various public OpenAPI specs collections.

CarstenEmde: Updated OSSelot logo to new font feature

2023-11-01T14:43:56Z

Updated OSSelot logo to new font feature

← Older revision		Revision as of 16:43, 1 November 2023
Line 19:		Line 19:
	<script src="/scripts/osadl.js">		<script src="/scripts/osadl.js">
	</script>		</script>
	<h4 style="padding-bottom: 8px;">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 <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>		<h4 style="padding-bottom: 8px;">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 <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curation data in a new window</h4>
	<span><label for="formats">Format: </label>		<span><label for="formats">Format: </label>
	<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats">		<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats">
Line 28:		Line 28:
	</select>		</select>
	<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" />		<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" />
	<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />		<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br />
	<span style="display: none;"></span>		<span style="display: none;"></span>
	</span>		</span>
	</html>		</html>

CarstenEmde: Added scheme to retrieve all versions at once with JSON

2023-08-06T14:19:19Z

Added scheme to retrieve all versions at once with JSON

← Older revision		Revision as of 16:19, 6 August 2023
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">

CarstenEmde: Switched to the generic host interface at rest.osselot.org

2023-08-02T12:54:05Z

Switched to the generic host interface at rest.osselot.org

← Older revision		Revision as of 14:54, 2 August 2023
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 ~~uses~~ HTTP protocol ~~at port 3262~~ and the following scheme:		This REST interface is available through standard HTTP protocol and the following scheme:
	<pre>		<pre>
	http://~~www~~.osselot.org~~:3262~~/<format>/<package>/<version>		http://rest.osselot.org/<format>/<package>/<version>
	</pre>		</pre>
	Alternatively and if needed, the SSL-enabled port ~~3263~~ can be used in which case the scheme has the form		Alternatively and if needed, the SSL-enabled port can be used in which case the scheme has the form
	<pre>		<pre>
	https://~~www~~.osselot.org~~:3263~~/<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.

Wiki at 17:53, 27 July 2023

2023-07-27T17:53:27Z

← Older revision		Revision as of 19:53, 27 July 2023
Line 15:		Line 15:
	<html>		<html>
	<script src="/scripts/osadl.js">		<script src="/scripts/osadl.js">
	~~</script>~~
	~~<script>~~
	~~function onselectchange(select, link)~~
	{
	~~button = select.nextElementSibling.nextElementSibling;~~
	~~if (button.nextElementSibling.nextElementSibling.style.display != "none")~~
	~~searchOSSelot(button, link);~~
	}
	</script>		</script>
	<h4 style="padding-bottom: 8px;">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 <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>		<h4 style="padding-bottom: 8px;">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 <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>

Wiki at 16:25, 27 July 2023

2023-07-27T16:25:12Z

← Older revision		Revision as of 18:25, 27 July 2023
Line 19:		Line 19:
	function onselectchange(select, link)		function onselectchange(select, link)
	{		{
	~~searchOSSelot~~(~~select~~.nextElementSibling.nextElementSibling, link);		button = select.nextElementSibling.nextElementSibling;
			if (button.nextElementSibling.nextElementSibling.style.display != "none")
			searchOSSelot(button, link);
	}		}
	</script>		</script>

Wiki at 16:13, 27 July 2023

2023-07-27T16:13:39Z

← Older revision		Revision as of 18:13, 27 July 2023
Line 22:		Line 22:
	}		}
	</script>		</script>
	<h4>Use the below search ~~box~~ to immediately ~~test~~ the REST interface for the ~~available data formats~~ and display the ~~selected~~ <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>		<h4 style="padding-bottom: 8px;">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 <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
	<span><label for="formats">Format: </label>		<span><label for="formats">Format: </label>
	<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats">		<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats">

Wiki: Added search box

2023-07-27T16:05:21Z

Added search box

← Older revision		Revision as of 18:05, 27 July 2023
Line 12:		Line 12:
	</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.

			<html>
			<script src="/scripts/osadl.js">
			</script>
			<script>
			function onselectchange(select, link)
			{
			searchOSSelot(select.nextElementSibling.nextElementSibling, link);
			}
			</script>
			<h4>Use the below search box to immediately test the REST interface for the available data formats and display the selected <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
			<span><label for="formats">Format: </label>
			<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats">
			<option value="json" selected="selected">JSON</option>
			<option value="xml">RDF-XML</option>
			<option value="spdx">SPDX2TV</option>
			<option value="yaml">YAML</option>
			</select>
			<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" />
			<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
			<span style="display: none;"></span>
			</span>
			</html>

Wiki: Added SSL mode via port 3263

2023-07-27T00:51:55Z

Added SSL mode via port 3263

← Older revision		Revision as of 02:51, 27 July 2023
Line 6:		Line 6:
	<pre>		<pre>
	http://www.osselot.org:3262/<format>/<package>/<version>		http://www.osselot.org:3262/<format>/<package>/<version>
			</pre>
			Alternatively and if needed, the SSL-enabled port 3263 can be used in which case the scheme has the form
			<pre>
			https://www.osselot.org:3263/<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.

Wiki: Added RDF-XML

2023-07-26T23:12:36Z

Added RDF-XML

← Older revision		Revision as of 01:12, 27 July 2023
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.