fix: require deck_id on Card response schema (#69)

Author: lesnik512

app/api/cards.py

@@ -33,7 +33,7 @@ async def create_cards(
 @litestar.put("/decks/{deck_id:int}/cards/")
 async def update_cards(
     deck_id: FromPath[int],
-    data: list[schemas.Card],
+    data: list[schemas.CardUpdate],
     update_cards_use_case: NamedDependency[UpdateCardsUseCase],
 ) -> schemas.Cards:
     return schemas.Cards.from_models(await update_cards_use_case(deck_id=deck_id, data=data))

app/repositories.py

@@ -49,8 +49,8 @@ async def list_for_deck(self, deck_id: int) -> Sequence[models.Card]:
     async def add_cards(self, deck_id: int, cards: list[schemas.CardCreate]) -> Sequence[models.Card]:
         return await self.create_many([models.Card(**card.model_dump(), deck_id=deck_id) for card in cards])
 
-    async def upsert_cards(self, deck_id: int, cards: list[schemas.Card]) -> Sequence[models.Card]:
+    async def upsert_cards(self, deck_id: int, cards: list[schemas.CardUpdate]) -> Sequence[models.Card]:
         upserted = await self.upsert_many(
-            [models.Card(**card.model_dump(exclude={"deck_id"}), deck_id=deck_id) for card in cards],
+            [models.Card(**card.model_dump(), deck_id=deck_id) for card in cards],
         )
         return sorted(upserted, key=operator.attrgetter("id"))

app/schemas.py

@@ -31,9 +31,12 @@ class CardCreate(CardBase):
     pass
 
 
-class Card(CardBase):
+class CardUpdate(CardBase):
     id: PositiveInt
-    deck_id: PositiveInt | None = None
+
+
+class Card(CardUpdate):
+    deck_id: PositiveInt
 
 
 class Cards(Collection[Card]):

app/use_cases/update_cards.py

@@ -14,7 +14,7 @@ class UpdateCardsUseCase:
     cards_repository: CardsRepository
 
     @postgres_retry
-    async def __call__(self, *, deck_id: int, data: list[schemas.Card]) -> Sequence[models.Card]:
+    async def __call__(self, *, deck_id: int, data: list[schemas.CardUpdate]) -> Sequence[models.Card]:
         async with self.transaction:
             cards: typing.Final = await self.cards_repository.upsert_cards(deck_id, data)
             await self.transaction.commit()

tests/test_cards.py

@@ -135,3 +135,11 @@ async def test_cards_ordered_by_id_after_update(client: AsyncClient) -> None:
     response = await client.get(f"/api/decks/{deck.id}/cards/")
     assert response.status_code == status_codes.HTTP_200_OK
     assert [x["id"] for x in response.json()["items"]] == [card1.id, card2.id]
+
+
+async def test_openapi_card_deck_id_required(client: AsyncClient) -> None:
+    response = await client.get("/docs/openapi.json")
+    assert response.status_code == status_codes.HTTP_200_OK
+    card_schema = response.json()["components"]["schemas"]["Card"]
+    assert "deck_id" in card_schema["required"]
+    assert card_schema["properties"]["deck_id"]["type"] == "integer"