LLSC-24: Scheduling API #18
Conversation
lint lint
…/uwblueprint/llsc into janealsh/LLSC-24-schedules-model
To Do: - add relationship for Schedule (time_blocks field)
boiler plate code
id should be integers, not uuid
| from abc import ABC, abstractmethod | ||
| from app.schemas.schedule import ScheduleCreate, ScheduleInDB, ScheduleAdd, ScheduleData, ScheduleRemove | ||
|
|
||
| class IScheduleService(ABC): |
There was a problem hiding this comment.
Now that I think about this, I don't think we need this abstract class. ScheduleService is a standalone class.
| from sqlalchemy.orm import Session | ||
|
|
||
| from app.models import Schedule, TimeBlock | ||
| # from app.schemas.schedule import UserCreate, UserInDB, UserRole |
There was a problem hiding this comment.
Should remove these comments!
backend/app/models/ScheduleState.py
Outdated
| from .Base import Base | ||
|
|
||
|
|
||
| class ScheduleState(Base): |
There was a problem hiding this comment.
Let's rename this to ScheduleStatus, I think this would be more indicative of a progession since Schedule is general.
|
|
||
| class ScheduleState(str, Enum): | ||
| PENDING_PARTICIPANT = "PENDING_PARTICIPANT_RESPONSE" | ||
| PENDING_VOLUNTEER = "PENDING_VOLUNTEER_RESPONSE" |
There was a problem hiding this comment.
nit: keep these in the same order as in the DB, just in case someone uses this as a reference for the ordering.
backend/app/schemas/schedule.py
Outdated
| model_config = ConfigDict(from_attributes=True) | ||
|
|
||
| # Provides both Schedule data and full TimeBlock data | ||
| class ScheduleData(ScheduleInDB): |
There was a problem hiding this comment.
In this case I'd call this ScheduleGetResponse.
backend/app/server.py
Outdated
| @@ -20,7 +20,7 @@ | |||
| @asynccontextmanager | |||
| async def lifespan(_: FastAPI): | |||
| log.info("Starting up...") | |||
| models.run_migrations() | |||
| # models.run_migrations() | |||
There was a problem hiding this comment.
Uncomment this line for now, we should have a separate PR to handle updating the migration steps.
backend/app/schemas/time_block.py
Outdated
| ''' | ||
| pass | ||
|
|
||
| class TimeBlockInDB(BaseModel): |
There was a problem hiding this comment.
Call this TimeBlockEntity instead, InDB isn't standard for DB representations.
|
Reminder to fix linter rules as well |
update schedule_state to schedule_status
## Notion ticket link <!-- Please replace with your ticket's URL --> [Ticket Name](https://www.notion.so/uwblueprintexecs/Task-Board-db95cd7b93f245f78ee85e3a8a6a316d) <!-- Give a quick summary of the implementation details, provide design justifications if necessary --> ## Implementation description * <!-- What should the reviewer do to verify your changes? Describe expected results and include screenshots when appropriate --> ## Steps to test 1. <!-- Draw attention to the substantial parts of your PR or anything you'd like a second opinion on --> ## What should reviewers focus on? * ## Checklist - [ ] My PR name is descriptive and in imperative tense - [ ] My commit messages are descriptive and in imperative tense. My commits are atomic and trivial commits are squashed or fixup'd into non-trivial commits - [ ] I have run the appropriate linter(s) - [ ] I have requested a review from the PL, as well as other devs who have background knowledge on this PR or who will be building on top of this PR
Notion ticket link
LLSC-24 Scheduling API
Implementation description
Steps to test
Make a request to http://localhost:8000/schedules (Check FastAPI docs for example input)
Verify that a new Schedule was created, and that the new Time Blocks have that Schedule id as a field
Schedule 13 is created:
3 TimeBlocks were created corresponding to Schedule 13:
What should reviewers focus on?
Checklist