Skip to content

Commit 2cec8d8

Browse files
jkowalleckjkowalleck
committed
docs: streamlined deprecated fields'd descriptions
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 336012c commit 2cec8d8

File tree

3 files changed

+31
-24
lines changed

3 files changed

+31
-24
lines changed

‎schema/bom-1.7.proto‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@ message Component {
101101
optional string bom_ref = 3;
102102
// The organization that supplied the component. The supplier may often be the manufacturer but may also be a distributor or repackager.
103103
optional OrganizationalEntity supplier = 4;
104-
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.authors` or `.manufacturer` instead. The person(s) or organization(s) that authored the component
104+
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.authors` or `.manufacturer` instead.
105+
// The person(s) or organization(s) that authored the component
105106
optional string author = 5 [deprecated = true];
106107
// The person(s) or organization(s) that published the component
107108
optional string publisher = 6;
@@ -577,7 +578,8 @@ message Metadata {
577578
repeated OrganizationalContact authors = 3;
578579
// The component that the BOM describes.
579580
optional Component component = 4;
580-
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use the `.component.manufacturer` instead. The organization that manufactured the component that the BOM describes.
581+
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use the `.component.manufacturer` instead.
582+
// The organization that manufactured the component that the BOM describes.
581583
optional OrganizationalEntity manufacture = 5 [deprecated = true];
582584
// 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.
583585
optional OrganizationalEntity supplier = 6;
@@ -773,15 +775,19 @@ enum TlpClassification {
773775

774776
// Specifies a tool (manual or automated).
775777
message Tool {
776-
// DEPRECATED - DO NOT USE - The vendor of the tool used to create the BOM.
778+
// DEPRECATED - DO NOT USE - This will be removed in a future version.
779+
// The vendor of the tool used to create the BOM.
777780
optional string vendor = 1 [deprecated = true];
778-
// DEPRECATED - DO NOT USE - The name of the tool used to create the BOM.
781+
// DEPRECATED - DO NOT USE - This will be removed in a future version.
782+
// The name of the tool used to create the BOM.
779783
optional string name = 2 [deprecated = true];
780-
// DEPRECATED - DO NOT USE - The version of the tool used to create the BOM.
784+
// DEPRECATED - DO NOT USE - This will be removed in a future version.
785+
// The version of the tool used to create the BOM.
781786
optional string version = 3 [deprecated = true];
782-
// DEPRECATED - DO NOT USE
787+
// DEPRECATED - DO NOT USE - This will be removed in a future version.
783788
repeated Hash hashes = 4 [deprecated = true];
784-
// DEPRECATED - DO NOT USE - Provides the ability to document external references related to the tool.
789+
// DEPRECATED - DO NOT USE - This will be removed in a future version.
790+
// Provides the ability to document external references related to the tool.
785791
repeated ExternalReference external_references = 5 [deprecated = true];
786792
// A list of software and hardware components used as tools
787793
repeated Component components = 6;
@@ -2293,7 +2299,7 @@ message CryptoProperties {
22932299
optional string algorithmFamily = 12;
22942300
// An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).
22952301
optional string parameterSetIdentifier = 2;
2296-
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.ellipticCurve` Instead.
2302+
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.ellipticCurve` instead.
22972303
// The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends use of curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source from which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves).
22982304
optional string curve = 3 [deprecated = true];
22992305
// The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity.
@@ -2669,7 +2675,7 @@ message CryptoProperties {
26692675
optional string version = 2;
26702676
// A list of cipher suites related to the protocol.
26712677
repeated CryptoProtocolCipherSuite cipherSuites = 3;
2672-
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.ikev2TransformTypesDetailed` Instead.
2678+
// DEPRECATED - DO NOT USE - This will be removed in a future version - Use `.ikev2TransformTypesDetailed` instead.
26732679
// The IKEv2 transform types supported (types 1-4), defined in RFC7296 section 3.3.2, and additional properties.
26742680
optional Ikev2TransformTypes ikev2TransformTypes = 4 [deprecated = true];
26752681
// The IKEv2 transform types supported (types 1-4), defined in RFC7296 section 3.3.2, and additional properties.

‎schema/bom-1.7.schema.json‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,7 @@
687687
{
688688
"type": "array",
689689
"title": "Tools (legacy)",
690-
"description": "[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM.",
690+
"description": "[Deprecated]\nThe tool(s) used in the creation, enrichment, and validation of the BOM.",
691691
"items": {"$ref": "#/definitions/tool"}
692692
}
693693
]
@@ -767,7 +767,7 @@
767767
"tool": {
768768
"type": "object",
769769
"title": "Tool",
770-
"description": "[Deprecated] This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used",
770+
"description": "[Deprecated] This will be removed in a future version. Use component or service instead.\nInformation about the automated or manual tool used",
771771
"additionalProperties": false,
772772
"properties": {
773773
"vendor": {
@@ -1063,7 +1063,7 @@
10631063
"modified": {
10641064
"type": "boolean",
10651065
"title": "Component Modified From Original",
1066-
"description": "[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
1066+
"description": "[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified.\nA boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
10671067
},
10681068
"pedigree": {
10691069
"type": "object",
@@ -2978,7 +2978,7 @@
29782978
{
29792979
"type": "array",
29802980
"title": "Tools (legacy)",
2981-
"description": "[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability.",
2981+
"description": "[Deprecated]\nThe tool(s) used to identify, confirm, or score the vulnerability.",
29822982
"items": {"$ref": "#/definitions/tool"}
29832983
}
29842984
]
@@ -5534,7 +5534,7 @@
55345534
"deprecated": true,
55355535
"$ref": "#/definitions/refType",
55365536
"title": "Key reference",
5537-
"description": "[DEPRECATED] This will be removed in a future version. Use `@.relatedCryptographicAssets` instead. The bom-ref to the public key of the subject"
5537+
"description": "[DEPRECATED] This will be removed in a future version. Use `@.relatedCryptographicAssets` instead.\nThe bom-ref to the public key of the subject"
55385538
},
55395539
"certificateFormat": {
55405540
"type": "string",
@@ -5837,7 +5837,7 @@
58375837
"deprecated": true,
58385838
"$ref": "#/definitions/refType",
58395839
"title": "Algorithm Reference",
5840-
"description": "[DEPRECATED] Use `relatedCryptographicAssets` instead.\nThe bom-ref to the algorithm used to generate the related cryptographic material."
5840+
"description": "[DEPRECATED] Use `@.relatedCryptographicAssets` instead.\nThe bom-ref to the algorithm used to generate the related cryptographic material."
58415841
},
58425842
"creationDate": {
58435843
"type": "string",
@@ -5978,7 +5978,7 @@
59785978
{
59795979
"deprecated": true,
59805980
"$ref": "#/definitions/cryptoRefArray",
5981-
"description": "[DEPRECATED] This will be removed in a future version. Transform Type 1: encryption algorithms"
5981+
"description": "[DEPRECATED] This will be removed in a future version.\nTransform Type 1: encryption algorithms"
59825982
}
59835983
]
59845984
},
@@ -5996,7 +5996,7 @@
59965996
{
59975997
"deprecated": true,
59985998
"$ref": "#/definitions/cryptoRefArray",
5999-
"description": "[DEPRECATED] This will be removed in a future version. Transform Type 2: pseudorandom functions"
5999+
"description": "[DEPRECATED] This will be removed in a future version.\nTransform Type 2: pseudorandom functions"
60006000
}
60016001
]
60026002
},
@@ -6014,7 +6014,7 @@
60146014
{
60156015
"deprecated": true,
60166016
"$ref": "#/definitions/cryptoRefArray",
6017-
"description": "[DEPRECATED] This will be removed in a future version. Transform Type 3: integrity algorithms"
6017+
"description": "[DEPRECATED] This will be removed in a future version.\nTransform Type 3: integrity algorithms"
60186018
}
60196019
]
60206020
},
@@ -6032,7 +6032,7 @@
60326032
{
60336033
"deprecated": true,
60346034
"$ref": "#/definitions/cryptoRefArray",
6035-
"description": "[DEPRECATED] This will be removed in a future version. Transform Type 4: Key Exchange Method (KE) per [RFC 9370](https://www.ietf.org/rfc/rfc9370.html), formerly called Diffie-Hellman Group (D-H)."
6035+
"description": "[DEPRECATED] This will be removed in a future version.\nTransform Type 4: Key Exchange Method (KE) per [RFC 9370](https://www.ietf.org/rfc/rfc9370.html), formerly called Diffie-Hellman Group (D-H)."
60366036
}
60376037
]
60386038
},
@@ -6055,7 +6055,7 @@
60556055
{
60566056
"deprecated": true,
60576057
"$ref": "#/definitions/cryptoRefArray",
6058-
"description": "[DEPRECATED] This will be removed in a future version. IKEv2 Authentication method"
6058+
"description": "[DEPRECATED] This will be removed in a future version.\nIKEv2 Authentication method"
60596059
}
60606060
]
60616061
}
@@ -6065,7 +6065,7 @@
60656065
"deprecated": true,
60666066
"$ref": "#/definitions/cryptoRefArray",
60676067
"title": "Cryptographic References",
6068-
"description": "[DEPRECATED] Use `relatedCryptographicAssets` instead. A list of protocol-related cryptographic assets"
6068+
"description": "[DEPRECATED] Use `@.relatedCryptographicAssets` instead.\nA list of protocol-related cryptographic assets"
60696069
},
60706070
"relatedCryptographicAssets": {
60716071
"$ref": "#/definitions/relatedCryptographicAssets",
@@ -6256,6 +6256,7 @@
62566256
},
62576257
"cryptoRefArray" : {
62586258
"deprecated": true,
6259+
"description": "Deprecated definition.",
62596260
"type": "array",
62606261
"items": {
62616262
"$ref": "#/definitions/refType"

‎schema/bom-1.7.xsd‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ limitations under the License.
179179
<xs:sequence minOccurs="0" maxOccurs="unbounded">
180180
<xs:element name="tool" minOccurs="0" type="bom:toolType">
181181
<xs:annotation>
182-
<xs:documentation>DEPRECATED. Use tools\components or tools\services instead.</xs:documentation>
182+
<xs:documentation>DEPRECATED. Use `../components` or `../services` instead.</xs:documentation>
183183
</xs:annotation>
184184
</xs:element>
185185
</xs:sequence>
@@ -2377,7 +2377,7 @@ limitations under the License.
23772377
<xs:sequence minOccurs="0" maxOccurs="unbounded">
23782378
<xs:element name="classification" type="bom:dataClassificationType">
23792379
<xs:annotation>
2380-
<xs:documentation>DEPRECATED: Specifies the data classification. THIS FIELD IS DEPRECATED AS OF v1.5. Use dataflow\classification instead</xs:documentation>
2380+
<xs:documentation>DEPRECATED: Specifies the data classification. THIS FIELD IS DEPRECATED AS OF v1.5. Use `./dataflow/classification` instead</xs:documentation>
23812381
</xs:annotation>
23822382
</xs:element>
23832383
</xs:sequence>
@@ -4604,7 +4604,7 @@ limitations under the License.
46044604
<xs:sequence minOccurs="0" maxOccurs="unbounded">
46054605
<xs:element name="tool" minOccurs="0" type="bom:toolType">
46064606
<xs:annotation>
4607-
<xs:documentation>DEPRECATED. Use tools\components or tools\services instead.</xs:documentation>
4607+
<xs:documentation>DEPRECATED. Use `../components` or `../services` instead.</xs:documentation>
46084608
</xs:annotation>
46094609
</xs:element>
46104610
</xs:sequence>

0 commit comments

Comments
 (0)