Skip to content

Commit b20b074

Browse files
authored
docs: correct typos in BOM 1.6/1.7 JSON Schema and XSD (CycloneDX#850)
Fixes two minor typos in released BOM 1.6/1.7 artifacts: - Replace "plan text" with "plain text" in content-type descriptions: - `schema/bom-1.6.schema.json` - `schema/bom-1.7.schema.json` - `schema/bom-1.6.xsd` - `schema/bom-1.7.xsd` - Fix typo in `refType` comment ("staring" -> "starting"): - `schema/bom-1.6.schema.json` - `schema/bom-1.7.schema.json` No validation semantics changed; copy/comment updates only. Fixes CycloneDX#849
2 parents cb0d734 + 0bd48c8 commit b20b074

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

schema/bom-1.6.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@
536536
"description": "Identifier for referable and therefore interlinkable elements.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
537537
"type": "string",
538538
"minLength": 1,
539-
"$comment": "TODO (breaking change): add a format constraint that prevents the value from staring with 'urn:cdx:'"
539+
"$comment": "TODO (breaking change): add a format constraint that prevents the value from starting with 'urn:cdx:'"
540540
},
541541
"refLinkType": {
542542
"description": "Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.",
@@ -1161,7 +1161,7 @@
11611161
"contentType": {
11621162
"type": "string",
11631163
"title": "Content-Type",
1164-
"description": "Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plan text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).",
1164+
"description": "Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plain text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).",
11651165
"default": "text/plain",
11661166
"examples": [
11671167
"text/plain",

schema/bom-1.6.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ limitations under the License.
973973
<xs:documentation>
974974
Specifies the format and nature of the data being attached, helping systems correctly
975975
interpret and process the content. Common content type examples include `application/json`
976-
for JSON data and `text/plain` for plan text documents.
976+
for JSON data and `text/plain` for plain text documents.
977977
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive
978978
list of registered content types, refer to the IANA media types registry at
979979
https://www.iana.org/assignments/media-types/media-types.xhtml.

schema/bom-1.7.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@
555555
"description": "Identifier for referable and therefore interlinkable elements.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
556556
"type": "string",
557557
"minLength": 1,
558-
"$comment": "TODO (breaking change): add a format constraint that prevents the value from staring with 'urn:cdx:'"
558+
"$comment": "TODO (breaking change): add a format constraint that prevents the value from starting with 'urn:cdx:'"
559559
},
560560
"refLinkType": {
561561
"title": "BOM Reference",
@@ -1248,7 +1248,7 @@
12481248
"contentType": {
12491249
"type": "string",
12501250
"title": "Content-Type",
1251-
"description": "Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plan text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).",
1251+
"description": "Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plain text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).",
12521252
"default": "text/plain",
12531253
"examples": [
12541254
"text/plain",

schema/bom-1.7.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1204,7 +1204,7 @@ limitations under the License.
12041204
<xs:documentation>
12051205
Specifies the format and nature of the data being attached, helping systems correctly
12061206
interpret and process the content. Common content type examples include `application/json`
1207-
for JSON data and `text/plain` for plan text documents.
1207+
for JSON data and `text/plain` for plain text documents.
12081208
RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive
12091209
list of registered content types, refer to the IANA media types registry at
12101210
https://www.iana.org/assignments/media-types/media-types.xhtml.

0 commit comments

Comments
 (0)