Add spec for opensearch phone plugin.

.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'
+            tests: plugins/analysis
           - version: 2.17.0
             tests: plugins/streaming
           - version: 2.17.0

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))
 
 ### Changed
 
@@ -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))
 
 ### Security
 

spec/namespaces/snapshot.yaml

@@ -408,23 +408,12 @@ components:
           schema:
             type: object
             properties:
-              responses:
-                type: array
-                items:
-                  $ref: '../schemas/snapshot.get.yaml#/components/schemas/SnapshotResponseItem'
               snapshots:
                 type: array
                 items:
                   $ref: '../schemas/snapshot._common.yaml#/components/schemas/SnapshotInfo'
-              total:
-                description: The total number of snapshots that match the request when ignoring size limit or after query parameter.
-                type: number
-              remaining:
-                description: The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.
-                type: number
             required:
-              - remaining
-              - total
+              - snapshots
     snapshot.get_repository@200:
       content:
         application/json:

spec/schemas/_common.analysis.yaml

@@ -27,6 +27,7 @@ components:
         - $ref: '#/components/schemas/DutchAnalyzer'
         - $ref: '#/components/schemas/SmartcnAnalyzer'
         - $ref: '#/components/schemas/CjkAnalyzer'
+        - $ref: '#/components/schemas/PhoneAnalyzer'
     CustomAnalyzer:
       type: object
       properties:
@@ -367,6 +368,17 @@ components:
           $ref: '#/components/schemas/StopWords'
         stopwords_path:
           type: string
+    PhoneAnalyzer:
+      type: object
+      properties:
+        type:
+          type: string
+          enum:
+            - phone
+            - phone-search
+        phone-region:
+          type: string
+          description: Optional ISO 3166 country code, defaults to "ZZ" (unknown region).
     CharFilter:
       oneOf:
         - title: name

spec/schemas/snapshot._common.yaml

@@ -31,16 +31,14 @@ components:
           type: array
           items:
             $ref: '_common.yaml#/components/schemas/IndexName'
-        index_details:
-          type: object
-          additionalProperties:
-            $ref: '#/components/schemas/IndexDetails'
         metadata:
           $ref: '_common.yaml#/components/schemas/Metadata'
+        pinned_timestamp:
+          $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis'
         reason:
           type: string
-        repository:
-          $ref: '_common.yaml#/components/schemas/Name'
+        remote_store_index_shallow_copy:
+          type: boolean
         snapshot:
           $ref: '_common.yaml#/components/schemas/Name'
         shards:
@@ -57,10 +55,6 @@ components:
           $ref: '_common.yaml#/components/schemas/VersionString'
         version_id:
           $ref: '_common.yaml#/components/schemas/VersionNumber'
-        feature_states:
-          type: array
-          items:
-            $ref: '#/components/schemas/InfoFeatureState'
       required:
         - data_streams
         - snapshot
@@ -83,31 +77,6 @@ components:
         - reason
         - shard_id
         - status
-    IndexDetails:
-      type: object
-      properties:
-        shard_count:
-          type: number
-        size:
-          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
-        size_in_bytes:
-          $ref: '_common.yaml#/components/schemas/ByteCount'
-        max_segments_per_shard:
-          type: number
-      required:
-        - max_segments_per_shard
-        - shard_count
-        - size_in_bytes
-    InfoFeatureState:
-      type: object
-      properties:
-        feature_name:
-          type: string
-        indices:
-          $ref: '_common.yaml#/components/schemas/Indices'
-      required:
-        - feature_name
-        - indices
     Repository:
       type: object
       properties:

tests/plugins/analysis/Dockerfile

@@ -0,0 +1,9 @@
+ARG OPENSEARCH_DOCKER_HUB_PROJECT
+ARG OPENSEARCH_VERSION
+ARG OPENSEARCH_DOCKER_REF
+
+FROM ${OPENSEARCH_DOCKER_HUB_PROJECT}/opensearch:${OPENSEARCH_VERSION}${OPENSEARCH_DOCKER_REF}
+
+# 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

