-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(http): add new field xmlRootKey and updated regex for some fields #1884
Conversation
WalkthroughThe pull request introduces modifications to the HTTP configuration's JSON schema and UI configuration. The changes primarily focus on enhancing validation rules for string properties across various sections like Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/configurations/destinations/http/ui-config.json (1)
499-499
: LGTM! Consider documenting the allowed characters.The regex has been simplified to allow only safe characters (alphanumeric, quotes, and hyphens) in constant values, which is good for preventing parsing issues.
Consider adding a note in the placeholder text to indicate the allowed characters, e.g., "e.g: $.properties.key1 or alphanumeric with quotes and hyphens".
src/configurations/destinations/http/schema.json (1)
1068-1086
: LGTM! Consider adding a default value for XML root key.The conditional requirement for XML root key is well-defined. However, providing a default value could improve user experience.
Consider adding a default value in both schema and UI config:
"xmlRootKey": { "type": "string", - "pattern": "^(.{0,100})$" + "pattern": "^(.{0,100})$", + "default": "root" }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/configurations/destinations/http/schema.json
(5 hunks)src/configurations/destinations/http/ui-config.json
(5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (4)
src/configurations/destinations/http/ui-config.json (3)
460-475
: LGTM! The XML root key field is well-defined.The field is correctly configured with appropriate validation, error handling, and conditional visibility based on the format.
523-523
: Same regex update as the Value field.
579-579
: Same pattern update as other fields with additional allowed characters.src/configurations/destinations/http/schema.json (1)
41-41
: Pattern changes are consistent with UI config.Also applies to: 53-53, 65-65, 69-69, 81-81, 85-85
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1884 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 53 53
Branches 7 7
=========================================
Hits 53 53 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/configurations/destinations/http/schema.json
(1 hunks)src/configurations/destinations/http/ui-config.json
(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- src/configurations/destinations/http/ui-config.json
What are the changes introduced in this PR?
Add new field xmlRootKey and updated regex for some fields
What is the related Linear task?
Resolves INT-3173
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
Release Notes
New Features
Improvements
Changes