Add human-friendly name field for security scan profile configuration variables
Why
In !251654 (merged), GitLab Duo flagged that gitlab_adv_sast_incr_scan is an opaque abbreviation compared to other fields on SastConfigurationInputType (e.g. secure_analyzers_prefix, excluded_analyzers, analyzer_image_tag). The follow-up discussion (thread) raised the broader question of whether scan profile configuration variables should be exposed with their raw machine name or a human-readable label.
The agreed direction (see comment) is to keep the machine name in the API/schema, but also show a friendly label in the UI alongside it (for example "Paths to exclude" next to DS_EXCLUDED_PATHS), so the interface stays approachable while the underlying variable name stays discoverable in search/docs.
What
Add a user-friendly name field for scan profile configuration variables, so the frontend can display it next to (not instead of) the existing machine name.
Open questions
- Will the friendly name be required for every variable, or optional with a fallback to the machine name?
- Should label, description, and variable name come from a single backend definition that both the API and frontend consume, rather than being duplicated? (raised here)
Related
- !251654 (merged) (where this was raised)
- #617070 (closed) (SAST configuration values and mapping)