Skip to content

chore: add optional title field to work item link models #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akhil-vamshi-konam wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: add optional title field to work item link models #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9390a85
chore: add optional title field to work item link models
akhil-vamshi-konam Apr 29, 2026
49e0a95
chore: add tests for creating and updating work item links
akhil-vamshi-konam Apr 29, 2026
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
2 changes: 2 additions & 0 deletions plane/models/work_items.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,7 @@ class CreateWorkItemLink(BaseModel):
model_config = ConfigDict(extra="ignore", populate_by_name=True)

url: str
title: str | None = None


class UpdateWorkItemLink(BaseModel):
Expand All @@ -376,6 +377,7 @@ class UpdateWorkItemLink(BaseModel):
model_config = ConfigDict(extra="ignore", populate_by_name=True)

url: str | None = None
title: str | None = None


class WorkItemAttachment(BaseModel):
Expand Down
45 changes: 44 additions & 1 deletion tests/unit/test_work_items.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from plane.client import PlaneClient
from plane.models.projects import Project
from plane.models.query_params import PaginatedQueryParams, WorkItemQueryParams
from plane.models.work_items import AdvancedSearchWorkItem, CreateWorkItem, UpdateWorkItem
from plane.models.work_items import AdvancedSearchWorkItem, CreateWorkItem, CreateWorkItemLink, UpdateWorkItem, UpdateWorkItemLink


class TestWorkItemsAPI:
Expand Down Expand Up @@ -236,6 +236,49 @@ def test_list_links(
assert hasattr(response, "count")
assert isinstance(response.results, list)

def test_create_link_with_title(
self, client: PlaneClient, workspace_slug: str, project: Project, work_item
) -> None:
"""Test creating a work item link with title."""
link = None
try:
link = client.work_items.links.create(
workspace_slug,
project.id,
work_item.id,
CreateWorkItemLink(url="https://example.com", title="Example"),
)
assert link is not None
assert link.url == "https://example.com"
assert link.title == "Example"
finally:
if link is not None:
client.work_items.links.delete(workspace_slug, project.id, work_item.id, link.id)

def test_update_link_title(
self, client: PlaneClient, workspace_slug: str, project: Project, work_item
) -> None:
"""Test updating a work item link title."""
link = None
try:
link = client.work_items.links.create(
workspace_slug,
project.id,
work_item.id,
CreateWorkItemLink(url="https://example.com", title="Original"),
)
updated = client.work_items.links.update(
workspace_slug,
project.id,
work_item.id,
link.id,
UpdateWorkItemLink(title="Updated"),
)
assert updated.title == "Updated"
finally:
if link is not None:
client.work_items.links.delete(workspace_slug, project.id, work_item.id, link.id)

def test_list_activities(
self, client: PlaneClient, workspace_slug: str, project: Project, work_item
) -> None:
Expand Down