Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions plane/models/initiatives.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from pydantic import BaseModel, ConfigDict

from .enums import InitiativeState
from .pagination import PaginatedResponse


class Initiative(BaseModel):
Expand Down Expand Up @@ -53,7 +54,7 @@ class UpdateInitiative(BaseModel):
lead: str | None = None


class PaginatedInitiativeResponse(BaseModel):
class PaginatedInitiativeResponse(PaginatedResponse):
"""Paginated initiative response model."""

model_config = ConfigDict(extra="allow", populate_by_name=True)
Expand Down Expand Up @@ -99,7 +100,7 @@ class UpdateInitiativeLabel(BaseModel):
sort_order: float | None = None


class PaginatedInitiativeLabelResponse(BaseModel):
class PaginatedInitiativeLabelResponse(PaginatedResponse):
"""Paginated initiative label response model."""

model_config = ConfigDict(extra="allow", populate_by_name=True)
Expand Down
25 changes: 25 additions & 0 deletions tests/unit/test_initiatives.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
from plane.models.initiatives import (
CreateInitiative,
CreateInitiativeLabel,
PaginatedInitiativeLabelResponse,
PaginatedInitiativeResponse,
UpdateInitiative,
UpdateInitiativeLabel,
)
Expand Down Expand Up @@ -371,3 +373,26 @@ def test_add_and_remove_work_items(

remaining = client.initiatives.work_items.list(workspace_slug, initiative.id)
assert work_item.id not in [item.id for item in remaining.results]


_PAGE = {
"total_count": 25,
"next_cursor": "20:1:0",
"prev_cursor": "20:-1:1",
"next_page_results": True,
"prev_page_results": False,
"count": 20,
"total_pages": 2,
"total_results": 25,
"results": [],
}


@pytest.mark.parametrize("model", [PaginatedInitiativeResponse, PaginatedInitiativeLabelResponse])
def test_list_declares_the_cursor(model: type) -> None:
"""Plane pages these lists, 20 by default; the cursor is a typed field, not an extra."""
assert {"next_cursor", "next_page_results", "total_count"} <= model.model_fields.keys()
page = model.model_validate(_PAGE)
assert page.next_cursor == "20:1:0"
assert page.next_page_results is True
assert page.total_count == 25
Loading