Skip to content

Commit 10084d7

Browse files
svenvandescheursvenvandescheur
committed
🚑 #495 - fix: use POST body for selection items API call to prevent excessive URL length
1 parent b1f0507 commit 10084d7

File tree

5 files changed

+17
-18
lines changed

5 files changed

+17
-18
lines changed

‎backend/src/openarchiefbeheer/selection/api/drf_spectacular/hooks.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ def update_schema_for_dynamic_keys(
1717
openapi_response_schema = force_instance(SCHEMA_RESPONSE)
1818

1919
# TODO: Try if a OpenApiSerializerExtension can be used to do this?
20-
result["paths"]["/api/v1/selections/{key}/"]["get"]["responses"]["200"]["content"][
20+
result["paths"]["/api/v1/selections/{key}/"]["post"]["responses"]["200"]["content"][
2121
"application/json"
2222
]["schema"] = openapi_response_schema.response
23-
result["paths"]["/api/v1/selections/{key}/"]["get"]["responses"]["200"]["content"][
23+
result["paths"]["/api/v1/selections/{key}/"]["post"]["responses"]["200"]["content"][
2424
"application/json"
2525
]["examples"] = build_examples_list(openapi_response_schema.examples)
2626

‎backend/src/openarchiefbeheer/selection/api/views.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def _get_selection_representation(self, queryset=None):
5151
# DRF spectacular post processing hooks.
5252
responses={200: SelectionItemDataReadSerializer(many=True)},
5353
)
54-
def get(self, request, *args, **kwargs):
54+
def post(self, request, *args, **kwargs):
5555
queryset = self.filter_queryset(self.get_queryset())
5656

5757
return Response(self._get_selection_representation(queryset))

‎backend/src/openarchiefbeheer/selection/tests/test_endpoints.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def test_get_zaak_selection(self):
4141

4242
self.client.force_login(self.user)
4343

44-
response = self.client.get(reverse("api:selections", args=[key]))
44+
response = self.client.post(reverse("api:selections", args=[key]))
4545

4646
self.assertEqual(response.status_code, status.HTTP_200_OK)
4747

@@ -231,7 +231,7 @@ def test_get_filtered_zaak_selection(self):
231231
endpoint.args["annotated"] = True
232232
endpoint.args["test"] = "tralala"
233233

234-
response = self.client.get(endpoint.url)
234+
response = self.client.post(endpoint.url)
235235

236236
self.assertEqual(response.status_code, status.HTTP_200_OK)
237237

@@ -264,7 +264,7 @@ def test_get_selection_item(self):
264264
self.client.force_login(self.user)
265265
endpoint = furl(reverse("api:selections", args=[key]))
266266
endpoint.args["items"] = "http://zaken.nl/api/v1/zaken/111-111-111"
267-
response = self.client.get(endpoint.url)
267+
response = self.client.post(endpoint.url)
268268

269269
self.assertEqual(response.status_code, status.HTTP_200_OK)
270270

@@ -304,7 +304,7 @@ def test_filter_items(self):
304304
endpoint.args["items"] = (
305305
"http://zaken.nl/api/v1/zaken/111-111-111,http://zaken.nl/api/v1/zaken/222-222-222"
306306
)
307-
response = self.client.get(endpoint.url)
307+
response = self.client.post(endpoint.url)
308308

309309
self.assertEqual(response.status_code, status.HTTP_200_OK)
310310

@@ -478,7 +478,7 @@ def test_urls_not_camelised(self):
478478

479479
self.client.force_login(self.user)
480480

481-
response = self.client.get(reverse("api:selections", args=[key]))
481+
response = self.client.post(reverse("api:selections", args=[key]))
482482

483483
self.assertEqual(response.status_code, status.HTTP_200_OK)
484484

‎frontend/src/lib/api/zaakSelection.ts

+4-5
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,14 @@ export async function getSelectionItems<DetailType = unknown>(
3535
selectedOnly = true,
3636
signal?: AbortSignal,
3737
) {
38-
const zaakUrls = zaken.map((zaak) => _getZaakUrl(zaak));
39-
const params = new URLSearchParams({ items: zaakUrls.join(",") });
38+
const items = zaken.map((zaak) => _getZaakUrl(zaak));
39+
const params = new URLSearchParams();
4040
selectedOnly && params.set("selected", "true");
41-
4241
const response = await request(
43-
"GET",
42+
"POST",
4443
`/selections/${key}/`,
4544
params,
46-
undefined,
45+
{ items },
4746
undefined,
4847
signal,
4948
);

‎frontend/src/pages/destructionlist/review/DestructionListReview.stories.tsx

+5-5
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,19 @@ const meta: Meta<typeof DestructionListReviewPage> = {
8080
},
8181
{
8282
url: "http://localhost:8000/api/v1/selections/destruction-list-review-00000000-0000-0000-0000-000000000000-changes_requested/?items=http%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F87691e74-1b0b-491a-aa63-0a396bbb1e3e%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F3038cc8e-003b-411c-b6ef-7dc5ddc5a3ee%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F78b6dd10-261b-4a40-99e2-1eea3e38bc99%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F64bec25d-5752-48a9-b2f9-6c27085a469f%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F409a291a-9cf0-4c40-9f31-25e9452a8e79%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F1188687c-392b-439e-9d5f-4d17bac822bf%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F5d816422-7f1c-42b4-9a4c-715d2e07aca3%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F2e803c71-49c4-4dc0-bfd1-42f2a3da99f9%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2Fbd6cdd85-d578-47fa-9ddb-846354088a47%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F2ca5f28c-397b-4cc6-ac76-4ef6cab19f59",
83-
method: "GET",
83+
method: "POST",
8484
status: 200,
8585
response: {},
8686
},
8787
{
88-
url: "http://localhost:8000/api/v1/selections/storybook-storage-key/?items=http%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F87691e74-1b0b-491a-aa63-0a396bbb1e3e%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F3038cc8e-003b-411c-b6ef-7dc5ddc5a3ee%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F78b6dd10-261b-4a40-99e2-1eea3e38bc99%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F64bec25d-5752-48a9-b2f9-6c27085a469f%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F409a291a-9cf0-4c40-9f31-25e9452a8e79%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F1188687c-392b-439e-9d5f-4d17bac822bf%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F5d816422-7f1c-42b4-9a4c-715d2e07aca3%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F2e803c71-49c4-4dc0-bfd1-42f2a3da99f9%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2Fbd6cdd85-d578-47fa-9ddb-846354088a47%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F2ca5f28c-397b-4cc6-ac76-4ef6cab19f59",
89-
method: "GET",
88+
url: "http://localhost:8000/api/v1/selections/storybook-storage-key/",
89+
method: "POST",
9090
status: 200,
9191
response: {},
9292
},
9393
{
94-
url: "http://localhost:8000/api/v1/selections/storybook-storage-key/?items=http%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F87691e74-1b0b-491a-aa63-0a396bbb1e3e%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F3038cc8e-003b-411c-b6ef-7dc5ddc5a3ee%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F78b6dd10-261b-4a40-99e2-1eea3e38bc99%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F64bec25d-5752-48a9-b2f9-6c27085a469f%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F409a291a-9cf0-4c40-9f31-25e9452a8e79%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F1188687c-392b-439e-9d5f-4d17bac822bf%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F5d816422-7f1c-42b4-9a4c-715d2e07aca3%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F2e803c71-49c4-4dc0-bfd1-42f2a3da99f9%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2Fbd6cdd85-d578-47fa-9ddb-846354088a47%2Chttp%3A%2F%2Flocalhost%3A8000%2Fzaken%2Fapi%2Fv1%2Fzaken%2F2ca5f28c-397b-4cc6-ac76-4ef6cab19f59&selected=true",
95-
method: "GET",
94+
url: "http://localhost:8000/api/v1/selections/storybook-storage-key/",
95+
method: "POST",
9696
status: 200,
9797
response: {},
9898
},

0 commit comments

Comments
 (0)