Completed ISM specs and tests. #578

dblock · 2024-09-15T11:31:52Z

Description

Completed ISM specs and tests.

Issues Resolved

Closes #224.

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 · 2024-09-15T11:34:15Z

Spec Test Coverage Analysis

Total	Tested
496	302 (60.89 %)

github-actions · 2024-09-15T12:09:04Z

Changes Analysis

Commit SHA: f746a39
Comparing To SHA: d4d4fa9

API Changes

Summary

├─┬Paths
│ ├──[➕] path (12229:3)
│ ├──[➕] path (3999:3)
│ ├──[➕] path (3818:3)
│ ├──[➕] path (12055:3)
│ ├──[➕] path (3740:3)
│ ├──[➕] path (11995:3)
│ ├──[➕] path (11874:3)
│ ├──[➕] path (12034:3)
│ ├──[➕] path (11794:3)
│ ├──[➕] path (4034:3)
│ ├──[➕] path (4053:3)
│ ├──[➕] path (3890:3)
│ ├──[➕] path (11708:3)
│ ├──[➕] path (11751:3)
│ ├──[➕] path (5035:3)
│ ├──[➕] path (3779:3)
│ ├─┬/_plugins/_ism/remove/{index}
│ │ └─┬POST
│ │   ├──[🔀] operationId (4018:20)❌ 
│ │   └─┬Parameters
│ │     ├──[➖] style (20486:14)
│ │     └──[🔀] in (21014:11)❌ 
│ ├─┬/_plugins/_ism/change_policy/{index}
│ │ └─┬POST
│ │   ├──[🔀] operationId (3800:20)❌ 
│ │   └─┬Parameters
│ │     ├──[➖] style (20434:14)
│ │     └──[🔀] in (20916:11)❌ 
│ ├─┬/_opendistro/_ism/add/{index}
│ │ └─┬POST
│ │   ├──[🔀] operationId (11731:20)❌ 
│ │   └─┬Parameters
│ │     ├──[➖] style (20424:14)
│ │     └──[🔀] in (20897:11)❌ 
│ ├─┬/_opendistro/_ism/policies/{policyID}
│ │ ├──[➕] head (11934:7)
│ │ └─┬GET
│ │   ├──[🔀] description (11918:20)
│ │   └─┬External Docs
│ │     └──[🔀] url (11920:14)
│ ├─┬/_plugins/_ism/add/{index}
│ │ └─┬POST
│ │   ├──[🔀] operationId (3761:20)❌ 
│ │   └─┬Parameters
│ │     ├──[➖] style (20424:14)
│ │     └──[🔀] in (20897:11)❌ 
│ ├─┬/_opendistro/_ism/change_policy/{index}
│ │ └─┬POST
│ │   ├──[🔀] operationId (11774:20)❌ 
│ │   └─┬Parameters
│ │     ├──[➖] style (20434:14)
│ │     └──[🔀] in (20916:11)❌ 
│ ├─┬/_opendistro/_ism/explain/{index}
│ │ ├──[➕] post (11855:7)
│ │ └─┬GET
│ │   ├──[➕] requestBody (25499:7)❌ 
│ │   ├──[🔀] description (11837:20)
│ │   ├──[🔀] operationId (11835:20)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-operation-group (11836:26)
│ ├─┬/_plugins/_ism/explain/{index}
│ │ ├──[➕] post (3873:7)
│ │ └─┬GET
│ │   ├──[➕] requestBody (25499:7)❌ 
│ │   ├──[🔀] description (3857:20)
│ │   ├──[🔀] operationId (3855:20)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-operation-group (3856:26)
│ ├─┬/_opendistro/_ism/remove/{index}
│ │ └─┬POST
│ │   ├──[🔀] operationId (12016:20)❌ 
│ │   └─┬Parameters
│ │     ├──[➖] style (20486:14)
│ │     └──[🔀] in (21014:11)❌ 
│ └─┬/_plugins/_ism/policies/{policy_id}
│   ├──[➕] head (3960:7)
│   └─┬GET
│     ├──[🔀] description (3946:20)
│     └─┬External Docs
│       └──[🔀] url (3948:14)
└─┬Components
  ├──[➕] responses (27918:7)
  ├──[➕] responses (27966:7)
  ├──[➕] responses (27922:7)
  ├──[➕] responses (27956:7)
  ├──[➕] responses (27941:7)
  ├──[➖] responses (27351:7)❌ 
  ├──[➕] responses (27931:7)
  ├──[➕] responses (27926:7)
  ├──[➕] requestBodies (25503:7)
  ├──[➕] requestBodies (25513:7)
  ├──[➕] requestBodies (25499:7)
  ├──[➖] parameters (20442:7)❌ 
  ├──[➕] parameters (20959:7)
  ├──[➕] parameters (20930:7)
  ├──[➕] parameters (20966:7)
  ├──[➕] parameters (20936:7)
  ├──[➕] parameters (21022:7)
  ├──[➕] parameters (20896:7)
  ├──[➕] parameters (20952:7)
  ├──[➕] parameters (21013:7)
  ├──[➕] parameters (21032:7)
  ├──[➕] parameters (20915:7)
  ├──[➕] parameters (20993:7)
  ├──[➕] schemas (49862:7)
  ├──[➕] schemas (49903:7)
  ├──[➕] schemas (49885:7)
  ├──[➕] schemas (49788:7)
  ├──[➕] schemas (49706:7)
  ├──[➕] schemas (49876:7)
  ├──[➕] schemas (49896:7)
  └─┬ism._common:GetPolicyResponse
    └──[🔀] $ref (49797:13)❌

