Skip to content

feat: open api refactor#213

Open
szuperaz wants to merge 5 commits intomainfrom
open-api-refactor
Open

feat: open api refactor#213
szuperaz wants to merge 5 commits intomainfrom
open-api-refactor

Conversation

@szuperaz
Copy link
Contributor

@szuperaz szuperaz commented Jan 15, 2026

🎫 Ticket: https://linear.app/stream/issue/XYZ-123

📑 Docs: https://github.com/GetStream/docs-content/pull/

💡 Overview

📝 Implementation notes

Summary by CodeRabbit

  • Refactor
    • Aligned internal type usage and simplified user-related types for consistency across the codebase.
  • Tests
    • Removed redundant empty "custom" fields from attachment payloads in several tests to streamline test fixtures.
  • Style
    • Standardized a poll option type reference in the sample app (no runtime behavior changes).

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2026

📝 Walkthrough

Walkthrough

Replaced references to OwnUser with OwnUserResponse in test utilities and types, adjusted generateOwnUser signature/return type, removed an empty custom field from several test attachment objects, and changed a poll option type import alias in the sample app.

Changes

Cohort / File(s) Summary
Type/Test utils
packages/feeds-client/src/test-utils/response-generators.ts
Removed OwnUser import; generateOwnUser now accepts and returns Partial<OwnUserResponse> / OwnUserResponse and reuses generateOwnUserResponse() as base.
Type definitions
packages/feeds-client/src/types.ts
Replaced OwnUser with OwnUserResponse in imports; ConnectedUser now equals OwnUserResponse (dropped OwnUser & { name?: string; image?: string }).
Sample app import
sample-apps/react-sample-app/app/components/Poll.tsx
Swapped import alias: PollOptionResponseData is now imported as StreamPollOption (replacing prior PollOption as StreamPollOption).
Integration tests — attachments
packages/feeds-client/__integration-tests__/docs-snippets/activities.test.ts, .../file-uploads.test.ts, .../stories.test.ts, packages/feeds-client/__integration-tests__/stories.test.ts
Removed explicit empty custom: {} properties from various attachment objects in tests; payloads simplified, no control-flow changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through types in a nimble whirl,
Swapped OwnUser for Response with a twirl,
Pruned empty fields, tidied imports true,
A carrot of clarity — code fresh as dew! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description uses the correct template structure with Ticket and Docs links, but the Overview and Implementation notes sections are empty, providing no details about the changes. Fill in the Overview section with a summary of what the OpenAPI refactor involves, and add Implementation notes explaining the key changes (type updates, removal of empty custom fields, etc.).
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: open api refactor' is directly related to the changeset, which involves regenerating OpenAPI-generated code and updating type imports throughout the codebase.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
  • 📝 Generate docstrings


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7cfbb05 and ec32a36.

⛔ Files ignored due to path filters (1)
  • packages/feeds-client/src/gen/models/index.ts is excluded by !**/gen/**
📒 Files selected for processing (4)
  • packages/feeds-client/__integration-tests__/docs-snippets/activities.test.ts
  • packages/feeds-client/__integration-tests__/docs-snippets/file-uploads.test.ts
  • packages/feeds-client/__integration-tests__/docs-snippets/stories.test.ts
  • packages/feeds-client/__integration-tests__/stories.test.ts
💤 Files with no reviewable changes (4)
  • packages/feeds-client/integration-tests/docs-snippets/activities.test.ts
  • packages/feeds-client/integration-tests/docs-snippets/file-uploads.test.ts
  • packages/feeds-client/integration-tests/docs-snippets/stories.test.ts
  • packages/feeds-client/integration-tests/stories.test.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: lint-and-test (22.x)

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • XYZ-123: Entity not found: Issue - Could not find referenced Issue.

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 and usage tips.

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.

1 participant