Add spec for new rename_alias_pattern and rename_alias_replacement parameters to snapshot restore by mispencer · Pull Request #615 · opensearch-project/opensearch-api-specification

mispencer · 2024-10-16T16:31:35Z

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 · 2024-10-16T16:33:30Z

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

dblock

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

dblock · 2024-10-16T18:27:42Z

tests/snapshot/snapshot/restore.yaml

+  - path: /stories
+    method: DELETE
+    status: [200, 404]
+  - path: /new_stories


We should call it something meaningful, maybe tales?

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

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"?

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.

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.

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

github-actions · 2024-10-16T18:55:50Z

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 · 2024-10-24T18:26:22Z

This feature has been merged.

dblock · 2024-10-24T18:56:31Z

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.

spec/namespaces/snapshot.yaml

dblock · 2024-11-07T14:37:17Z

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

mispencer · 2024-11-17T18:19:35Z

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.

spec/namespaces/snapshot.yaml

dblock · 2024-11-18T19:29:42Z

tests/snapshot/snapshot/restore.yaml

    retry:
-      count: 3
+      count: 3
+  - synopsis: Restore snapshot with rename_pattern and rename_replacement.


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 · 2024-11-18T19:31:21Z

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 :(

CHANGELOG.md

…rameters to snapshot restore Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

…Add missing parameters. Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

dblock · 2024-11-23T02:48:40Z

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 · 2024-11-23T02:49:16Z

spec/namespaces/snapshot.yaml

            properties:
              ignore_unavailable:
-                description: If `true`, the request ignores data streams and indexes in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.
+                description: If `true`, the request ignores data streams and indexes in `indexes` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.


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

mispencer requested review from Tokesh, VachaShah, Xtansia, aabeshov, dblock, harshavamsi, nhtruong and sachetalva as code owners October 16, 2024 16:31

mispencer marked this pull request as draft October 16, 2024 16:32

mispencer mentioned this pull request Oct 16, 2024

Add new parameters to snapshot restore to rename the restored aliases… opensearch-project/OpenSearch#16292

Merged

3 tasks

dblock suggested changes Oct 16, 2024

View reviewed changes

mispencer force-pushed the AliasRenameSnapshotRestore branch from eadc2f8 to b18145d Compare October 16, 2024 21:00

mispencer force-pushed the AliasRenameSnapshotRestore branch from fccd6a5 to 5bedafa Compare October 24, 2024 18:12

mispencer marked this pull request as ready for review October 24, 2024 18:22

dblock reviewed Oct 24, 2024

View reviewed changes

spec/namespaces/snapshot.yaml Show resolved Hide resolved

mispencer force-pushed the AliasRenameSnapshotRestore branch from f5ccefb to 0050767 Compare November 17, 2024 18:18

dblock reviewed Nov 18, 2024

View reviewed changes

spec/namespaces/snapshot.yaml Outdated Show resolved Hide resolved

dblock reviewed Nov 18, 2024

View reviewed changes

dblock suggested changes Nov 18, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

mispencer added 4 commits November 22, 2024 14:15

Add spec for new rename_alias_pattern and rename_alias_replacement pa…

96878b5

…rameters to snapshot restore Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Lint fixes

5746b63

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Update CHANGELOG

61a69d9

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Add version added

b57cedb

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

mispencer added 5 commits November 22, 2024 14:15

Rename indexes and parameters for better documentation

40b4849

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Lint fixes

1ca62fb

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Restore Snapshot Request: Add description. Remove unknown parameter. …

eef981b

…Add missing parameters. Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Restore Snapshot Request: Add line breaks

e0d620c

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

Rename indices. Add new lines.

3de576d

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

mispencer force-pushed the AliasRenameSnapshotRestore branch from 0ba119d to 4d463bb Compare November 22, 2024 22:20

Move entry in changelog to Unreleased

ab1bec8

Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>

mispencer force-pushed the AliasRenameSnapshotRestore branch from 4d463bb to ab1bec8 Compare November 22, 2024 22:24

dblock approved these changes Nov 23, 2024

View reviewed changes

dblock merged commit 8cb29a4 into opensearch-project:main Nov 23, 2024

dblock reviewed Nov 23, 2024

View reviewed changes

mispencer deleted the AliasRenameSnapshotRestore branch December 11, 2024 17:30

Conversation

mispencer commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Uh oh!

mispencer commented Oct 16, 2024

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

dblock Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

mispencer Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

dblock Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

mispencer Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

dblock Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mispencer Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Analysis

API Changes

Summary

Report

API Coverage

Uh oh!

mispencer commented Oct 24, 2024

Uh oh!

dblock commented Oct 24, 2024

Uh oh!

Uh oh!

dblock commented Nov 7, 2024

Uh oh!

mispencer commented Nov 17, 2024

Uh oh!

Uh oh!

dblock Nov 18, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Spec Test Coverage Analysis

Uh oh!

dblock left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dblock commented Nov 23, 2024

Uh oh!

dblock Nov 23, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mispencer commented Oct 16, 2024 •

edited

Loading

dblock Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 16, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024 •

edited

Loading

dblock left a comment •

edited

Loading