Skip to content

Commit 85e903d

Browse files
committed
refactor: rename and docs
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent 267ef6d commit 85e903d

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

schema/bom-1.7.proto

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ message LicenseChoice {
387387
// A valid SPDX license expression. Refer to https://spdx.org/specifications for syntax requirements.
388388
string expression = 2;
389389
// A SPDX license expression and its details
390-
ExpressionDetailed expression_detailed = 5;
390+
LicenseExpressionDetailed expression_detailed = 5;
391391
}
392392
// This field must only be used when `expression` is chosen as the other options have their own acknowledgement.
393393
optional LicenseAcknowledgementEnumeration acknowledgement = 3;
@@ -417,8 +417,9 @@ message License {
417417
optional LicenseAcknowledgementEnumeration acknowledgement = 8;
418418
}
419419

420-
// Specifies the details and attributes related to a software license. It must be a valid SPDX license expression, along with additional properties such as license acknowledgment.
421-
message ExpressionDetailed {
420+
// Specifies the details and attributes related to a software license.
421+
// It must be a valid SPDX license expression, along with additional properties such as license acknowledgment.
422+
message LicenseExpressionDetailed {
422423

423424
// Specifies the details and attributes related to a software license identifier.
424425
// (An SPDX expression may be a compound of license identifiers.)

schema/bom-1.7.schema.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1479,6 +1479,8 @@
14791479
"minItems": 1,
14801480
"maxItems": 1,
14811481
"items": [{
1482+
"title": "License Expression",
1483+
"description": "Specifies the details and attributes related to a software license.\nIt must be a valid SPDX license expression, along with additional properties such as license acknowledgment.",
14821484
"type": "object",
14831485
"additionalProperties": false,
14841486
"required": ["expression"],

schema/bom-1.7.xsd

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,7 @@ limitations under the License.
966966
<xs:attributeGroup ref="bom:licenseAttributes"/>
967967
</xs:complexType>
968968

969-
<xs:complexType name="expressionType">
969+
<xs:complexType name="licenseExpressionType">
970970
<xs:simpleContent>
971971
<xs:extension base="xs:normalizedString">
972972
<xs:annotation>
@@ -983,9 +983,12 @@ limitations under the License.
983983
</xs:simpleContent>
984984
</xs:complexType>
985985

986-
<xs:complexType name="expressionDetailedType">
986+
<xs:complexType name="licenseExpressionDetailedType">
987987
<xs:annotation>
988-
<xs:documentation>Specifies the details and attributes related to a software license. It must be a valid SPDX license expression, along with additional properties such as license acknowledgment.</xs:documentation>
988+
<xs:documentation>
989+
Specifies the details and attributes related to a software license.
990+
It must be a valid SPDX license expression, along with additional properties such as license acknowledgment.
991+
</xs:documentation>
989992
</xs:annotation>
990993
<xs:sequence>
991994
<xs:element name="details" minOccurs="0" maxOccurs="unbounded">
@@ -2387,8 +2390,8 @@ limitations under the License.
23872390
<xs:complexType name="licenseChoiceType">
23882391
<xs:choice>
23892392
<xs:element name="license" type="bom:licenseType" minOccurs="0" maxOccurs="unbounded"/>
2390-
<xs:element name="expression" type="bom:expressionType" minOccurs="0" maxOccurs="1" />
2391-
<xs:element name="expression-detailed" type="bom:expressionDetailedType" minOccurs="0" maxOccurs="1" />
2393+
<xs:element name="expression" type="bom:licenseExpressionType" minOccurs="0" maxOccurs="1" />
2394+
<xs:element name="expression-detailed" type="bom:licenseExpressionDetailedType" minOccurs="0" maxOccurs="1" />
23922395
</xs:choice>
23932396
</xs:complexType>
23942397

0 commit comments

Comments
 (0)