Fix status code in GET aliases service (#1881)

* Fix status code in GET aliases

Signed-off-by: Faakhir30 <[email protected]>

* Update news

Co-authored-by: Steve Piercy <[email protected]>

---------

Signed-off-by: Faakhir30 <[email protected]>
Co-authored-by: Steve Piercy <[email protected]>

Author: Faakhir30

news/1862.bugfix

@@ -0,0 +1 @@
+Correct the HTTP response status code to `200 OK` from `201 Create` for the `aliases` GET service. @Faakhir30

src/plone/restapi/services/aliases/get.py

@@ -26,7 +26,7 @@ def reply_item(self):
         context_path = "/".join(self.context.getPhysicalPath())
         redirects = storage.redirects(context_path)
         aliases = [deroot_path(alias) for alias in redirects]
-        self.request.response.setStatus(201)
+        self.request.response.setStatus(200)
         self.request.response.setHeader("Content-Type", "application/json")
         return [{"path": alias} for alias in aliases], len(aliases)
 
@@ -42,7 +42,7 @@ def reply_root(self):
         for redirect in redirects:
             del redirect["redirect"]
             redirect["datetime"] = datetimelike_to_iso(redirect["datetime"])
-        self.request.response.setStatus(201)
+        self.request.response.setStatus(200)
 
         self.request.form["b_start"] = "0"
         self.request.form["b_size"] = "1000000"
@@ -61,7 +61,7 @@ def reply_root_csv(self):
         for redirect in redirects:
             del redirect["redirect"]
             redirect["datetime"] = datetimelike_to_iso(redirect["datetime"])
-        self.request.response.setStatus(201)
+        self.request.response.setStatus(200)
 
         self.request.form["b_start"] = "0"
         self.request.form["b_size"] = "1000000"

src/plone/restapi/tests/http-examples/aliases_get.resp

@@ -1,4 +1,4 @@
-HTTP/1.1 201 Created
+HTTP/1.1 200 OK
 Content-Type: application/json
 
 {

src/plone/restapi/tests/http-examples/aliases_root_filter.resp

@@ -1,4 +1,4 @@
-HTTP/1.1 201 Created
+HTTP/1.1 200 OK
 Content-Type: application/json
 
 {

src/plone/restapi/tests/http-examples/aliases_root_get.resp

@@ -1,4 +1,4 @@
-HTTP/1.1 201 Created
+HTTP/1.1 200 OK
 Content-Type: application/json
 
 {

src/plone/restapi/tests/http-examples/aliases_root_get_csv_format.resp

@@ -1,4 +1,4 @@
-HTTP/1.1 201 Created
+HTTP/1.1 200 OK
 Content-Type: text/csv; charset=utf-8
 
 old path,new path,datetime,manual

src/plone/restapi/tests/test_services_aliases.py

@@ -44,7 +44,7 @@ def test_alias_non_root(self):
 
         # Verify alias exists
         response = self.api_session.get("/front-page/@aliases")
-        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.status_code, 200)
         self.assertEqual(len(response.json()["items"]), 1)
 
     def test_alias_add_invalid_datetime(self):
@@ -66,7 +66,7 @@ def test_alias_add_invalid_datetime(self):
         response = self.api_session.post("/@aliases", json=data)
         self.assertEqual(response.status_code, 204)
         response = self.api_session.get("/@aliases")
-        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.status_code, 200)
         self.assertEqual(len(response.json()["items"]), 2)
 
     def test_alias_add_invalid_path(self):
@@ -76,7 +76,7 @@ def test_alias_add_invalid_path(self):
         response = self.api_session.post("/@aliases", json=data)
         self.assertEqual(response.status_code, 400)
         response = self.api_session.get("/@aliases")
-        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.status_code, 200)
         self.assertEqual(len(response.json()["items"]), 0)
 
     def test_duplicate_alias(self):
@@ -108,7 +108,7 @@ def test_alias_csv_upload(self):
         self.assertEqual(response.status_code, 204)
         self.assertEqual(response.content, b"")
         response = self.api_session.get("/@aliases")
-        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.status_code, 200)
         self.assertEqual(
             response.json().get("items"),
             [
@@ -136,7 +136,7 @@ def test_alias_csv_download(self):
         self.api_session.post("/@aliases", json=data)
         headers = {"Accept": "text/csv"}
         response = self.api_session.get("/@aliases", headers=headers)
-        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.status_code, 200)
         self.assertIn("Content-Disposition", response.headers)
         self.assertEqual(response.headers["Content-Type"], "text/csv; charset=utf-8")
         content = b"old path,new path,datetime,manual\r\n/alias-page,/front-page,2022/01/01 00:00:00 GMT+0,True\r\n"
@@ -158,5 +158,5 @@ def test_alias_delete(self):
         self.assertEqual(response.status_code, 204)
 
         response = self.api_session.get("/@aliases")
-        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.status_code, 200)
         self.assertEqual(len(response.json()["items"]), 0)