removes unnecessary response data from PUT/DELETE

Author: GabrielBarberini

README.md

@@ -102,21 +102,21 @@ sequenceDiagram
     User ->> API: POST /model    
     API ->> MongoDB: Persist API Model as a document
     MongoDB -->> API: Model ID
-    API -->> User: ModelCreated View
+    API -->> User: 201 ModelCreated View
 
     User ->> API: GET /model/:id
     API ->> MongoDB: Read API Model document
     MongoDB -->> API: API Model document
-    API -->> User: API ModelView
+    API -->> User: 200 API ModelView
 
     User ->> API: PUT /model/:id
     API ->> MongoDB: Update API Model document
-    API -->> User: ModelUpdated View
+    API -->> User: 204
 
     User ->> API: DELETE /model/:id
     API ->> MongoDB: Delete API Model document
     MongoDB -->> API: Deletion Confirmation
-    API -->> User: ModelDeleted View
+    API -->> User: 204
 
 ```
 
@@ -126,19 +126,19 @@ sequenceDiagram
     participant User
     participant API
     participant MongoDB
-    participant Rocketpy lib
+    participant RocketPy lib
 
-    User ->> API: GET /summary/model/:id
-    API -->> MongoDB: Retrieve Rocketpy native class
-    MongoDB -->> API: Rocketpy native class
-    API ->> Rocketpy lib: Simulate Rocketpy native class
-    Rocketpy lib -->> API:  Simulation Results
+    User ->> API: GET model/:id/simulate/
+    API -->> MongoDB: Retrieve API Model document
+    MongoDB -->> API: API Model document 
+    API ->> RocketPy: Initialize RocketPy native class and simulate
+    RocketPy lib -->> API: Simulation Results
     API -->> User: Simulation Results
 
     User ->> API: GET /model/:id/rocketpy
-    API -->> MongoDB: Retrieve Rocketpy Model
-    MongoDB -->> API: Rocketpy Model
-    API ->> Rocketpy lib: Rocketpy Model
-    Rocketpy lib -->> API:  Rocketpy native class
-    API -->> User: Rocketpy native class as .dill binary
+    API -->> MongoDB: Retrieve API Model document
+    MongoDB -->> API: API Model document 
+    API ->> RocketPy: Initialize RocketPy native class
+    RocketPy lib -->> API: RocketPy native class
+    API -->> User: RocketPy native class as .dill binary (amd64)
 ```

lib/controllers/flight.py

@@ -2,7 +2,7 @@
     ControllerInterface,
     controller_exception_handler,
 )
-from lib.views.flight import FlightSimulation, FlightUpdated
+from lib.views.flight import FlightSimulation
 from lib.models.flight import FlightModel
 from lib.models.environment import EnvironmentModel
 from lib.models.rocket import RocketModel
@@ -24,7 +24,7 @@ def __init__(self):
     @controller_exception_handler
     async def update_environment_by_flight_id(
         self, flight_id: str, *, environment: EnvironmentModel
-    ) -> FlightUpdated:
+    ) -> None:
         """
         Update a models.Flight.environment in the database.
 
@@ -33,20 +33,20 @@ async def update_environment_by_flight_id(
             environment: models.Environment
 
         Returns:
-            views.FlightUpdated
+            None
 
         Raises:
             HTTP 404 Not Found: If the flight is not found in the database.
         """
         flight = await self.get_flight_by_id(flight_id)
         flight.environment = environment
         self.update_flight_by_id(flight_id, flight)
-        return FlightUpdated(flight_id=flight_id)
+        return
 
     @controller_exception_handler
     async def update_rocket_by_flight_id(
         self, flight_id: str, *, rocket: RocketModel
-    ) -> FlightUpdated:
+    ) -> None:
         """
         Update a models.Flight.rocket in the database.
 
@@ -55,15 +55,15 @@ async def update_rocket_by_flight_id(
             rocket: models.Rocket
 
         Returns:
-            views.FlightUpdated
+            None
 
         Raises:
             HTTP 404 Not Found: If the flight is not found in the database.
         """
         flight = await self.get_flight_by_id(flight_id)
         flight.rocket = rocket
         self.update_flight_by_id(flight_id, flight)
