feat: license url

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

schema/bom-1.7.proto

@@ -435,6 +435,8 @@ message LicenseExpressionDetailed {
     optional string bom_ref = 2;
     // An optional way to include the textual content of the license.
     optional AttachedText text = 3;
+    // The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness
+    optional string url = 4;
   }
 
   // A valid SPDX license expression. Refer to https://spdx.org/specifications for syntax requirements.

schema/bom-1.7.schema.json

@@ -1524,6 +1524,13 @@
                       "title": "License texts",
                       "description": "An optional way to include the textual content of the license.",
                       "$ref": "#/definitions/attachment"
+                    },
+                    "url": {
+                      "type": "string",
+                      "title": "License URL",
+                      "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+                      "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+                      "format": "iri-reference"
                     }
                   },
                   "additionalProperties": false

schema/bom-1.7.xsd

@@ -1008,6 +1008,12 @@ limitations under the License.
                                 <xs:documentation>An optional way to include the textual content of the license.</xs:documentation>
                             </xs:annotation>
                         </xs:element>
+                        <xs:element name="url" type="xs:anyURI" minOccurs="0" maxOccurs="1">
+                            <xs:annotation>
+                                <xs:documentation>The URL to the attachment file. If the attachment is a license or BOM,
+                                    an externalReference should also be specified for completeness.</xs:documentation>
+                            </xs:annotation>
+                        </xs:element>
                         <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded">
                             <xs:annotation>
                                 <xs:documentation>

tools/src/test/resources/1.7/valid-license-expression-with-text-1.7.json

@@ -20,7 +20,8 @@
               "licenseIdentifier": "LicenseRef-my-custom-license",
               "text": {
                 "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
-              }
+              },
+              "url": "https://my-application.example.com/license.txt"
             },
             {
               "licenseIdentifier": "EPL-2.0",

tools/src/test/resources/1.7/valid-license-expression-with-text-1.7.textproto

@@ -19,6 +19,7 @@ components {
         text {
           value: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
         }
+        url: "https://my-application.example.com/license.txt"
       }
       details {
         license_identifier: "EPL-2.0"

tools/src/test/resources/1.7/valid-license-expression-with-text-1.7.xml

@@ -17,6 +17,7 @@
                 >
                     <details license-identifier="LicenseRef-my-custom-license">
                         <text>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</text>
+                        <url>https://my-application.example.com/license.txt</url>
                     </details>
                     <details license-identifier="EPL-2.0">
                         <text><![CDATA[Eclipse Public License - v 2.0