Closed fyliu closed 11 months ago
I'm closing this. We're making good progress at refining the design of the backend and there's enough examples along the way. So we don't need an issue to do that. Also, it seems like we have more information about how the system is supposed to work than the frontend team, so we don't need to get them involved for this right now.
DRAFT
Overview
As a backend project, we need a well-defined API layer to act as the acceptance criteria for developers to know when to stop working on features. It should cover exactly what VRMS needs from the backend. This will require collaboration between PD and VRMS.
Action Items
Resources/Instructions
This issue came about from a helpful discussion in another issue when I realized this is what we need. https://github.com/hackforla/peopledepot/issues/143#issuecomment-1501230473
Who can we get to work on defining the API (in order of preference):
What APIs do we need:
We don't need these. VRMS would do these steps with cognito directly.
Sign in
We do need these, and this is not a complete list:
Projects
Events
There are situations that VRMS will be able to tell us, like:
, with matching user experiences and project needs highlighted (maybe CTJ functionality?). Clicking a button sets up the association. So we need to be able to set project admin using data available in project details and user details.This last situation show that the frontend workflows can make use of API functionality for multiple tables. The users list API needs to have certain filters and sorts to support this use, where as the users list that an admin sees by default might not require them or might have different requirements.
Going through all the frontend user stories will give us a complete set of API requirements that we need to support for what FE needs from us. Ideally, someone from VRMS could make a first pass attempt at it before meeting with PD. Tech leads are better because they would understand that, to create an association, you'd need a user id and a project id, just to give an example. They would catch problems like that before it gets to us.