Allow soft-deleted entity list to be retrieved #1734
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of getodk/central#1337
This PR adds a new endpoint:
GET projects/:id/datasets/deleted/:datasetId/entities.csvWhich returns csv of data, e.g. "people-deleted.csv"
Once datasets are deleted, their names can be reused, so the way to unambiguously reference an old dataset is by numeric ID. This is similar to restoring deleted forms.
What has been done to verify that this works as intended?
Tests.
Why is this the best possible solution? Were any other approaches considered?
@sadiqkhoja and I talked about using dataset ID vs. actee for referencing deleted dataset. We are using the ID for now but could switch to actee ID if that made sense in the future.
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
Lets users download a snapshot of their deleted entity list from the trash before it is purged.
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
Yes, this needs API documentation.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes