Skip to content

Commit 332a05f

Browse files
Updated docs
Signed-off-by: Steve Springett <[email protected]>
1 parent f0df2d2 commit 332a05f

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

schema/bom-1.5.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ message Bom {
2929
repeated ExternalReference external_references = 7;
3030
// Provides the ability to document dependency relationships.
3131
repeated Dependency dependencies = 8;
32-
// Provides the ability to document aggregate completeness
32+
// Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. Other inventory types such as vulnerabilities may also be described for completeness.
3333
repeated Composition compositions = 9;
3434
// Vulnerabilities identified in components or services.
3535
repeated Vulnerability vulnerabilities = 10;
@@ -568,11 +568,11 @@ enum Aggregate {
568568
}
569569

570570
message Composition {
571-
// Indicates the aggregate completeness
571+
// Specifies an aggregate type that describe how complete a relationship is.
572572
Aggregate aggregate = 1;
573-
// The assemblies the aggregate completeness applies to
573+
// The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only. Other inventory types such as vulnerabilities may also be described.
574574
repeated string assemblies = 2;
575-
// The dependencies the aggregate completeness applies to
575+
// The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only.
576576
repeated string dependencies = 3;
577577
// An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.
578578
optional string bom_ref = 4;

schema/bom-1.5.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
"items": {"$ref": "#/definitions/compositions"},
8888
"uniqueItems": true,
8989
"title": "Compositions",
90-
"description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness."
90+
"description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. Other inventory types such as vulnerabilities may also be described for completeness."
9191
},
9292
"vulnerabilities": {
9393
"type": "array",
@@ -1528,7 +1528,7 @@
15281528
"type": "string"
15291529
},
15301530
"title": "BOM references",
1531-
"description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."
1531+
"description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only. Other inventory types such as vulnerabilities may also be described."
15321532
},
15331533
"dependencies": {
15341534
"type": "array",

schema/bom-1.5.xsd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2104,6 +2104,7 @@ limitations under the License.
21042104
The bom-ref identifiers of the components or services being described. Assemblies refer to
21052105
nested relationships whereby a constituent part may include other constituent parts. References
21062106
do not cascade to child parts. References are explicit for the specified constituent part only.
2107+
Other inventory types such as vulnerabilities may also be described.
21072108
</xs:documentation>
21082109
</xs:annotation>
21092110
<xs:complexType>
@@ -3213,7 +3214,7 @@ limitations under the License.
32133214
</xs:element>
32143215
<xs:element name="compositions" type="bom:compositionsType" minOccurs="0" maxOccurs="1">
32153216
<xs:annotation>
3216-
<xs:documentation>Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness.</xs:documentation>
3217+
<xs:documentation>Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. Other inventory types such as vulnerabilities may also be described for completeness.</xs:documentation>
32173218
</xs:annotation>
32183219
</xs:element>
32193220
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">

0 commit comments

Comments
 (0)