bug(docs): download of queries not providing all details

Checkmarx / kics

Find security vulnerabilities, compliance issues, and infrastructure misconfigurations early in the development cycle of your infrastructure-as-code with KICS by Checkmarx.

https://kics.io

Apache License 2.0

1.97k stars 295 forks source link

bug(docs): download of queries not providing all details #7150

Closed duncanmapes closed 2 days ago

duncanmapes commented 6 days ago

Found a bug? You're welcome to

Please make sure to:
- Describe in details what the problem is
- Attach a log file with relevant data preferably in DEBUG level (--log-level=DEBUG)
- Attach the scanned sample files, anonymize the data if the original file cannot be provided
- When attaching files to the issue make sure they are properly formatted

Expected Behavior

When I download "all queries" from https://docs.kics.io/latest/queries/all-queries/ I expect to get all the relevant data from the file.

Actual Behavior

I get a column (More Info) of text that says "Query details Documentation". On the website those are both links, Ideally those links would be provided in the download.

Steps to Reproduce the Problem

Go to https://docs.kics.io/latest/queries/all-queries/
Click download
inspect CSV that is downloaded

Specifications

N/A

JulioSCX commented 3 days ago

Hello @duncanmapes,

Thank you for bringing this issue to our attention! We appreciate your feedback and the time you took to report it.

We're currently working on a fix and it should be up soon. We’ll keep you updated on the progress and let you know as soon as it’s resolved.

Thanks again for your support and patience!

JulioSCX commented 2 days ago

Hi @duncanmapes,

The issue you reported has been resolved and merged into the master branch.

Thanks for bringing it to our attention!

If you encounter any more issues or have questions, please let us know!

duncanmapes commented 2 days ago

Hey @JulioSCX thanks for that! When can we expect to see it deployed into the docs site?

JulioSCX commented 2 days ago

Hey @duncanmapes ,

While I can't give you an exact date right now, we're anticipating a new release in the coming weeks. In the meantime, you can access the updated version by visiting the "development" version of our documentation.

Let me know if there's anything else you need!

duncanmapes commented 2 days ago

Ah..of course, thanks.

duncanmapes commented 2 days ago

@JulioSCX at the risk of being annoying...

It would be great if there was a way to grab that programmatically, the CSV or JSON were available at an endpoint, that would be ideal