-        return FlightUpdated(flight_id=flight_id)
+        return
 
     @controller_exception_handler
     async def get_rocketpy_flight_binary(

lib/models/environment.py

@@ -26,15 +26,11 @@ class EnvironmentModel(ApiBaseModel):
 
     @staticmethod
     def UPDATED():
-        from lib.views.environment import EnvironmentUpdated
-
-        return EnvironmentUpdated()
+        return
 
     @staticmethod
     def DELETED():
-        from lib.views.environment import EnvironmentDeleted
-
-        return EnvironmentDeleted()
+        return
 
     @staticmethod
     def CREATED(model_id: str):

lib/models/flight.py

@@ -46,15 +46,11 @@ def get_additional_parameters(self):
 
     @staticmethod
     def UPDATED():
-        from lib.views.flight import FlightUpdated
-
-        return FlightUpdated()
+        return
 
     @staticmethod
     def DELETED():
-        from lib.views.flight import FlightDeleted
-
-        return FlightDeleted()
+        return
 
     @staticmethod
     def CREATED(model_id: str):

lib/models/motor.py

@@ -82,15 +82,11 @@ def set_motor_kind(self, motor_kind: MotorKinds):
 
     @staticmethod
     def UPDATED():
-        from lib.views.motor import MotorUpdated
-
-        return MotorUpdated()
+        return
 
     @staticmethod
     def DELETED():
-        from lib.views.motor import MotorDeleted
-
-        return MotorDeleted()
+        return
 
     @staticmethod
     def CREATED(model_id: str):

lib/models/rocket.py

@@ -39,15 +39,11 @@ class RocketModel(ApiBaseModel):
 
     @staticmethod
     def UPDATED():
-        from lib.views.rocket import RocketUpdated
-
-        return RocketUpdated()
+        return
 
     @staticmethod
     def DELETED():
-        from lib.views.rocket import RocketDeleted
-
-        return RocketDeleted()
+        return
 
     @staticmethod
     def CREATED(model_id: str):

lib/routes/environment.py

@@ -9,8 +9,6 @@
     EnvironmentSimulation,
     EnvironmentCreated,
     EnvironmentRetrieved,
-    EnvironmentUpdated,
-    EnvironmentDeleted,
 )
 from lib.models.environment import EnvironmentModel
 from lib.controllers.environment import EnvironmentController
@@ -28,7 +26,7 @@
 tracer = trace.get_tracer(__name__)
 
 
-@router.post("/")
+@router.post("/", status_code=201)
 async def create_environment(
     environment: EnvironmentModel,
 ) -> EnvironmentCreated:
@@ -56,10 +54,10 @@ async def read_environment(environment_id: str) -> EnvironmentRetrieved:
         return await controller.get_environment_by_id(environment_id)
 
 
-@router.put("/{environment_id}")
+@router.put("/{environment_id}", status_code=204)
 async def update_environment(
     environment_id: str, environment: EnvironmentModel
-) -> EnvironmentUpdated:
+) -> None:
     """
     Updates an existing environment
 
@@ -76,8 +74,8 @@ async def update_environment(
         )
 
 
-@router.delete("/{environment_id}")
-async def delete_environment(environment_id: str) -> EnvironmentDeleted:
+@router.delete("/{environment_id}", status_code=204)
+async def delete_environment(environment_id: str) -> None:
     """
     Deletes an existing environment
 

lib/routes/flight.py

@@ -9,8 +9,6 @@
     FlightSimulation,
     FlightCreated,
     FlightRetrieved,
-    FlightUpdated,
-    FlightDeleted,
 )
 from lib.models.environment import EnvironmentModel
 from lib.models.flight import FlightModel
@@ -31,7 +29,7 @@
 tracer = trace.get_tracer(__name__)
 
 
-@router.post("/")
+@router.post("/", status_code=201)
 async def create_flight(
     flight: FlightModel, motor_kind: MotorKinds
 ) -> FlightCreated:
@@ -60,10 +58,10 @@ async def read_flight(flight_id: str) -> FlightRetrieved:
         return await controller.get_flight_by_id(flight_id)
 
 
-@router.put("/{flight_id}")
+@router.put("/{flight_id}", status_code=204)
 async def update_flight(
     flight_id: str, flight: FlightModel, motor_kind: MotorKinds
-) -> FlightUpdated:
+) -> None:
     """
     Updates an existing flight
 
@@ -79,8 +77,8 @@ async def update_flight(
         return await controller.put_flight_by_id(flight_id, flight)
 
 
-@router.delete("/{flight_id}")
-async def delete_flight(flight_id: str) -> FlightDeleted:
+@router.delete("/{flight_id}", status_code=204)
+async def delete_flight(flight_id: str) -> None:
     """
     Deletes an existing flight
 
