Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more description to hasDataFile relationship type #815

Merged
merged 9 commits into from
Aug 6, 2024
Merged
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions model/Core/Vocabularies/RelationshipType.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Information about the relationship between two Elements.

Provides information about the relationship between two Elements.
For example, you can represent a relationship between two different Files,
between a Package and a File, between two Packages, or between one SPDXDocument and another SPDXDocument.
between a Package and a File, between two Packages, or between one SPDXDocument
and another SPDXDocument.

Relationship names be descriptive enough to easily deduce the correct direction
from their name. The best way to do this is to make sure that the relationship
Expand Down Expand Up @@ -43,11 +44,11 @@ name completes the sentence:
- fixedIn: (Security/VEX) A `from` Vulnerability has been fixed in each of the `to` Element(s). The use of the `fixedIn` type is contrained to `VexFixedVulnAssessmentRelationship` classed relationships.
- foundBy: (Security) Designates a `from` Vulnerability was originally discovered by the `to` Agent(s)
- generates: The `from` Element generates each `to` Element
- hasAddedFile: Every `to` Element is is a file added to the `from` Element (`from` hasAddedFile `to`)
- hasAddedFile: Every `to` Element is a file added to the `from` Element (`from` hasAddedFile `to`)
- hasAssessmentFor: (Security) Relates a `from` Vulnerability and each `to` Element(s) with a security assessment. To be used with `VulnAssessmentRelationship` types
- hasAssociatedVulnerability: (Security) Used to associate a `from` Artifact with each `to` Vulnerability
- hasConcludedLicense: The `from` Software Artifact is concluded by the SPDX data creator to be governed by each `to` license
- hasDataFile: The `from` Element treats each `to` Element as a data file
- hasDataFile: The `from` Element treats each `to` Element as a data file. A data file is an artifact that stores data required or optional for the `from` Element's functionality. A data file can be a database file, an index file, a log file, an AI model file, a calibration data file, a temporary file, a backup file, and more. For AI training dataset, test dataset, test artifact, configuration data, build input data, and build output data, please consider using the more specific relationship types: `trainedOn`, `testedOn`, `hasTest`, `configures`, `hasInputs`, and `hasOutputs`, respectively. This relationship does not imply dependency.
- hasDeclaredLicense: The `from` Software Artifact was discovered to actually contain each `to` license, for example as detected by use of automated tooling.
- hasDeletedFile: Every `to` Element is a file deleted from the `from` Element (`from` hasDeletedFile `to`)
- hasDependencyManifest: The `from` Element has manifest files that contain dependency information in each `to` Element
Expand Down