rename API fields to snake_case#20351
rename API fields to snake_case#2035105Har-sh wants to merge 1 commit intoopensearch-project:mainfrom
Conversation
📝 WalkthroughWalkthroughUpdated JSON field names in SnapshotRecoverySource and RemoteStoreRecoverySource to use snake_case in XContent serialization for five properties: restoreUUID, isSearchableSnapshot, remoteStoreIndexShallowCopy, sourceRemoteStoreRepository, and sourceRemoteTranslogRepository. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. Comment |
Signed-off-by: Harsh Pardeshi <pardeshiharsh005@gmail.com>
b04a647 to
b047b22
Compare
|
❌ Gradle check result for b047b22: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
|
/check-pull-request |
|
Hi! I’m interested in working on this issue. |
|
This PR is stalled because it has been open for 30 days with no activity. |
| .field("remote_store_index_shallow_copy", remoteStoreIndexShallowCopy) | ||
| .field("source_remote_store_repository", sourceRemoteStoreRepository) | ||
| .field("source_remote_translog_repository", sourceRemoteTranslogRepository); | ||
| } |
There was a problem hiding this comment.
The only problem with this change is backward compatibility, which will break.
We can revisit this change ahead of 4.0 release once as we avoid any breaking changes in minor releases.
There was a problem hiding this comment.
Thank you for the review! I understand the concern regarding backward compatibility. I'm happy to revisit this for the 4.0 release, Please let me know if there are any other adjustments needed in the meantime.
Description
This PR updates several field names in the /{index}/_recovery API response from camelCase to snake_case to maintain consistency
I have verified these changes by running RecoverySourceTests locally and the build was successful
Related Issues
Fixes #16334
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.