Skip to content

chore: Implemented lite project, cycle, and module endpoints in the Plane SDK#56

Open
gurusainath wants to merge 1 commit into
mainfrom
lite-endpoints
Open

chore: Implemented lite project, cycle, and module endpoints in the Plane SDK#56
gurusainath wants to merge 1 commit into
mainfrom
lite-endpoints

Conversation

@gurusainath

@gurusainath gurusainath commented Jun 25, 2026

Copy link
Copy Markdown
Member

Description

Implemented support for lite project, cycle, and module endpoints in the Plane SDK.

These endpoints expose lightweight resources through the SDK, making it easier to build pickers, dropdowns, and other list-based experiences while reducing response size.

Type of Change

  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)

Test Scenarios

  • Verified lite project endpoints through the SDK.
  • Verified lite cycle endpoints through the SDK.
  • Verified lite module endpoints through the SDK.
  • Tested pagination and query parameter support.
  • Confirmed backward compatibility with existing SDK methods.

Summary by CodeRabbit

  • New Features

    • Added lightweight listing support for projects, cycles, and modules.
    • Introduced a new shared query parameter option for cursor-based pagination and sorting on these list endpoints.
    • Added new response shapes for the lightweight lists, returning trimmed item details and pagination metadata.
  • Tests

    • Added coverage for the new lightweight list endpoints to verify response format, item types, and page size limits.

@gurusainath gurusainath self-assigned this Jun 25, 2026
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8c0b8c71-9dd4-4d21-9482-07618789678e

📥 Commits

Reviewing files that changed from the base of the PR and between a492f30 and c8a7449.

📒 Files selected for processing (11)
  • plane/api/cycles.py
  • plane/api/modules.py
  • plane/api/projects.py
  • plane/models/__init__.py
  • plane/models/cycles.py
  • plane/models/modules.py
  • plane/models/projects.py
  • plane/models/query_params.py
  • tests/unit/test_cycles.py
  • tests/unit/test_modules.py
  • tests/unit/test_projects.py

📝 Walkthrough

Walkthrough

Adds lite-list query parameters, lite response models, client list_lite methods for projects, cycles, and modules, and unit tests covering the new endpoints and paginated result shapes.

Changes

Lite list endpoints

Layer / File(s) Summary
Lite contracts and exports
plane/models/query_params.py, plane/models/projects.py, plane/models/cycles.py, plane/models/modules.py, plane/models/__init__.py
LiteListQueryParams is added and exported, and new lite project, cycle, and module response models define the paginated result shapes.
Lite list client methods and tests
plane/api/projects.py, plane/api/cycles.py, plane/api/modules.py, tests/unit/test_projects.py, tests/unit/test_cycles.py, tests/unit/test_modules.py
New list_lite methods call the *-lite endpoints with optional query params and validate paginated lite responses; unit tests exercise the new calls and result item types.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

  • dheeru0198
  • Prashant-Surya

Poem

🐰 I hopped to the lite-list glade,
With cursors, pages, and tidy shade.
Projects, cycles, modules now gleam,
In a smaller, swifter, rabbity stream.
Thump thump! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding lite project, cycle, and module endpoints to the Plane SDK.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch lite-endpoints

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gurusainath gurusainath marked this pull request as ready for review June 25, 2026 13:17
@akhil-vamshi-konam

Copy link
Copy Markdown
Contributor

@gurusainath Can we bump the SDK version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants