flake8
passed.
JSHint
passed.
Update the API to allow undoing the pending deletion of file attachments.
Review Request #13251 — Created Aug. 31, 2023 and submitted
This updates the file attachments API update endpoints to allow undoing the
pending deletion of file attachments. We add apending_deletionquery
parameter that can only be set toFalseto do this.This also reduces the number of queries performed when deleting multiple
revisions of file attachments. Instead of removing revisions one by one,
we do a batch remove which reduces this to just one query instead of
one query per revision.
- Ran unit tests.
- Used in an upcoming change.
| Summary | ID |
|---|---|
| c6879af7e21ebb928e20e101fc5faf478daa99d6 |
| Description | From | Last Updated |
|---|---|---|
|
"false" for the API. (We normalize case, but document lowercase.) |
 chipx86
|
|
|
In the case of the API, "parameter" isn't the right word. Instead, we can say something like "Set pending_deletion=false in … |
chipx86
|
|
|
I keep reading this final sentence incorrectly, and realized I was missing how this connected. Maybe we can reword it … |
chipx86
|
|
|
This should have a trailing comma. |
 david
|
|
|
This should have a trailing comma. |
david
|
|
|
When wrapping a multi-line string in parens, leave the ) aligned with the line containing the (, so that it's … |
chipx86
|
|
|
This should have a trailing comma. |
david
|
|
|
This should have a trailing comma. |
david
|
|
|
Missing a type. |
chipx86
|
|
|
Since we just need the IDs, you can do: all_revs = list( FileAttachment.objects .filter(...) .values_list('pk', flat=True) ) (The list() resolves … |
chipx86
|
|
|
.save() isn't needed to update M2M relations, like file_attachments, so let's avoid this if we're not otherwise modifying state on … |
chipx86
|
|
|
Missing a type. |
chipx86
|
|
|
Same notes as above. |
chipx86
|
|
|
Going forward (starting with recent API error work), I want to start comparing the entirety of rsp for errors, so … |
chipx86
|
-
-
-
In the case of the API, "parameter" isn't the right word. Instead, we can say something like "Set
pending_deletion=falsein the request to ..." -
I keep reading this final sentence incorrectly, and realized I was missing how this connected. Maybe we can reword it to:
Setting this to ``true`` is unsupported and will not delete the file attachment. To perform a deletion, perform a HTTP DELETE on the resource instead. -
When wrapping a multi-line string in parens, leave the
)aligned with the line containing the(, so that it's easier to add additional text/lines (same sort of rule as ensuring list items have a,at the end). -
-
Since we just need the IDs, you can do:
all_revs = list( FileAttachment.objects .filter(...) .values_list('pk', flat=True) )(The
list()resolves this, converting from aValuesQuerySetto a list of IDs.) -
.save()isn't needed to update M2M relations, likefile_attachments, so let's avoid this if we're not otherwise modifying state on the object. -
-
-
Going forward (starting with recent API error work), I want to start comparing the entirety of
rspfor errors, so we can be thorough. It also eases readability a bit. Let's update that here.
- Commits:
-
Summary ID 65d6a7d1f3c832ae446d19855a4d171e90e6c59c 178112957297f2a521382a36b90476515436effb
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.