From ad6f39d8b619f9e0e1140d16e08b626f3211f0ab Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 24 Oct 2023 16:43:03 +0200 Subject: [PATCH] docs: improve SPDX expression docs Signed-off-by: Jan Kowalleck --- schema/bom-1.6.proto | 1 + schema/bom-1.6.schema.json | 1 + schema/bom-1.6.xsd | 7 ++++++- 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/schema/bom-1.6.proto b/schema/bom-1.6.proto index a02e9b20..e6a6c4fe 100644 --- a/schema/bom-1.6.proto +++ b/schema/bom-1.6.proto @@ -332,6 +332,7 @@ message Source { message LicenseChoice { oneof choice { License license = 1; + // A valid SPDX license expression. Refer to https://spdx.org/specifications for syntax requirements string expression = 2; } } diff --git a/schema/bom-1.6.schema.json b/schema/bom-1.6.schema.json index dc93c21f..a6574a59 100644 --- a/schema/bom-1.6.schema.json +++ b/schema/bom-1.6.schema.json @@ -945,6 +945,7 @@ "expression": { "type": "string", "title": "SPDX License Expression", + "description": "A valid SPDX license expression.\nRefer to https://spdx.org/specifications for syntax requirements", "examples": [ "Apache-2.0 AND (MIT OR GPL-2.0-only)", "GPL-3.0-only WITH Classpath-exception-2.0" diff --git a/schema/bom-1.6.xsd b/schema/bom-1.6.xsd index 8cb54003..5e218c47 100644 --- a/schema/bom-1.6.xsd +++ b/schema/bom-1.6.xsd @@ -2106,7 +2106,12 @@ limitations under the License. A valid SPDX license expression. - Refer to https://spdx.org/specifications for syntax requirements + Refer to https://spdx.org/specifications for syntax requirements + + Example values: + - Apache-2.0 AND (MIT OR GPL-2.0-only) + - GPL-3.0-only WITH Classpath-exception-2.0 +