hackforla / lucky-parking

Visualization of parking data to assist in understanding of the effects of parking policies on a neighborhood by neighborhood basis in the City of Los Angeles
https://www.hackforla.org/projects/lucky-parking.html
34 stars 60 forks source link

Build citation controller #552

Closed glenflorendo closed 10 months ago

glenflorendo commented 11 months ago

User Story

As a developer, I want a controller for the POST citation endpoint, so I can manage the incoming HTTP requests.

Description

In the manager/worker analogy, the controllers are the manager and the the services are the workers. The controller receives the work to be done, decides which services should perform the work, then passes the work to be completed. The services actually take that work and complete it.

On a high level, the POST citation endpoint takes in different filters (dates, geometry, etc.) to be used to find and return a list of parking citations.

This work involves scaffolding and possibly creating the controller for this endpoint.

Blocked by #551 #557

Acceptance Criteria

  1. The citation controller is created to handle the HTTP requests for the POST citations endpoint.
  2. The controller validates the request body.
  3. The controller orchestrates the work by calling service(s).
  4. The controller returns a JSON body of the result.
  5. The documentation should be updated, if necessary.

Design References

N/A

Technical References

N/A

Additional Information

N/A