search

BFARIAAL / api-pdc-backend

API PDC backedncode
1 stars 1 forks source link

Technical Analysis: Include location on the Vehicle API #45

Closed BFARIAAL closed 11 months ago

BFARIAAL commented 11 months ago

Perform a technical analysis on how to include detailed location information on the Vehicle API if the user requests it

Charhmwang commented 11 months ago

Please review the attached document containing the proposed solution plan, and whether the format meets the required technical analysis standards

TechnicalAnalysis_45.docx

BFARIAAL commented 11 months ago

Moving back to In Progress.

The technical analysis suggests an approach to a new end point /vehicles/by_id/{id}/location. While this is a valid approach, it's not a scalable approach as we might want more details in other vehicle details (For example, if the vehicle has a location code that specifies the vehicle's assembly plant, we'd require two HTTP requests if we wanted both assembly plant location and current location details). Please reanalyse the issue and try to come up with an approach that not only will be scalable to allow multiple detailed requests but also that will create a template that we can later use for similar detail requests.

Charhmwang commented 11 months ago

TechnicalAnalysis_45.docx

This is my solution plan to make it a scalable approach based on the comment above.

Charhmwang commented 11 months ago

A solution designed corresponding to the scrum call today

TechnicalAnalysis_45.docx

Charhmwang commented 11 months ago

This version included the database changes. TechnicalAnalysis_45.docx

BFARIAAL commented 11 months ago

TA reviewed. Please review the comments left in it for future TAs.

TechnicalAnalysis_45.docx

TA approved, moving to development