-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SnapshotManagement namespace api #701
Conversation
Signed-off-by: alen_abeshov <[email protected]>
Signed-off-by: alen_abeshov <[email protected]>
Changes AnalysisCommit SHA: d265d8d API ChangesSummary
ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12235494772/artifacts/2293472076 API Coverage
|
Spec Test Coverage Analysis
|
Signed-off-by: alen_abeshov <[email protected]>
Not ready yet |
Signed-off-by: alen_abeshov <[email protected]>
Signed-off-by: alen_abeshov <[email protected]>
Now, it is ready for review! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
- Tests aren't running, the
plugins
directory is misleading and is there for custom docker setups and is explicitly added to CI with different configuration. We already have https://github.com/opensearch-project/opensearch-api-specification/tree/main/tests/snapshot, so move the tests in there if there needs to be special setup, otherwise put them indefault/sm
. - Keep naming to the route naming, just like we don't name "ml" as "machine_learning", keep "sm" as is, so "sm._common.yaml", etc.
- Rename the test files to match the routes, so
_sm/policies
becomestests/snapshot/sm/policies.yaml
. - Split tests and group by API not by theme. So
explain
tests should go into their own file with a prologue that creates a policy, then the chapter only calls explain. The file would besm/policies/explain.yaml
,start.yaml
, etc.
…le.Renamed snapshot managment to 'sm' Signed-off-by: alen_abeshov <[email protected]>
@dblock I am not sure what's wrong |
Signed-off-by: alen_abeshov <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good!
What's the failure in 2.0? I see some x-version-added: 2.1
so this means the feature was added in 2.1? Change all tests to do >= 2.1
, but do dig through the history/code to verify which version the feature was added in.
Iterate to green. Spec validation needs to pass, there are a bunch of language things like quoting variables that do matter since we're using these in the docs.
Signed-off-by: alen_abeshov <[email protected]>
Signed-off-by: alen_abeshov <[email protected]>
Signed-off-by: Daniel (dB.) Doubrovkine <[email protected]>
spec/namespaces/sm.yaml
Outdated
operationId: sm.update_policy.0 | ||
x-operation-group: sm.update_policy | ||
x-version-added: '2.1' | ||
description: Updates an existing snapshot management policy. Requires 'if_seq_no' and 'if_primary_term'. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: Updates an existing snapshot management policy. Requires 'if_seq_no' and 'if_primary_term'. | |
description: Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`. |
Description
Adding snapshot management(sm) namespace specs.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [#234 ].
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.