fix: issue external apis breaking because of serializer changes

[henit-chobisa]

Description

• Issue External APIs breaking due to serializer changes

Summary by CodeRabbit

• New Features

  • Introduced a new optional field for associating issues with types, enhancing issue categorization.
  • Improved issue creation process to automatically infer a default issue type when none is provided.

• Bug Fixes

  • Enhanced data integrity by ensuring every issue is linked to a valid type during creation.

[coderabbitai]

Walkthrough

The recent changes to the IssueSerializer enhance the way issues are categorized by introducing a new optional type_id field. This modification allows issues to be associated with specific IssueType entries while providing a default type based on the project context if none is specified. These improvements aim to boost data integrity and usability within the issue tracking system.

Changes

Files	Change Summary
apiserver/plane/api/serializers/issue.py	Added type_id as an optional field for associating issues with IssueType, and updated the create method to handle default issue types.

Poem

🐰 In the meadow of code, where issues bloom bright,
A new type takes shape, bringing joy and delight.
With type_id in hand, our problems align,
Each issue now shines, like stars that entwine.
Let’s hop through this change, with cheer in our hearts,
For clarity reigns where the new journey starts! ✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f675ea3 and bb184af.

Files selected for processing (1)

• apiserver/plane/api/serializers/issue.py (3 hunks)

Additional comments not posted (2)

apiserver/plane/api/serializers/issue.py (2)

50-55: Ensure consistent usage of type_id.

The type_id field is correctly defined as a PrimaryKeyRelatedField with optional and nullable attributes. Verify that this field is consistently used across the application to prevent any discrepancies.

---

139-151: Verify default IssueType retrieval logic.

The create method includes logic to retrieve a default IssueType if none is provided. Ensure that this logic handles cases where no default IssueType is available for a project, to avoid potential issues.