Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HJ-32 Add endpoint to get privacy request access results urls #5379

Merged
merged 4 commits into from
Oct 16, 2024
Merged

Conversation

erosselli
Copy link
Contributor

@erosselli erosselli commented Oct 15, 2024

Closes HJ-32

Description Of Changes

Adds a new endpoint that allows getting a privacy request's access results URLs.

Code Changes

  • Created the new endpoint GET /privacy-request/<privacy_request_id>/access-results
  • Added new scope PRIVACY_REQUEST_GET_ACCESS_RESULTS, only for owner and contributor roles
  • Added unit tests for the new endpoint

Steps to Confirm

  • Run fides (nox -s dev) as well as both the Admin UI and the Privacy Center
  • Through the privacy center, create an access request. You should see it as Complete in the Admin UI
  • Configure S3 storage for privacy requests, either through the api or by going to http://localhost:3000/privacy-requests/configure/storage (credentials in 1pass)
  • Create another access request from the privacy center.
  • Go to the swagger API and call /api/v1/privacy-request/{privacy_request_id}/access-results:
    • Pass in the id of the first privacy request and execute => you should see the response "access_result_urls": ["your local fides_uploads folder"]
    • Pass in the id of the second privacy request and execute => you should see the response with the bucket URL. Opening the URL in another tab should download an empty JSON file

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation:
    • documentation complete, PR opened in fidesdocs
    • documentation issue created in fidesdocs
    • if there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
  • Issue Requirements are Met
  • Relevant Follow-Up Issues Created
  • Update CHANGELOG.md
  • For API changes, the Postman collection has been updated
  • If there are any database migrations:
    • Ensure that your downrev is up to date with the latest revision on main
    • Ensure that your downgrade() migration is correct and works
      • If a downgrade migration is not possible for this change, please call this out in the PR description!

Copy link

vercel bot commented Oct 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
fides-plus-nightly ⬜️ Ignored (Inspect) Visit Preview Oct 16, 2024 1:02pm

@erosselli erosselli changed the title HJ-32 Add endpoint to download privacy request access results HJ-32 Add endpoint to get privacy request access results urls Oct 15, 2024
Copy link

cypress bot commented Oct 15, 2024

fides    Run #10462

Run Properties:  status check passed Passed #10462  •  git commit 50c6891dc1 ℹ️: Merge 04d7371ffa2af167c82302351812f9f4171f0f40 into e55d71f66ed37d3980ff370ca908...
Project fides
Run status status check passed Passed #10462
Run duration 00m 36s
Commit git commit 50c6891dc1 ℹ️: Merge 04d7371ffa2af167c82302351812f9f4171f0f40 into e55d71f66ed37d3980ff370ca908...
Committer erosselli
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.

@erosselli erosselli marked this pull request as ready for review October 15, 2024 13:46
@erosselli erosselli merged commit 46cc415 into main Oct 16, 2024
37 checks passed
@erosselli erosselli deleted the HJ-32 branch October 16, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants