feat: restrict version selection

[aanshi07]

What are the changes introduced in this PR?

Adding disable as an option to restrict version selection from singleSelect in Hubspot

What is the related Linear task?

Resolves INT-2428

UI:

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new checks got introduced or modified in test suites. Please explain the changes.

N/A

---

Developer checklist

• My code follows the style guidelines of this project

• No breaking changes are being introduced.

• All related docs linked with the PR?

• All changes manually tested?

• Any documentation changes needed with this change?

• I have executed schemaGenerator tests and updated schema if needed

• Are sensitive fields marked as secret in definition config?

• My test cases and placeholders use only masked/sample values for sensitive fields

• Is the PR limited to 10 file changes & one task?

Reviewer checklist

• Is the type of change in the PR title appropriate as per the changes?

• Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

• New Features
  • Transitioned to "New API (v3)" as the default API version, phasing out the legacy option.
  • Enhanced user input logic with prerequisites for "Access Token" and "API Key" fields.
  • Clarified availability of "Event mapping" based on the selected API version.

These updates improve user experience by guiding users towards the latest API functionalities.

[coderabbitai]

Walkthrough

The changes in the pull request involve modifications to the ui-config.json and schema.json files, primarily updating the configuration settings for API usage. The default "API Version" has been changed from "legacyApi" to "newApi," disabling the legacy option. New prerequisites have been added for the "Access Token" and "API Key" fields, and the "Create associations between object records" checkbox now requires the selection of the "New API (v3)." The schema's default value for apiVersion has also been updated to reflect this shift.

Changes

File	Change Summary
src/configurations/destinations/hs/ui-config.json	Updated "API Version" default from "legacyApi" to "newApi"; disabled legacy API option; added prerequisites for "Access Token" and "API Key"; modified "Create associations between object records" checkbox prerequisites; clarified "Event mapping" section availability.
src/configurations/destinations/hs/schema.json	Changed default value for apiVersion from "legacyApi" to "newApi".

Possibly related PRs

• feat: onboard mixpanel on new form builder #1733: The changes in src/configurations/destinations/mp/schema.json involve modifications to the schema properties, similar to the changes made to the apiVersion property in src/configurations/destinations/hs/schema.json, indicating a related focus on schema updates for API configurations.

Suggested reviewers

• lvrach
• am6010
• AchuthaSourabhC
• ssbeefeater
• debanjan97
• cisse21
• ruchiramoitra
• shrouti1507
• 1abhishekpandey
• ItsSudip
• koladilip
• sandeepdsvs

🐰 "In the garden where changes bloom,
The new API chases away the gloom.
With tokens and keys, we hop with glee,
New paths to explore, come join me!
Legacy's gone, a fresh start we see,
Hopping towards progress, oh what a spree!" 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3f58b3f and 4fcc998.

📒 Files selected for processing (1)

• src/configurations/destinations/hs/schema.json (1 hunks)

🔇 Additional comments (2)

src/configurations/destinations/hs/schema.json (2)

Line range hint 1-24: LGTM: Schema structure is well-defined

The schema's conditional logic properly handles all combinations of apiVersion and authorizationType, with appropriate field requirements and validations.

Also applies to: 575-755

---

19-19: Potential breaking change: Default API version updated

While the change aligns with the PR objective to restrict version selection, changing the default apiVersion from "legacyApi" to "newApi" could affect existing configurations that don't explicitly set this field.

Let's verify the impact on existing configurations:

---

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>, 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 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (70b81c3) to head (4fcc998).
Report is 36 commits behind head on develop.

Additional details and impacted files

@@            Coverage Diff            @@
##           develop     #1763   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           53        53           
  Branches         7         7           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 70b81c3 and 3f58b3f.

📒 Files selected for processing (1)

• src/configurations/destinations/hs/ui-config.json (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

src/configurations/destinations/hs/ui-config.json (1)

Line range hint 89-96: Prerequisites are well-structured and clearly communicated.

The implementation correctly handles feature visibility based on API version selection:

1. Lookup field configuration is properly gated behind New API
2. Event mapping section clearly indicates its dependency on New API

Also applies to: 236-244

[devops-github-rudderstack]

This PR is considered to be stale. It has been open for 20 days with no further activity thus it is going to be closed in 7 days. To avoid such a case please consider removing the stale label manually or add a comment to the PR.