docs: improve SPDX expression docs (CycloneDX#327)

tsjensen · Oct 24, 2023 · 9a95cff · 9a95cff
2 parents 6dac012 + ad6f39d
commit 9a95cff
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git 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
@@ -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
@@ -2106,7 +2106,12 @@ limitations under the License.
             <xs:element name="expression" minOccurs="0" maxOccurs="1">
                 <xs:annotation>
                     <xs:documentation>A valid SPDX license expression.
-                        Refer to https://spdx.org/specifications for syntax requirements</xs:documentation>
+                        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
+                    </xs:documentation>
                 </xs:annotation>
                 <xs:complexType>
                     <xs:simpleContent>