Skip to content

Add typed platform read clients - #116

Open
ankitv909 wants to merge 1 commit into
KubeOrch:mainfrom
ankitv909:feat/platform-read-clients
Open

ankitv909 wants to merge 1 commit into
KubeOrch:mainfrom
ankitv909:feat/platform-read-clients

Conversation

@ankitv909

Copy link
Copy Markdown

Closes #113.

Adds typed workspace, environment, application, and pagination contracts plus read-client methods using the existing shared Axios client.

Validation:

  • 6 focused Vitest tests pass
  • npm run type-check passes
  • ESLint passes
  • Prettier check passes
  • git diff --check passes

@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: f8400156-5948-4cca-addb-e534c7d13fa3

📥 Commits

Reviewing files that changed from the base of the PR and between 0208a32 and 32b3b8a.

📒 Files selected for processing (3)
  • lib/services/__tests__/platform.test.ts
  • lib/services/platform.ts
  • lib/types/platform.ts

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Changes

Platform read clients

Layer / File(s) Summary
Platform data contracts
lib/types/platform.ts
Adds typed workspace, environment, and application models with paginated list response envelopes and application filters.
Platform read service methods
lib/services/platform.ts
Adds list and single-application read methods that use the shared API client and omit undefined query parameters.
Read service validation
lib/services/__tests__/platform.test.ts
Tests request paths, query serialization, response data, omitted parameters, and propagated request failures.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~15 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to a27ca

The new platform read APIs use the shared client and preserve the requested paths, filters, pagination, and error behavior. No actionable merge risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the primary change: adding typed platform read clients.
Description check ✅ Passed The description directly covers the added platform types, read-client methods, supported query parameters, tests, and validation results.
Linked Issues check ✅ Passed The changes satisfy the coding requirements in issue #113. lib/types/platform.ts defines camelCase workspace, environment, application, and pagination types with { items, pageInfo } envelopes. `li…
Out of Scope Changes check ✅ Passed The reviewed changes are limited to the typed platform read client and focused unit tests required by issue #113. They add no React state, components, write operations, generated client, or HTTP depen…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@ankitv909
ankitv909 force-pushed the feat/platform-read-clients branch from 32b3b8a to a27cae2 Compare September 13, 2026 03:01
@mohit-nagaraj

Copy link
Copy Markdown
Member

Hey @ankitv909
Thanks for your contributions - could you please sign your commits? else its looks good to me

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.

[Platform API] Add typed read clients for workspaces, environments, and applications

2 participants