Document Element	Total Changes	Breaking Changes
paths	50	16
components	31	3

❌ BREAKING Changes: 19 out of 81
Modifications: 23
Removals: 8
Additions: 50
Breaking Removals: 2
Breaking Modifications: 15
Breaking Additions: 2

Report

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

API Coverage

	Before	After	Δ
Covered (%)	560 (54.85 %)	584 (57.2 %)	24 (2.35 %)
Uncovered (%)	461 (45.15 %)	437 (42.8 %)	-24 (-2.35 %)
Unknown	25	25	0

spec/namespaces/ism.yaml

nhtruong · 2024-09-16T15:50:00Z

spec/namespaces/ism.yaml

+  /_plugins/_ism/add:
+    post:
+      operationId: ism.add.0
+      x-operation-group: ism.add


This should be in the same group as ism.add_policy similar to {index}/_search and /_search

Same as for change_policy they have different parameters, one specifies the index in the query, the other in the path.

nhtruong · 2024-09-16T15:50:34Z

spec/namespaces/ism.yaml

+  /_plugins/_ism/remove:
+    post:
+      operationId: ism.remove.0
+      x-operation-group: ism.remove


This should be in the same group as ism.remove_policy

Same as for change_policy they have different parameters, one specifies the index in the query, the other in the path.

That's correct. But as far as the clients users are concerned, which is what the operation group is for, where the index param is put in the URL request is irrelevant. We have many API actions, like search, that also allows the index to be specified as either a path param or a query param, the generated clients will favor use it as a path param regardless. In a generated client, client.ism.remove and client.ism_remove_policy will pretty much be identical to each other and it will lead to confusion.

Ok, I had to add query to the one that doesn't really take it, but it won't matter from the client POV I think.

nhtruong · 2024-09-16T15:51:00Z

spec/namespaces/ism.yaml

+  /_plugins/_ism/change_policy:
+    post:
+      operationId: ism.change.0
+      x-operation-group: ism.change


This should be in the same group as ism.change_policy

But they have different parameters, one specifies the index in the query, the other in the path. So if you try to make them the same group you get this:

{ file: 'namespaces/ism.yaml', location: 'Operation Group: ism.change_policy', message: "2 'ism.change_policy' operations must have an identical set of query parameters." }

I'm pretty sure you can still have index as a query string in the one that already accepts index in path, and the query string param will be ignored just like other API actions that allow this.

spec/namespaces/ism.yaml

Added HEAD /_plugins/_ism/policies/{policy_id}. Added GET /_plugins/_ism/explain. Added /_plugins/refresh_search_analyzers. Added /_plugins/_ism/retry/{index}. Signed-off-by: dblock <dblock@amazon.com>

Signed-off-by: dblock <dblock@amazon.com>

dblock force-pushed the ism-misc branch from 2f69c22 to 3d48533 Compare September 15, 2024 12:06