@@ -125,10 +123,10 @@ async def get_rocketpy_flight_binary(flight_id: str):
         )
 
 
-@router.put("/{flight_id}/environment")
+@router.put("/{flight_id}/environment", status_code=204)
 async def update_flight_environment(
     flight_id: str, environment: EnvironmentModel
-) -> FlightUpdated:
+) -> None:
     """
     Updates flight environment
 
@@ -145,12 +143,12 @@ async def update_flight_environment(
         )
 
 
-@router.put("/{flight_id}/rocket")
+@router.put("/{flight_id}/rocket", status_code=204)
 async def update_flight_rocket(
     flight_id: str,
     rocket: RocketModel,
     motor_kind: MotorKinds,
-) -> FlightUpdated:
+) -> None:
     """
     Updates flight rocket.
 

lib/routes/motor.py

@@ -9,8 +9,6 @@
     MotorSimulation,
     MotorCreated,
     MotorRetrieved,
-    MotorUpdated,
-    MotorDeleted,
 )
 from lib.models.motor import MotorModel, MotorKinds
 from lib.controllers.motor import MotorController
@@ -28,7 +26,7 @@
 tracer = trace.get_tracer(__name__)
 
 
-@router.post("/")
+@router.post("/", status_code=201)
 async def create_motor(
     motor: MotorModel, motor_kind: MotorKinds
 ) -> MotorCreated:
@@ -57,10 +55,10 @@ async def read_motor(motor_id: str) -> MotorRetrieved:
         return await controller.get_motor_by_id(motor_id)
 
 
-@router.put("/{motor_id}")
+@router.put("/{motor_id}", status_code=204)
 async def update_motor(
     motor_id: str, motor: MotorModel, motor_kind: MotorKinds
-) -> MotorUpdated:
+) -> None:
     """
     Updates an existing motor
 
@@ -76,8 +74,8 @@ async def update_motor(
         return await controller.put_motor_by_id(motor_id, motor)
 
 
-@router.delete("/{motor_id}")
-async def delete_motor(motor_id: str) -> MotorDeleted:
+@router.delete("/{motor_id}", status_code=204)
+async def delete_motor(motor_id: str) -> None:
     """
     Deletes an existing motor
 

lib/routes/rocket.py

@@ -9,8 +9,6 @@
     RocketSimulation,
     RocketCreated,
     RocketRetrieved,
-    RocketUpdated,
-    RocketDeleted,
 )
 from lib.models.rocket import RocketModel
 from lib.models.motor import MotorKinds
@@ -29,7 +27,7 @@
 tracer = trace.get_tracer(__name__)
 
 
-@router.post("/")
+@router.post("/", status_code=201)
 async def create_rocket(
     rocket: RocketModel, motor_kind: MotorKinds
 ) -> RocketCreated:
@@ -58,10 +56,10 @@ async def read_rocket(rocket_id: str) -> RocketRetrieved:
         return await controller.get_rocket_by_id(rocket_id)
 
 
-@router.put("/{rocket_id}")
+@router.put("/{rocket_id}", status_code=204)
 async def update_rocket(
     rocket_id: str, rocket: RocketModel, motor_kind: MotorKinds
-) -> RocketUpdated:
+) -> None:
     """
     Updates an existing rocket
 
@@ -77,8 +75,8 @@ async def update_rocket(
         return await controller.put_rocket_by_id(rocket_id, rocket)
 
 
-@router.delete("/{rocket_id}")
-async def delete_rocket(rocket_id: str) -> RocketDeleted:
+@router.delete("/{rocket_id}", status_code=204)
+async def delete_rocket(rocket_id: str) -> None:
     """
     Deletes an existing rocket
 

lib/views/environment.py

@@ -61,11 +61,3 @@ class EnvironmentCreated(ApiBaseView):
 class EnvironmentRetrieved(ApiBaseView):
     message: str = "Environment successfully retrieved"
     environment: EnvironmentView
-
-
-class EnvironmentUpdated(ApiBaseView):
-    message: str = "Environment successfully updated"
-
-
-class EnvironmentDeleted(ApiBaseView):
-    message: str = "Environment successfully deleted"