From 6c3f3e370b90064d3a7de0628dec3d9d795e136c Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 14 Feb 2024 18:38:55 +0100 Subject: [PATCH 1/2] docs: describe `$.metadata.licenses` Signed-off-by: Jan Kowalleck --- 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. - + + + + The license information for the BOM document. + This may be different from the license(s) of the component that the BOM describes. + + + Provides the ability to document properties in a name/value store. From a9573183d7d237a87c288b8ed6eedbd5f25f6fa8 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Fri, 16 Feb 2024 16:41:24 +0100 Subject: [PATCH 2/2] docs: fix malform/typo Signed-off-by: Jan Kowalleck --- schema/bom-1.6.proto | 2 +- schema/bom-1.6.xsd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/schema/bom-1.6.proto b/schema/bom-1.6.proto index 1c6f842c..1b93ee5c 100644 --- a/schema/bom-1.6.proto +++ b/schema/bom-1.6.proto @@ -228,7 +228,7 @@ enum ExternalReferenceType { EXTERNAL_REFERENCE_TYPE_BUILD_META = 13; // URL to an automated build system EXTERNAL_REFERENCE_TYPE_BUILD_SYSTEM = 14; - // Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501]) that specifies the records containing DNS Security TXT. + // Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT. EXTERNAL_REFERENCE_TYPE_SECURITY_CONTACT = 15; // Human or machine-readable statements containing facts, evidence, or testimony EXTERNAL_REFERENCE_TYPE_ATTESTATION = 16; diff --git a/schema/bom-1.6.xsd b/schema/bom-1.6.xsd index 2254dad6..8fc52396 100644 --- a/schema/bom-1.6.xsd +++ b/schema/bom-1.6.xsd @@ -1314,7 +1314,7 @@ limitations under the License. - Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501]) that specifies the records containing DNS Security TXT. + Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT.