Skip to content
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

Add spec for opensearch phone plugin. #610

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dblock
Copy link
Member

@dblock dblock commented Oct 11, 2024

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.

rursprung and others added 3 commits October 11, 2024 18:48
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]>
@dblock dblock changed the title Rursprung add spec for opensearch phone plugin Add spec for opensearch phone plugin. Oct 11, 2024
Copy link
Contributor

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
Copy link
Member Author

dblock commented Oct 23, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants