fix(proto): remove stale CPE deprecation comment (1.4-1.7) - #1116
Open
yusuke-koyoshi wants to merge 1 commit into
Open
yusuke-koyoshi wants to merge 1 commit into
yusuke-koyoshi wants to merge 1 commit into
Conversation
The deprecation of `component.cpe` was withdrawn in CycloneDX#105 / 7b2c23a (2021-12-20), but that commit only touched `bom-1.4-SNAPSHOT.schema.json` and `bom-1.4-SNAPSHOT.xsd`. The ProtoBuf schemas were missed, so 1.4 through 1.7 still document `cpe` as "DEPRECATED - DO NOT USE", while the JSON Schema and XSD of the same versions do not. Align the ProtoBuf comment with the wording of the respective XSD. `bom-1.3.proto` is left untouched, since CPE is genuinely deprecated in 1.3. Comment-only change; the wire format is unaffected. Signed-off-by: yusuke.koyoshi <yusuke.koyoshi@assured.inc>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #105.
The deprecation of
component.cpewas withdrawn in #105 (commit 7b2c23a, 2021-12-20), but that commit only touchedschema/bom-1.4-SNAPSHOT.schema.jsonandschema/bom-1.4-SNAPSHOT.xsd. The ProtoBuf schemas were missed, so every version from 1.4 to 1.7 still documentscpeasDEPRECATED - DO NOT USE, while the JSON Schema and XSD of the same version do not:.proto.schema.json/.xsdDEPRECATED - DO NOT USE. This will be removed in a future version. …DEPRECATED - DO NOT USE. …DEPRECATED - DO NOT USE. …DEPRECATED - DO NOT USE. …This PR aligns the ProtoBuf comment with the wording used in the respective XSD:
Deliberately not changed:
schema/bom-1.3.proto— CPE is genuinely deprecated in 1.3, and the JSON Schema and XSD of 1.3 say so as well.Component.modified— still deprecated in all three formats.This is a comment-only change; the wire format is unaffected — there was never a
[deprecated = true]option on the field, only the comment. #786 is a precedent for correcting comments in already-released ProtoBuf schemas.tools/src/test/proto/test.shwas run locally:schema-lint,schema-breaking-versionandschema-breaking-remoteall pass.