fix: Revert deploymentVersionChannel to releaseChannel

[adityachoudhari26]

Summary by CodeRabbit

• Refactor
  • Renamed the field used in the environment creation API from its previous name to releaseChannels for improved clarity. This update is consistently applied across the API specification and public SDK.

[coderabbitai]

Walkthrough

This pull request renames the property deploymentVersionChannels to releaseChannels across multiple components. The update is applied to the OpenAPI specification (in both TypeScript and JSON formats) for the createEnvironment operation and to the corresponding request handling in the API routes. In the Node SDK, the operations interface is modified accordingly by removing the old property and adding the new one. The changes preserve the original data type (an array of strings) and the overall structure.

Changes

File(s)	Change Summary
apps/webservice/.../openapi.ts, apps/webservice/.../route.ts, openapi.v1.json	Renamed property deploymentVersionChannels to releaseChannels in API schema definitions and request handling for the createEnvironment operation.
packages/node-sdk/.../schema.ts	Updated the operations interface by removing deploymentVersionChannels and adding releaseChannels (array of strings).

Possibly related PRs

• fix: Release channel dialog bug #233: Addresses property renaming in the OpenAPI schema for createEnvironment.
• fix: Post release channel route #201: Updates property naming in the schema definitions for environment creation.
• fix: Create jobs for latest valid releases on env create #197: Modifies request handling to map the new releaseChannels property accordingly.

Suggested reviewers

• jsbroks

Poem

I'm a hopping rabbit on a byte-filled trail,
Renaming channels without fail.
From "deployment" to "release," the changes ring,
Like new carrots in a digital spring.
Thump-thump, code's a joy—let's hop and sing!
🥕🐇

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e6756c and 8b6f11b.

📒 Files selected for processing (4)

• apps/webservice/src/app/api/v1/environments/openapi.ts (1 hunks)
• apps/webservice/src/app/api/v1/environments/route.ts (2 hunks)
• openapi.v1.json (1 hunks)
• packages/node-sdk/src/schema.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{ts,tsx}`: **Note on Error Handling:** Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error...

**/*.{ts,tsx}: Note on Error Handling:
Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error handling. These are acceptable as long as they maintain clarity and predictability.

• apps/webservice/src/app/api/v1/environments/openapi.ts
• apps/webservice/src/app/api/v1/environments/route.ts
• packages/node-sdk/src/schema.ts

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Typecheck
• GitHub Check: Lint
• GitHub Check: build (linux/amd64)

🔇 Additional comments (5)

openapi.v1.json (1)

575-580: Property rename looks good.

The change from deploymentVersionChannels to releaseChannels aligns with the PR objectives while maintaining the same data structure (array of strings).

apps/webservice/src/app/api/v1/environments/openapi.ts (1)

44-49: Property rename is consistent with OpenAPI JSON.

The TypeScript OpenAPI definition now correctly uses releaseChannels instead of deploymentVersionChannels, maintaining alignment with the JSON specification.

apps/webservice/src/app/api/v1/environments/route.ts (2)

17-19: Schema property rename is consistent.

The schema definition now correctly uses releaseChannels instead of deploymentVersionChannels, maintaining alignment with the OpenAPI specifications.

---

51-55: Correct variable mapping for backward compatibility.

The destructuring assignment correctly maps the new releaseChannels property from the request body to the deploymentVersionChannels variable used in the internal implementation, ensuring backward compatibility with existing database queries and operations.

packages/node-sdk/src/schema.ts (1)

1240-1240: Property renamed from deploymentVersionChannels to releaseChannels

The property has been correctly renamed while maintaining the same type signature (optional string array). This change aligns with the PR objective to revert the property name back to releaseChannels.

✨ 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.
  • 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 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 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 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 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.

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.