Modify create snapshot v2 response when wait_for_completion is false

[anshu1106]

Description

With current implementation of shallow snapshot v2, the create api respond with snapshot info details irrespective of value set for wait_for_completion in the request.

Expected Response

For shallow snapshots v2, if wait_for_completion=false, the api response should be

{
  "accepted" : true
}

if wait_for_completion=true, the api response should be

{
  "snapshot" : {
    "snapshot" : "my_snapshot_3",
    "uuid" : "URJArTYOTOmIFtbv6mbSXQ",
    "version_id" : 137217827,
    "version" : "3.0.0",
    "remote_store_index_shallow_copy" : true,
    "pinned_timestamp" : 1724855317025,
    "indices" : [
      "my-index-1"
    ],
    "data_streams" : [ ],
    "include_global_state" : true,
    "state" : "SUCCESS",
    "start_time" : "2024-08-28T14:28:37.025Z",
    "start_time_in_millis" : 1724855317025,
    "end_time" : "2024-08-28T14:28:37.026Z",
    "end_time_in_millis" : 1724855317026,
    "duration_in_millis" : 1,
    "failures" : [ ],
    "shards" : {
      "total" : 1,
      "failed" : 0,
      "successful" : 1
    }
  }
}

Related Issues

#15516

Check List

• Functionality includes testing.
• API changes companion pull request created, if applicable.
• Public documentation issue/PR created, if applicable.

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.

[github-actions]

✅ Gradle check result for e022735: SUCCESS

[codecov]

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 71.83%. Comparing base (23cba28) to head (e022735).
Report is 54 commits behind head on main.

Files with missing lines	Patch %	Lines
...napshots/create/TransportCreateSnapshotAction.java	33.33%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #15499      +/-   ##
============================================
- Coverage     71.91%   71.83%   -0.08%     
+ Complexity    63311    63286      -25     
============================================
  Files          5225     5225              
  Lines        296350   296352       +2     
  Branches      42809    42810       +1     
============================================
- Hits         213119   212896     -223     
- Misses        65743    66008     +265     
+ Partials      17488    17448      -40     

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

[sachinpkale]

Regarding CodeCov failure: changes are covered in integ tests.

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-15499-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c37d5f691fabb470181b7333efce5bbe4b058107
# Push it to GitHub
git push --set-upstream origin backport/backport-15499-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-15499-to-2.x.