hngprojects / hng_boilerplate_python_fastapi_web

Apache License 2.0
153 stars 136 forks source link

chore: merge 'dev' to staging #878

Closed trevorjob closed 2 months ago

trevorjob commented 2 months ago

Description

I changed the route for the POST request from api/v1/newsletters/subscribers to api/v1/newsletter-subscriptions to better reflect the purpose of the endpoint. This change is part of an ongoing effort to improve the clarity and consistency of our API routes.

Related Issue (Link to issue ticket)

Motivation and Context

​The previous route name api/v1/newsletters/subscribers was a bit ambiguous and could be misinterpreted as a route that manages only the subscribers. Changing it to api/v1/newsletter-subscriptions makes it clearer that this endpoint handles subscription actions, improving the overall API design.

How Has This Been Tested?

I updated the relevant unit tests to reflect the new route and ran them to ensure the change does not break existing functionality. I also manually tested the route using Postman to verify that the request and response are handled correctly. ​

Screenshots (if appropriate - Postman, etc):

Types of changes

Checklist:

github-actions[bot] commented 2 months ago

Here are the latest updates on your deployment. Explore the action and ⭐ star our project for more insights! 🔍

Deployed By Status Preview URL Updated At (UTC)
PR Deploy Terminated 🛑 Visit Preview Aug 13, 2024 03:21PM