adviser icon indicating copy to clipboard operation
adviser copied to clipboard

[EPIC] Keep metadata in justifications and stack info results

Open fridex opened this issue 3 years ago • 8 comments

Is your feature request related to a problem? Please describe.

As a user of Thoth, I would like to have machine-readable access to the results of the recommendation engine. To support this, I would like to access results and read metadata in each justification and stack info entry. An example can be a justification entry provided by the unit responsible for providing CVE information - it can state how fresh the data are. Then, each user of Thoth would have access to this information and would be able to read this information.

Describe the solution you'd like

Add additional metadata to justification and stack info results of the recommendation engine results.

Acceptance criteria

  • [ ] make sure there is defined a set of tags/categories stating how additional metadata should look like
    • [ ] #2328
    • [ ] identify possible additional tags/categories that could be used in metadata (such as when the given prescription was created)
    • [ ] identify key parts of the system to integrate tags/categories
  • [ ] make sure prescriptions-refresh-job creates prescriptions with additional tags/categories in metadata
  • [ ] make sure adviser provides tags/categories in metadata
  • [ ] make sure Thoth Search UI consumes additional metadata in justifications as provided by the backend
  • [ ] experiment with possible integration in thamos

fridex avatar Nov 22 '21 17:11 fridex

/priority important-soon /triage accepted

goern avatar Jan 14 '22 12:01 goern

/sig stack-guidance

codificat avatar Apr 04 '22 13:04 codificat

/lifecycle active

mayaCostantini avatar Apr 21 '22 11:04 mayaCostantini

/assign @mayaCostantini

codificat avatar Apr 25 '22 12:04 codificat

Was looking at openssf Big Query database and noticed that scorecard-v2 gives extra details like specific scores for each check. Can the scorecard justification include this data?

scorecard-v2 schema image

More data the better, but priority would be reason (already included), score, name, details, short

Gkrumbach07 avatar May 09 '22 12:05 Gkrumbach07

Are these scores also present for the most recent version of the Scorecards database (v3) that we would like to use? I am not sure if the new schema includes them, but it is worth checking as this would provide useful information.

mayaCostantini avatar May 09 '22 12:05 mayaCostantini

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

sesheta avatar Aug 07 '22 13:08 sesheta

/remove-lifecycle stale /lifecycle active

mayaCostantini avatar Aug 07 '22 13:08 mayaCostantini