Add spec for opensearch phone plugin. #610

dblock · 2024-10-11T18:50:50Z

Description

Describe what this change achieves.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

this is part of opensearch-project/OpenSearch#11326. the actual implementation was done opensearch-project/OpenSearch#15915. see the commit message on the PR for further details. the new test group `analysis` has been added so that it can later be extended with all other optional language analyzers (which are currently also not covered). note that the CI currently needs to fetch the image from `opensearchstaging` as 2.18.0 hasn't been released yet. the `hub` and `ref` config can be removed once 2.18.0 has been released. Signed-off-by: Ralph Ursprung <[email protected]>

* fix spec snapshot endpoint Signed-off-by: Tatsuya Kawakami <[email protected]> * fix lint and add changelog Signed-off-by: Tatsuya Kawakami <[email protected]> --------- Signed-off-by: Tatsuya Kawakami <[email protected]>

Signed-off-by: dblock <[email protected]>

github-actions · 2024-10-11T18:53:04Z

Changes Analysis

Commit SHA: ff187df
Comparing To SHA: 49b7c68

API Changes

Summary

├─┬Paths
│ └─┬/_snapshot/{repository}/{snapshot}
│   └─┬GET
│     └─┬Responses
│       └─┬200
│         └─┬application/json
│           └─┬Schema
│             ├──[➕] required (29743:17)❌ 
│             ├──[➖] required (29753:17)❌ 
│             ├──[➖] required (29754:17)❌ 
│             ├──[➖] properties (29749:15)❌ 
│             ├──[➖] properties (29738:15)❌ 
│             └──[➖] properties (29746:15)❌ 
└─┬Components
  ├──[➖] schemas (55111:7)❌ 
  ├──[➖] schemas (55096:7)❌ 
  ├──[➖] schemas (55376:7)❌ 
  ├──[➕] schemas (36963:7)
  ├─┬_common.analysis:Analyzer
  │ ├──[➕] oneOf (36187:7)
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36963:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (35955:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36859:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37213:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37129:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36028:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36390:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37269:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36106:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36593:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37118:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (35883:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (37158:13)❌ 
  │ ├─┬ONEOF
  │ │ └──[🔀] $ref (36447:13)❌ 
  │ └─┬ONEOF
  │   └──[🔀] $ref (36766:13)❌ 
  └─┬snapshot._common:SnapshotInfo
    ├──[➖] properties (55277:9)❌ 
    ├──[➖] properties (55251:9)❌ 
    └──[➖] properties (55259:9)❌

Document Element	Total Changes	Breaking Changes
paths	6	6
components	23	21

❌ BREAKING Changes: 27 out of 29
Modifications: 15
Removals: 11
Additions: 3
Breaking Removals: 11
Breaking Modifications: 15
Breaking Additions: 1

Report

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

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

dblock · 2024-10-23T15:55:33Z

The approach in this PR is not ideal, waiting on opensearch-project/OpenSearch#16219 and/or opensearch-project/opensearch-build#5096.

dblock

Looks like some unrelated snapshot changes snuck in here, rebase, see other comments.

dblock · 2024-11-07T14:16:21Z

CHANGELOG.md

@@ -102,6 +102,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `404` response for `DELETE /{index}`, `GET /{index}/_doc/{id}`, `DELETE /{index}/_doc/{id}` ([#589](https://github.com/opensearch-project/opensearch-api-specification/pull/589))
 - Added ability to pass `InlineScript` as a simple string ([#605](https://github.com/opensearch-project/opensearch-api-specification/pull/605))
 - Added `config_id` and `config_id_list` to `/_plugins/_notifications/configs` query parameters ([#594](https://github.com/opensearch-project/opensearch-api-specification/pull/594))
+- Added documentation & test for `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))


Suggested change

- Added documentation & test for `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))

- Added `PhoneAnalyzer` from `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))

dblock · 2024-11-07T14:16:33Z

CHANGELOG.md

@@ -176,6 +177,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed inaccurate numeric type ([#597](https://github.com/opensearch-project/opensearch-api-specification/pull/597))([#598](https://github.com/opensearch-project/opensearch-api-specification/pull/598))([#600](https://github.com/opensearch-project/opensearch-api-specification/pull/600))
 - Fixed mapping and analysis types ([#600](https://github.com/opensearch-project/opensearch-api-specification/pull/600))
 - Fixed `RestStatus` responses in `DELETE /_plugins/_notifications/configs/{config_id}` ([#594](https://github.com/opensearch-project/opensearch-api-specification/pull/594))
+- Fixed `GET /_snapshot_/{repository}/{snapshot}` ([#608](https://github.com/opensearch-project/opensearch-api-specification/pull/608))


This seems unrelated, rebase.

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

tests/plugins/analysis/Dockerfile

+
+# when updating, get the latest/corresponding stable URL with
+# curl -v https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/2.18.0/latest/linux/x64/tar/builds/opensearch/core-plugins/analysis-phonenumber-2.18.0.zip
+RUN ./bin/opensearch-plugin install https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/2.18.0/10380/linux/x64/tar/builds/opensearch/core-plugins/analysis-phonenumber-2.18.0.zip


Is there a permalink where we can use ${OPENSEARCH_VERSION} only without a build number? This way when we move from 2.18 to 2.19 it works without an update.

dblock · 2024-11-07T14:19:07Z

.github/workflows/test-spec.yml

@@ -36,6 +36,10 @@ jobs:
            tests: routing
          - version: 2.16.0
            tests: snapshot
+          - version: 2.18.0
+            hub: opensearchstaging
+            ref: '@sha256:f311da085b968663fadf041bafc78b24dc21556f0726e625caf3560f7323a020'


Remove SHA, this is a released version.

dblock · 2024-11-07T14:20:02Z

I thought I was reviewing Ralph's PR, instead commented on my own 🤦

rursprung and others added 3 commits October 11, 2024 18:48

fix spec snapshot endpoint (opensearch-project#608)

0db35f6

* fix spec snapshot endpoint Signed-off-by: Tatsuya Kawakami <[email protected]> * fix lint and add changelog Signed-off-by: Tatsuya Kawakami <[email protected]> --------- Signed-off-by: Tatsuya Kawakami <[email protected]>

Install analysis-phonenumber.

ff187df

Signed-off-by: dblock <[email protected]>

dblock changed the title ~~Rursprung add spec for opensearch phone plugin~~ Add spec for opensearch phone plugin. Oct 11, 2024

dblock mentioned this pull request Oct 23, 2024

[Feature] Publish plugins SNAPSHOT artifacts (along with SNASPHOT distribution) opensearch-project/opensearch-build#5096

Closed

dblock commented Nov 7, 2024

View reviewed changes

dblock closed this Nov 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add spec for opensearch phone plugin. #610

Add spec for opensearch phone plugin. #610

dblock commented Oct 11, 2024

github-actions bot commented Oct 11, 2024

dblock commented Oct 23, 2024

dblock left a comment

dblock Nov 7, 2024

dblock Nov 7, 2024

dblock Nov 7, 2024

dblock Nov 7, 2024

dblock commented Nov 7, 2024

	- Added documentation & test for `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))
	- Added `PhoneAnalyzer` from `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))

Add spec for opensearch phone plugin. #610

Add spec for opensearch phone plugin. #610

Conversation

dblock commented Oct 11, 2024

Description

Issues Resolved

github-actions bot commented Oct 11, 2024

Changes Analysis

API Changes

Summary

Report

API Coverage

dblock commented Oct 23, 2024

dblock left a comment

Choose a reason for hiding this comment

dblock Nov 7, 2024

Choose a reason for hiding this comment

dblock Nov 7, 2024

Choose a reason for hiding this comment

dblock Nov 7, 2024

Choose a reason for hiding this comment

dblock Nov 7, 2024

Choose a reason for hiding this comment

dblock commented Nov 7, 2024