Skip to content

[FE] Generic Report Schema: Render 'named-list' type on vulnerability details page

Why are we doing this work

Allows scan results to add new labels and values to a vulnerability, where the label is any string they want and the value is one of the following types: named-list, list, table, url, int, text, diff, markdown (GFM), code, commit, file-location, and module-location.

This issue is specific to the named-list type

Designs

component design
named list Screen_Shot_2021-03-24_at_10.08.22_am

Sample Data

named list

"details": {
  "comments": {
    "name": "Comments",
    "type": "named-list",
    "items": {
      "comment_1": {
        "name": "Fred:",
        "type": "text",
        "value": "Hi Wilma"
      },
      "comment_2": {
        "name": "Wilma:",
        "type": "markdown",
        "value": "Hi Fred. Checkout [GitLab](http://gitlab.com)"
      },
      "resources": {
        "name": "resources",
        "type": "list",
        "items": [
          {
            "type": "value",
            "value": "42"
          }
        ]
      }
    }
  }
}

Relevant links

Information that the developer might need to refer to when implementing the issue.

Non-functional requirements

  • Documentation:
  • Feature flag:
  • Performance:
  • Testing:

Implementation plan

  • frontend Add named-list component that recursively renders the given items
    • Add specs
  • Add filtering to utils to make sure we only render supported types within named-lists
  • Add specs
  • Add grid styling to display the column layout for nested lists (Design TBD - see question below)
Edited by David Pisek