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.

[github-actions]

Changes Analysis

Commit SHA: fccd6a5
Comparing To SHA: 99bc701

API Changes

Summary

└─┬Paths
  └─┬/_snapshot/{repository}/{snapshot}/_restore
    └─┬POST
      └─┬Requestbody
        └─┬application/json
          └─┬Schema
            ├──[➕] properties (26730:15)
            └──[➕] properties (26732:15)

Document Element	Total Changes	Breaking Changes
paths	2	0

• Total Changes: 2
• Additions: 2

Report

The full API changes report is available at: https:/opensearch-project/opensearch-api-specification/actions/runs/11373857376/artifacts/2066074581

API Coverage

	Before	After	Δ
Covered (%)	588 (57.59 %)	588 (57.59 %)	0 (0 %)
Uncovered (%)	433 (42.41 %)	433 (42.41 %)	0 (0 %)
Unknown	29	29	0