tests/plugins/analysis/docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3'
+
+services:
+  opensearch-cluster:
+    build:
+      context: .
+      args:
+        - OPENSEARCH_DOCKER_HUB_PROJECT=${OPENSEARCH_DOCKER_HUB_PROJECT:-opensearchproject}
+        - OPENSEARCH_DOCKER_REF=${OPENSEARCH_DOCKER_REF}
+        - OPENSEARCH_VERSION=${OPENSEARCH_VERSION:-latest}
+    ports:
+      - 9200:9200
+      - 9600:9600
+    environment:
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_PASSWORD:-myStrongPassword123!}
+      - OPENSEARCH_JAVA_OPTS=${OPENSEARCH_JAVA_OPTS}
+      - discovery.type=single-node

tests/plugins/analysis/indices/analyze/analyzer/phone.yaml

@@ -0,0 +1,36 @@
+$schema: ../../../../../json_schemas/test_story.schema.yaml
+
+description: Test /{index}/_analyze for the phone and phone-search analyzers.
+prologues:
+  - path: /example-phone
+    method: PUT
+    request:
+      payload:
+        settings:
+          index:
+            analysis:
+              analyzer:
+                phone-ch:
+                  type: phone
+                  phone-region: CH
+                phone-search-ch:
+                  type: phone-search
+                  phone-region: CH
+epilogues:
+  - path: /example-phone
+    method: DELETE
+    status: [200, 404]
+chapters:
+  - synopsis: Analyze phone number.
+    path: /{index}/_analyze
+    method: POST
+    parameters:
+      index: example-phone
+    request:
+      payload:
+        text: +41 60 555 12 34
+    response:
+      status: 200
+      payload:
+        tokens:
+          - token: 605551234

tests/snapshot/snapshot/snapshot.yaml

@@ -0,0 +1,79 @@
+$schema: ../../../json_schemas/test_story.schema.yaml
+
+description: Test _snapshot/{repository}/snapshot endpoints.
+epilogues:
+  - path: /_snapshot/{repository}/{snapshot}
+    method: DELETE
+    status: [200, 404]
+    parameters:
+      repository: my-fs-repository
+      snapshot: my-test-snapshot
+  - path: /_snapshot/{repository}
+    method: DELETE
+    status: [200, 404]
+    parameters:
+      repository: my-fs-repository
+prologues:
+  - path: /_snapshot/{repository}
+    method: PUT
+    parameters:
+      repository: my-fs-repository
+    request:
+      payload:
+        type: fs
+        settings:
+          location: /tmp/opensearch/repo
+chapters:
+  - synopsis: Get information about a repository.
+    path: /_snapshot/{repository}
+    method: GET
+    parameters:
+      repository: my-fs-repository
+    response:
+      status: 200
+      payload:
+        my-fs-repository:
+          type: fs
+          settings:
+            location: /tmp/opensearch/repo
+  - synopsis: Create a snapshot.
+    path: /_snapshot/{repository}/{snapshot}
+    method: PUT
+    parameters:
+      repository: my-fs-repository
+      snapshot: my-test-snapshot
+      wait_for_completion: true
+    request:
+      payload:
+        indices: '*'
+        ignore_unavailable: true
+        include_global_state: false
+        partial: true
+    response:
+      status: 200
+      payload:
+        snapshot:
+          snapshot: my-test-snapshot       
+  - synopsis: Get information about a snapshot.
+    path: /_snapshot/{repository}/{snapshot}
+    method: GET
+    parameters:
+      repository: my-fs-repository
+      snapshot: my-test-snapshot
+    response:
+      status: 200
+      payload:
+        snapshots:
+          - snapshot: my-test-snapshot
+  - synopsis: Get information about a snapshot with human-readable parameter.
+    path: /_snapshot/{repository}/{snapshot}
+    method: GET
+    parameters:
+      repository: my-fs-repository
+      snapshot: my-test-snapshot
+      human: true
+    response:
+      status: 200
+      payload:
+        snapshots:
+          - snapshot: my-test-snapshot