kics
kics copied to clipboard
Capacity to override the metadatas of a query
Is your feature request related to a problem? Please describe.
As a final user of KICS, I would like to override the metadata.json
file of a query :
- to set my own documentation in
descriptionUrl
- to set my own severity level on a query
Describe the solution you'd like
I would like the possibility to add in my queries a new query with a single metadata.json
file referring to an existing query ID.
Describe alternatives you've considered
- ignore the existing query
- copy /past this one in my own query directory
- change the query ID
The more I use KICS, the more I think it's a really important feature.
How do you suggest finding those "custom metadata" files? Through a new flag or a path defined by KICS?
The same way to stock custom queries.
I think the way KICS do with custom queries would be a little strange… What I thought was something more like input data, since, if I understood correctly, just want to overwrite metadata information… What do you think?
IMHO, that's not the same thing. The input data is to contextualize a query to business inputs.
On my hand, I want to override existing metadata like :
- the
descriptionUrl
of an existing query to put my own documentation with something to help developers - the
severity
of a query : sometime, a specific query must be HIGH in a business context when this one is currently LOW
I understand your point, but I think I expressed my point wrongly. What I suggested was to follow something like input data overwrite system, like create a custom-metadata
folder or update how this behaves to create a folder with query ID and overwrite files that are in there, which I prefer.
I'm pointing this, because the way you proposed is not how KICS handles custom queries, but input data overwrite system looks really close to what you want to achieve on overwriting default metadata...
I will try to create a proposal of what I'm trying to explain here, and you could check it, WDYT?
Alright. Understood ! 😄 It sounds good to me !
Similar issue https://github.com/Checkmarx/kics/issues/5960