Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Springett <[email protected]>
  • Loading branch information
stevespringett committed Apr 25, 2023
1 parent f0df2d2 commit 332a05f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
8 changes: 4 additions & 4 deletions schema/bom-1.5.proto
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ message Bom {
repeated ExternalReference external_references = 7;
// Provides the ability to document dependency relationships.
repeated Dependency dependencies = 8;
// Provides the ability to document aggregate completeness
// 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.
repeated Composition compositions = 9;
// Vulnerabilities identified in components or services.
repeated Vulnerability vulnerabilities = 10;
Expand Down Expand Up @@ -568,11 +568,11 @@ enum Aggregate {
}

message Composition {
// Indicates the aggregate completeness
// Specifies an aggregate type that describe how complete a relationship is.
Aggregate aggregate = 1;
// The assemblies the aggregate completeness applies to
// 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.
repeated string assemblies = 2;
// The dependencies the aggregate completeness applies to
// 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.
repeated string dependencies = 3;
// An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.
optional string bom_ref = 4;
Expand Down
4 changes: 2 additions & 2 deletions schema/bom-1.5.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"items": {"$ref": "#/definitions/compositions"},
"uniqueItems": true,
"title": "Compositions",
"description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness."
"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."
},
"vulnerabilities": {
"type": "array",
Expand Down Expand Up @@ -1528,7 +1528,7 @@
"type": "string"
},
"title": "BOM references",
"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."
"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."
},
"dependencies": {
"type": "array",
Expand Down
3 changes: 2 additions & 1 deletion schema/bom-1.5.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -2104,6 +2104,7 @@ limitations under the License.
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.
</xs:documentation>
</xs:annotation>
<xs:complexType>
Expand Down Expand Up @@ -3213,7 +3214,7 @@ limitations under the License.
</xs:element>
<xs:element name="compositions" type="bom:compositionsType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness.</xs:documentation>
<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>
</xs:annotation>
</xs:element>
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
Expand Down

0 comments on commit 332a05f

Please sign in to comment.