Implement api_download_file() in views/findings.py

[Cyber-JiuJiteria]

    API download file method to be implemented. 

Need to define the output file types that will be provided (json, csv, pdf)

Originally posted by @Cyber-JiuJiteria in #55 (comment)

[Pranav25191]

Hi, I am new to open source, and I would like to take up this issue. Could please brief me about what exactly the issue is?

[Cyber-JiuJiteria]

Hello @Pranav25191

In the omega/triage-portal/src/triage/views/findings.py file, lines 203-205 have not been implemented. In this issue, we are looking for assisting in creating an API function for the triage-portal that will allow a user to download a file via the said api call.

The functionality will be slightly similar to the method below, api_get_blob_list() however the output should be human and machine consumable, such as CSV, JSON, or PDF. Design in a manner that additional formats can be supported in the future.

Ideally, i'd recommend CSV or JSON as the output of this specific API call. @scovetta thoughts on output?

We welcome contributions to the repo. Note that the changes are still under review in a Pull request (PR) #55 so the source code will not be available in main until the PR has been approved and merged.

Familiarity with python and django framework will be useful for this issue.

To start:
Create a fork of the repo and the associated PR branch, patch the changes in a newly created branch and submit a new pull request with the changes. Myself or @scovetta will review, provide feedback, and approve/merge after any issues have been completed.

Let me know if you have any questions. I will update the ticket with further details on acceptance criteria and expected outputs.

[scovetta]

I think this part is pretty core to the "how should we store/access files for the UI?" -- it's a lot more complicated than it seemed early on (surprise!). I'm going through comments on #55 today and tomorrow and hoping to my thoughts in order to give better guidance here -- so if you don't mind, come back to this thread in a few days and I'll have better suggestions.

[ShivamMenda]

@scovetta @Cyber-JiuJiteria I've learnt Django Recently and would like to try this issue out if it's still open? I wonder if the project is active? Was looking to apply for the mentorship program mentioned here -: https://mentorship.lfx.linuxfoundation.org/project/4df8fab8-e11a-4877-8140-c3633099ea24

[Cyber-JiuJiteria]

hello @ShivamMenda thanks for reaching out with interest.

The project is still active. We are a small team and have several repos we are working on. Below are some good examples on how to help.

Check out the PR #123 for the frontend for the Assertion Framework. Bring down this branch, build, run, and test it on your local. This PR 123 is still under review and we are looking for any feedback or enhancements for it.

If you'd like to work on an issue, check the issues page for any issues with 'good first issue,' and 'help wanted.' labels, such as #92 . We are available on the OpenSSF Slack via #alpha-omega if you have any questions.

[ShivamMenda]

@Cyber-JiuJiteria Thank you for replying I'll join the slack Channel and talk to you guys more there. I'll checkout the codebase and get familiar with it. I'll also apply for the mentorship program and start contributing.

[ShivamMenda]

@Cyber-JiuJiteria can you add me on the slack channel? My email is [email protected]
Can't join it through the link.

[Cyber-JiuJiteria]

@ShivamMenda Try going through the Slack link here https://www.openssf.org/getinvolved I do not have a way to share outside of the link on the website.

[ShivamMenda]

@Cyber-JiuJiteria Sure I'll try it out and let you know!

[ShivamMenda]

@Cyber-JiuJiteria I've joined the slack workspace and will be communicating over there too. Thank you.

[Cyber-JiuJiteria]

To be moved to Triage portal