Skip to content

Commit b2969be

Browse files
nnobelissschuberth
authored andcommitted
docs(reporter): Update FossID report types documentation
Signed-off-by: Nicolas Nobelis <[email protected]>
1 parent 2e20fbc commit b2969be

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

clients/fossid-webapp/src/main/kotlin/model/report/Model.kt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,17 @@ package org.ossreviewtoolkit.clients.fossid.model.report
2121

2222
/**
2323
* Available FossID report types.
24+
* FossID accepts the following report types:
25+
* >= 24.2: SPDX, XLSX, STRING_MATCH, DYNAMIC_TOP_MATCHED_COMPONENTS, CYCLONE_DX, SPDX_LITE, HTML.
26+
* < 24.2: HTML, STRING_MATCH, DYNAMIC_TOP_MATCHED_COMPONENTS, DYNAMIC_TOP_MATCHED_COMPONENTS,
27+
* GENERATE_DYNAMIC_TOP_MATCHED_REPORT, CYCLONE_DX, SPDX_LITE, SPDX, SPDX_LITE, XLSX, DYNAMIC, BASIC, STRING_MATCH,
28+
* PRELIMINARY, CYCLONE_DX
2429
*/
2530
enum class ReportType(private val value: String) {
2631
/**
2732
* Interactive and self-contained HTML report providing advanced features for searching, filtering and investigating
28-
* the results. Requires Javascript and corresponds to the UI report "Full FossID report".
33+
* the results. Requires Javascript and corresponds to the UI report "Full FossID report". This report type has been
34+
* removed with FossID 24.2.
2935
*/
3036
HTML_DYNAMIC("dynamic"),
3137

@@ -36,7 +42,8 @@ enum class ReportType(private val value: String) {
3642
HTML_STATIC("html"),
3743

3844
/**
39-
* Software Package Data Exchange (SPDX) conformant XML file. Corresponds to the UI report "SPDX".
45+
* Software Package Data Exchange (SPDX) conformant XML file. Corresponds to the UI report "SPDX". This report type
46+
* has been removed with FossID 24.2
4047
*/
4148
SPDX_RDF("spdx"),
4249

plugins/reporters/fossid/src/main/kotlin/FossIdReporter.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ data class FossIdReporterConfig(
6060
val user: Secret,
6161

6262
/**
63-
* The type of report to generate. Allowed values are "HTML_DYNAMIC", "HTML_STATIC", "SPDX_RDF", and "XLSX".
63+
* The type of report to generate. See [ReportType].
6464
*/
6565
@OrtPluginOption(defaultValue = "XLSX")
6666
val reportType: String,

0 commit comments

Comments
 (0)