refactor(api-gateway): rename to statusCode

Author: Michael Brewer

aws_lambda_powertools/event_handler/api_gateway.py

@@ -4,6 +4,7 @@
 import re
 import zlib
 from enum import Enum
+from http import HTTPStatus
 from typing import Any, Callable, Dict, List, Optional, Set, Union
 
 from aws_lambda_powertools.shared.json_encoder import Encoder
@@ -35,28 +36,28 @@ class BadRequestError(ServiceError):
     """Bad Request Error"""
 
     def __init__(self, msg: str):
-        super().__init__(400, msg)
+        super().__init__(HTTPStatus.BAD_REQUEST.value, msg)
 
 
 class UnauthorizedError(ServiceError):
     """Unauthorized Error"""
 
     def __init__(self, msg: str):
-        super().__init__(401, msg)
+        super().__init__(HTTPStatus.UNAUTHORIZED.value, msg)
 
 
 class NotFoundError(ServiceError):
     """Not Found Error"""
 
     def __init__(self, msg: str = "Not found"):
-        super().__init__(404, msg)
+        super().__init__(HTTPStatus.NOT_FOUND.value, msg)
 
 
 class InternalServerError(ServiceError):
     """Internal Server Error"""
 
     def __init__(self, message: str):
-        super().__init__(500, message)
+        super().__init__(HTTPStatus.INTERNAL_SERVER_ERROR.value, message)
 
 
 class ProxyEventType(Enum):
@@ -511,10 +512,10 @@ def _not_found(self, method: str) -> ResponseBuilder:
 
         return ResponseBuilder(
             Response(
-                status_code=404,
+                status_code=HTTPStatus.NOT_FOUND.value,
                 content_type=APPLICATION_JSON,
                 headers=headers,
-                body=self._json_dump({"code": 404, "message": "Not found"}),
+                body=self._json_dump({"statusCode": HTTPStatus.NOT_FOUND.value, "message": "Not found"}),
             )
         )
 
@@ -527,7 +528,7 @@ def _call_route(self, route: Route, args: Dict[str, str]) -> ResponseBuilder:
                 Response(
                     status_code=e.status_code,
                     content_type=APPLICATION_JSON,
-                    body=self._json_dump({"code": e.status_code, "message": e.msg}),
+                    body=self._json_dump({"statusCode": e.status_code, "message": e.msg}),
                 ),
                 route,
             )

tests/functional/event_handler/test_api_gateway.py

@@ -517,7 +517,7 @@ def bad_request_error():
     # AND status code equals 400
     assert result["statusCode"] == 400
     assert result["headers"]["Content-Type"] == APPLICATION_JSON
-    expected = {"code": 400, "message": "Missing required parameter"}
+    expected = {"statusCode": 400, "message": "Missing required parameter"}
     assert result["body"] == json_dump(expected)
 
     # GIVEN an UnauthorizedError
@@ -532,7 +532,7 @@ def unauthorized_error():
     # AND status code equals 401
     assert result["statusCode"] == 401
     assert result["headers"]["Content-Type"] == APPLICATION_JSON
-    expected = {"code": 401, "message": "Unauthorized"}
+    expected = {"statusCode": 401, "message": "Unauthorized"}
     assert result["body"] == json_dump(expected)
 
     # GIVEN an NotFoundError
@@ -547,7 +547,7 @@ def not_found_error():
     # AND status code equals 404
     assert result["statusCode"] == 404
     assert result["headers"]["Content-Type"] == APPLICATION_JSON
-    expected = {"code": 404, "message": "Not found"}
+    expected = {"statusCode": 404, "message": "Not found"}
     assert result["body"] == json_dump(expected)
 
     # GIVEN an InternalServerError
@@ -562,7 +562,7 @@ def internal_server_error():
     # AND status code equals 500
     assert result["statusCode"] == 500
     assert result["headers"]["Content-Type"] == APPLICATION_JSON
-    expected = {"code": 500, "message": "Internal server error"}
+    expected = {"statusCode": 500, "message": "Internal server error"}
     assert result["body"] == json_dump(expected)
 
     # GIVEN an ServiceError with a custom status code
@@ -578,5 +578,5 @@ def service_error():
     assert result["statusCode"] == 502
     assert result["headers"]["Content-Type"] == APPLICATION_JSON
     assert "Access-Control-Allow-Origin" in result["headers"]
-    expected = {"code": 502, "message": "Something went wrong!"}
+    expected = {"statusCode": 502, "message": "Something went wrong!"}
     assert result["body"] == json_dump(expected)