Skip to content

Commit 6e5a163

Browse files
committed
Update documentation for changed discovery date default behaviour
Signed-off-by: Jonas Brand (8R0WNI3) <[email protected]>
1 parent 8e367c6 commit 6e5a163

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/model.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -236,10 +236,12 @@ Findings (deviations from rulesets) typically have to be processed within an
236236
allowed timeframe. Hence, the date of first discovery is stored to allow for
237237
the calculation for latest due-dates. Thereby, the initial `discovery_date`
238238
must be retained during subsequent updates. Therefore, the `discovery_date` is
239-
part of the `ArtefactMetadata` model. To re-use the initial `discovery_date` of
240-
a finding, and don't reset it as part of every new scan, it must be defined
241-
when a finding is to be interpreted as equal so that the `discovery_date` must
242-
be re-used.
239+
part of the `ArtefactMetadata` model. By default, the initial `discovery_date`
240+
of a finding is re-used in case the OCM identity (except its version and extra
241+
identity) and the `key` property of the finding match. In case it is desired to
242+
deviate from this defalt behaviour (e.g. in case the `key` contains a package
243+
version which should not be considered for the re-use), a custom check must be
244+
implemented as part of the upload metadata route.
243245

244246
Considerations
245247
^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)