docs(schema): clarify purls must not contain versions #317
Conversation
This file contains 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
This clarifies the intent of the optional `purl` field to refer to the package in an analogous way to the `ecosystem` and `name` and not contain any explicit `version` component. Signed-off-by: Andrew Pollock <apollock@google.com>
oliverchang
reviewed
Dec 9, 2024
| @@ -668,7 +668,8 @@ within its ecosystem. The two fields must both be present, because the | |||
| The `purl` field is a string following the | |||
| [Package URL specification](https://github.com/package-url/purl-spec) that | |||
| identifies the package, without the `@version` component. | |||
| This field is optional but recommended. | |||
| This field is optional but recommended. It *must not* contain a `version` | |||
There was a problem hiding this comment.
this is already made explicit on line 670?
There was a problem hiding this comment.
Huh. Couldn't see it for the trees at the time :-(
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This clarifies the intent of the optional
purlfield to refer to the package in an analogous way to theecosystemandnameand not contain any explicitversioncomponent.