From 6c3f3e370b90064d3a7de0628dec3d9d795e136c Mon Sep 17 00:00:00 2001
From: Jan Kowalleck <jan.kowalleck@gmail.com>
Date: Wed, 14 Feb 2024 18:38:55 +0100
Subject: [PATCH] docs: describe `$.metadata.licenses`

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
---
 schema/bom-1.6.proto       | 2 +-
 schema/bom-1.6.schema.json | 1 +
 schema/bom-1.6.xsd         | 9 ++++++++-
 3 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/schema/bom-1.6.proto b/schema/bom-1.6.proto
index 1c6f842c..f19815d8 100644
--- a/schema/bom-1.6.proto
+++ b/schema/bom-1.6.proto
@@ -448,7 +448,7 @@ message Metadata {
   optional OrganizationalEntity manufacture = 5;
   // The organization that supplied the component that the BOM describes. The supplier may often be the manufacture, but may also be a distributor or repackager.
   optional OrganizationalEntity supplier = 6;
-  // The license information for the BOM document
+  // The license information for the BOM document. This may be different from the license(s) of the component that the BOM describes.
   optional LicenseChoice licenses = 7;
   // Specifies optional, custom, properties
   repeated Property properties = 8;
diff --git a/schema/bom-1.6.schema.json b/schema/bom-1.6.schema.json
index f607294d..f6604e76 100644
--- a/schema/bom-1.6.schema.json
+++ b/schema/bom-1.6.schema.json
@@ -689,6 +689,7 @@
         },
         "licenses": {
           "title": "BOM License(s)",
+          "description": "The license information for the BOM document.\nThis may be different from the license(s) of the component that the BOM describes.",
           "$ref": "#/definitions/licenseChoice"
         },
         "properties": {
diff --git a/schema/bom-1.6.xsd b/schema/bom-1.6.xsd
index 2254dad6..1087e23b 100644
--- a/schema/bom-1.6.xsd
+++ b/schema/bom-1.6.xsd
@@ -223,7 +223,14 @@ limitations under the License.
                         supplier may often be the manufacturer, but may also be a distributor or repackager.</xs:documentation>
                 </xs:annotation>
             </xs:element>
-            <xs:element name="licenses" type="bom:licenseChoiceType" minOccurs="0" maxOccurs="1"/>
+            <xs:element name="licenses" type="bom:licenseChoiceType" minOccurs="0" maxOccurs="1">
+                <xs:annotation>
+                    <xs:documentation>
+                        The license information for the BOM document.
+                        This may be different from the license(s) of the component that the BOM describes.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:element>
             <xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
                 <xs:annotation>
                     <xs:documentation>Provides the ability to document properties in a name/value store.