dblock force-pushed the ism-misc branch from 3d48533 to df6d5c5 Compare September 15, 2024 12:09

dblock marked this pull request as ready for review September 15, 2024 12:12

dblock requested review from harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners September 15, 2024 12:12

This was referenced Sep 15, 2024

[FEATURE] Add specs for ism namespace #224

Closed

[BUG] PUT /_plugins/_ism/policies requires a non-standard argument policyID opensearch-project/index-management#1254

Open

dblock force-pushed the ism-misc branch 4 times, most recently from 5c5fb2e to 5fcbc26 Compare September 15, 2024 14:41

nhtruong reviewed Sep 16, 2024

View reviewed changes

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

nhtruong reviewed Sep 16, 2024

View reviewed changes

spec/namespaces/ism.yaml Show resolved Hide resolved

nhtruong reviewed Sep 16, 2024

View reviewed changes

spec/namespaces/ism.yaml Show resolved Hide resolved

dblock force-pushed the ism-misc branch from 5fcbc26 to 3b62f4e Compare September 16, 2024 16:44

dblock added 4 commits September 17, 2024 09:41

Added GET /_plugins/_ism/policies.

e8d0a06

Added HEAD /_plugins/_ism/policies/{policy_id}. Added GET /_plugins/_ism/explain. Added /_plugins/refresh_search_analyzers. Added /_plugins/_ism/retry/{index}. Signed-off-by: dblock <dblock@amazon.com>

Added alternative routes that don't take policy or index in the URL.

6d0ee13

Signed-off-by: dblock <dblock@amazon.com>

Added missing verbs to /_opendistro/_ism/explain.

fdef15d

Signed-off-by: dblock <dblock@amazon.com>

Consolidated method IDs.

f746a39

Signed-off-by: dblock <dblock@amazon.com>

dblock force-pushed the ism-misc branch from 3b62f4e to f746a39 Compare September 17, 2024 13:52

dblock requested a review from nhtruong September 17, 2024 13:55

nhtruong approved these changes Sep 17, 2024

View reviewed changes

nhtruong merged commit 3d49360 into opensearch-project:main Sep 17, 2024
18 checks passed

dblock deleted the ism-misc branch September 18, 2024 10:24

dblock added a commit to dblock/opensearch-api-specification that referenced this pull request Sep 23, 2024

Completed ISM specs and tests. (opensearch-project#578)

1de4b10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Completed ISM specs and tests. #578

Completed ISM specs and tests. #578

dblock commented Sep 15, 2024 •

edited

Loading

github-actions bot commented Sep 15, 2024 •

edited

Loading

github-actions bot commented Sep 15, 2024 •

edited

Loading

nhtruong Sep 16, 2024

dblock Sep 16, 2024

nhtruong Sep 16, 2024

dblock Sep 16, 2024

nhtruong Sep 16, 2024 •

edited

Loading

dblock Sep 17, 2024

nhtruong Sep 16, 2024 •

edited

Loading

dblock Sep 16, 2024

nhtruong Sep 16, 2024 •

edited

Loading

dblock Sep 17, 2024

Completed ISM specs and tests. #578

Completed ISM specs and tests. #578

Conversation

dblock commented Sep 15, 2024 • edited Loading

Description

Issues Resolved

github-actions bot commented Sep 15, 2024 • edited Loading

Spec Test Coverage Analysis

github-actions bot commented Sep 15, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

nhtruong Sep 16, 2024

Choose a reason for hiding this comment

dblock Sep 16, 2024

Choose a reason for hiding this comment

nhtruong Sep 16, 2024

Choose a reason for hiding this comment

dblock Sep 16, 2024

Choose a reason for hiding this comment

nhtruong Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

dblock Sep 17, 2024

Choose a reason for hiding this comment

nhtruong Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

dblock Sep 16, 2024

Choose a reason for hiding this comment

nhtruong Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

dblock Sep 17, 2024

Choose a reason for hiding this comment

dblock commented Sep 15, 2024 •

edited

Loading

github-actions bot commented Sep 15, 2024 •

edited

Loading

github-actions bot commented Sep 15, 2024 •

edited

Loading

nhtruong Sep 16, 2024 •

edited

Loading

nhtruong Sep 16, 2024 •

edited

Loading

nhtruong Sep 16, 2024 •

edited

Loading