Add spec for new rename_alias_pattern and rename_alias_replacement parameters to snapshot restore

[mispencer]

Description

Add spec for new rename_alias_pattern and rename_alias_replacement parameters to snapshot restore implemented in Opensearch PR 16292

Issues Resolved

No related issues

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.

[mispencer]

The implementing PR for this spec change is not yet merged.

[dblock]

Looking good, needs a CHANGELOG, passing tests, etc.

[dblock]

We should call it something meaningful, maybe tales?

[mispencer]

Do you mean new_stories? This is the restored-with-new-name index. I changed it to renamed_stories.

[dblock]

I just don't love names like new_xyz or xyz_1 because we plan to use these samples to generate documentation. It's better with names like "movies" or "films", so instead of "new_stories" maybe we can use something semantically interesting like "tales"?

[mispencer]

This name is for the rename parameters for this API. An entirely new name like that would not fit the most common use case of those parameters, which is to restore a copy of existing index with a new, non-conflicting name. So, even for documentation, I think a prefixed name like currently is more suitable. The current documentation of restore supports this - it has an example of a prefixed name, recovered-logs, and a suffixed name, opendistro-reports-definitions_restored, but no example of a entirely new name for renamed indexes.

[dblock]

Understood, thanks. Maybe xyz-restored would make more semantic sense?

Take this opportunity to look at these restore tests and see if better names than "my-xyz" can be used. Think of what you'd want to read in the docs. NBD, but much appreciated.

[mispencer]

I have renamed this index and rewrote the rename parameters to match realistic use cases.

[github-actions]

Changes Analysis

Commit SHA: ab1bec8
Comparing To SHA: 22bdd5c

API Changes

Summary

└─┬Paths
  ├─┬/_snapshot/{repository}/{snapshot}
  │ ├─┬PUT
  │ │ └─┬Requestbody
  │ │   └─┬application/json
  │ │     └─┬Schema
  │ │       └─┬ignore_unavailable
  │ │         └──[🔀] description (27563:30)
  │ └─┬POST
  │   └─┬Requestbody
  │     └─┬application/json
  │       └─┬Schema
  │         └─┬ignore_unavailable
  │           └──[🔀] description (27563:30)
  └─┬/_snapshot/{repository}/{snapshot}/_restore
    └─┬POST
      └─┬Requestbody
        └─┬application/json
          └─┬Schema
            ├──[➕] properties (27642:15)
            ├──[➕] properties (27649:15)
            ├──[➕] properties (27653:15)
            ├──[➕] properties (27657:15)
            ├─┬partial
            │ └──[➕] description (27626:30)
            ├─┬rename_pattern
            │ └──[➕] description (27633:30)
            ├─┬rename_replacement
            │ └──[➕] description (27641:30)
            ├─┬ignore_index_settings
            │ └──[➕] description (27605:30)
            ├─┬ignore_unavailable
            │ └──[➕] description (27611:30)
            ├─┬include_aliases
            │ └──[➕] description (27614:30)
            └─┬include_global_state
              └──[➕] description (27617:30)

Document Element	Total Changes	Breaking Changes
paths	13	0

• Total Changes: 13
• Modifications: 2
• Additions: 11

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11981080235/artifacts/2227238993

API Coverage

	Before	After	Δ
Covered (%)	599 (58.67 %)	599 (58.67 %)	0 (0 %)
Uncovered (%)	422 (41.33 %)	422 (41.33 %)	0 (0 %)
Unknown	42	42	0

[mispencer]

This feature has been merged.

[dblock]

This feature has been merged.

You'll need to update the 2.18 and 3.0 SHAs in CI as well for something that has the feature. I added some documentation for this in #642.

[dblock]

Now that 2.18 has been released this should be easier. Want to finish this @mispencer?

[mispencer]

Now that 2.18 has been released this should be easier. Want to finish this @mispencer?

Looks like this has already been updated in the main branch.

[dblock]

For a future PR (unless this one needs more iterating) you should break up this test into snapshot/restore/index.yaml for basic scenarios restore/rename.yaml, etc., this way each stands alone as an example that can be reused in the appropriate documentation.

[github-actions]

Spec Test Coverage Analysis

Total	Tested
528	372 (70.45 %)

[dblock]

Sorry to be a pest about CHANGELOG.

Style checker failed too. Doc uses indexes :(

[dblock]

Merged.

Would you have a bit of time to break up the long test into snapshot/restore/index.yaml for basic scenarios restore/rename.yaml, etc.? This way each stands alone as an example that can be reused in the appropriate documentation.

[dblock]

If this refers to a variable (indices) then quoting it will work, so I think this means indices.