Skip to content

Commit 80bc39b

Browse files
committed
docs
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 7b5d023 commit 80bc39b

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

schema/bom-1.7.schema.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -928,7 +928,8 @@
928928
"versionRange": {
929929
"$ref": "#/definitions/versionRange",
930930
"title": "Component Version Range",
931-
"description": "The component version range that may be provided to fulfill this capability.\nMAY only occur if `isExtraneous` is `true`."
931+
"description": "The component version range that may be provided to fulfill this capability.\nMAY only occur if property `isExtraneous` is set to 'true'.",
932+
"$comment": "a rule is taking cate of the plausibility between `version`/`versionRange` and `isExtraneous`=='true'"
932933
},
933934
"description": {
934935
"type": "string",

schema/bom-1.7.xsd

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -564,7 +564,11 @@ limitations under the License.
564564
<xs:element name="versionRange" type="bom:versionRangeType" minOccurs="0" maxOccurs="1">
565565
<xs:annotation>
566566
<xs:documentation>The component version range that may be provided to fulfill this capability.
567-
MAY only occur if `isExtraneous` is `true`.</xs:documentation>
567+
MAY only occur if attribute `isExtraneous` is set to `true`.</xs:documentation>
568+
<!-- Attention:
569+
Since XSD 1.1 `asserts` are mostly not implemented, there is currently no rule in this XSD,
570+
that is taking cate of the plausibility between `version`/`versionRange` and `isExtraneous`=='true'
571+
-->
568572
</xs:annotation>
569573
</xs:element>
570574
</xs:choice>
@@ -775,12 +779,11 @@ limitations under the License.
775779
do not have the same name as an existing attribute used by the schema.</xs:documentation>
776780
</xs:annotation>
777781
</xs:anyAttribute>
778-
<!--
779-
this would be formal, if the support for XSD1.1's `assert` was properly implemented
780-
in validators and tools digesting XML.
782+
<!-- Attention:
783+
This would be formal, if the support for XSD1.1's `assert` was properly implemented in validators and tools digesting XML.
781784
<xs:assert id="versionRange_requires_isExtraneous_eq_true"
782785
test="if (versionRange) then (@isExtraneous eq 'true') else true()">
783-
child `versionRange` MAY only be present, if attribute `isExtraneous` is `true`
786+
Child `versionRange` MAY only be present, if attribute `isExtraneous` is 'true'.
784787
</xs:assert>
785788
-->
786789
</xs:complexType>

0 commit comments

Comments
 (0)