[WEB-4520] chore: changed the serializer for cycle issues

[NarayanBavisetti]

Description

this pull request fixes a bug in the external API's Cycle Issues GET request, which was using an incorrect serializer.

Type of Change

• Bug fix (non-breaking change which fixes an issue)

Summary by CodeRabbit

• Bug Fixes
  • Improved the format of issue lists when viewing issues for a cycle, ensuring issue details are now displayed in a more issue-focused format.

[coderabbitai]

Walkthrough

The import in the cycle API view was updated to include IssueSerializer. The CycleIssueAPIEndpoint.get method now uses IssueSerializer instead of CycleSerializer to serialize issue lists, altering the output format for listed issues within a cycle. No other logic or control flow was changed.

Changes

File(s)	Change Summary
apps/api/plane/api/views/cycle.py	Updated import to include IssueSerializer; changed serializer in CycleIssueAPIEndpoint.get from CycleSerializer to IssueSerializer for issue list serialization.

Suggested labels

ready_to_merge

Suggested reviewers

• dheeru0198

Poem

A tweak in the code, a hop in the view,
Now issues are clearer, in format anew.
With serializers swapped, the data takes flight,
Rabbits rejoice in the output so right!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89983b0 and d5bc85c.

📒 Files selected for processing (1)

• apps/api/plane/api/views/cycle.py (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

apps/api/plane/api/views/cycle.py (2)

apps/api/plane/app/serializers/cycle.py (2)

• CycleIssueSerializer (91-98)
• CycleSerializer (45-88)

apps/api/plane/app/serializers/issue.py (1)

• IssueSerializer (682-725)

🔇 Additional comments (2)

apps/api/plane/api/views/cycle.py (2)

28-28: Import addition looks correct.

Adding IssueSerializer to the imports is necessary for the fix in the CycleIssueAPIEndpoint.get method.

---

642-644: Correct serializer fix for cycle issues GET request.

The change from CycleSerializer to IssueSerializer is the correct fix. The queryset being serialized contains Issue objects (line 602), so using IssueSerializer ensures the proper serialization format. Using CycleSerializer for Issue objects would have caused incorrect API responses.

This aligns with the PR objective of fixing the serializer bug in the external API's Cycle Issues GET request.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This PR fixes a bug in the external API's Cycle Issues GET request by correcting the serializer used for response data. The change ensures that issue data is properly serialized using the appropriate serializer instead of an incorrect one.

• Imports the correct IssueSerializer for handling issue data serialization
• Updates the GET endpoint to use IssueSerializer instead of CycleSerializer for issue objects

[makeplane]

Pull Request Linked with Plane Work Items

• [WEB-4520] Internal Server Error In List Cycle Issues API

Comment Automatically Generated by Plane