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

Added schema for /_plugins/_knn/stats, /_plugins/_knn/models/{model_id}, _train and _search. #708

Merged
merged 2 commits into from
Dec 10, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Dec 5, 2024

Description

Added schema for /_plugins/_knn/stats, /_plugins/_knn/models/{model_id}, _train and _search.

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.

Copy link
Contributor

github-actions bot commented Dec 5, 2024

Changes Analysis

Commit SHA: af5f033
Comparing To SHA: 807fa8f

API Changes

Summary

├─┬Paths
│ ├─┬/_plugins/_knn/{node_id}/stats/{stat}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └─┬Schema
│ │   │     ├──[➕] enum (22422:15)
│ │   │     ├──[➕] enum (22428:15)
│ │   │     ├──[➕] enum (22417:15)
│ │   │     ├──[➕] enum (22427:15)
│ │   │     ├──[➕] enum (22429:15)
│ │   │     ├──[➕] enum (22426:15)
│ │   │     └──[➕] enum (22425:15)
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29926:11)
│ ├─┬/_opendistro/_knn/{node_id}/stats/{stat}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └─┬Schema
│ │   │     ├──[➕] enum (22426:15)
│ │   │     ├──[➕] enum (22427:15)
│ │   │     ├──[➕] enum (22422:15)
│ │   │     ├──[➕] enum (22428:15)
│ │   │     ├──[➕] enum (22425:15)
│ │   │     ├──[➕] enum (22417:15)
│ │   │     └──[➕] enum (22429:15)
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29926:11)
│ ├─┬/_plugins/_knn/stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29926:11)
│ ├─┬/_plugins/_knn/models/{model_id}
│ │ └─┬DELETE
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29908:11)
│ ├─┬/_plugins/_knn/{node_id}/stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29926:11)
│ ├─┬/_plugins/_knn/models/_search
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬200
│ │ │     └──[➕] content (29920:11)
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29920:11)
│ ├─┬/_plugins/_knn/stats/{stat}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └─┬Schema
│ │   │     ├──[➕] enum (22422:15)
│ │   │     ├──[➕] enum (22417:15)
│ │   │     ├──[➕] enum (22427:15)
│ │   │     ├──[➕] enum (22428:15)
│ │   │     ├──[➕] enum (22429:15)
│ │   │     ├──[➕] enum (22425:15)
│ │   │     └──[➕] enum (22426:15)
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29926:11)
│ ├─┬/_plugins/_knn/models/{model_id}/_train
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     ├──[➖] required (27052:17)❌ 
│ │     └──application/json
│ ├─┬/_opendistro/_knn/stats/{stat}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └─┬Schema
│ │   │     ├──[➕] enum (22422:15)
│ │   │     ├──[➕] enum (22425:15)
│ │   │     ├──[➕] enum (22417:15)
│ │   │     ├──[➕] enum (22426:15)
│ │   │     ├──[➕] enum (22428:15)
│ │   │     ├──[➕] enum (22427:15)
│ │   │     └──[➕] enum (22429:15)
│ │   └─┬Responses
│ │     └─┬200
│ │       └──[➕] content (29926:11)
│ └─┬/_plugins/_knn/models/_train
│   └─┬POST
│     └─┬Requestbody
│       ├──[➖] required (27052:17)❌ 
│       └──application/json
└─┬Components
  ├──[➕] schemas (53277:7)
  ├──[➕] schemas (53240:7)
  ├──[➕] schemas (53284:7)
  ├──[➕] schemas (53270:7)
  ├──[➕] schemas (53384:7)
  ├──[➕] schemas (53253:7)
  └──[➕] schemas (53360:7)

Document Element Total Changes Breaking Changes
paths 39 2
components 7 0
  • BREAKING Changes: 2 out of 46
  • Removals: 2
  • Additions: 44
  • Breaking Removals: 2

Report

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

API Coverage

Before After Δ
Covered (%) 606 (59.35 %) 606 (59.35 %) 0 (0 %)
Uncovered (%) 415 (40.65 %) 415 (40.65 %) 0 (0 %)
Unknown 43 43 0

@dblock dblock force-pushed the knn-plugin branch 2 times, most recently from 71d6f23 to 22ca2e8 Compare December 6, 2024 19:25
@dblock dblock changed the title Added support for missing APIs in the k-nn plugin. Added schema for /_plugins/_knn/stats, /_plugins/_knn/models/{model_id}, _train and _search. Dec 6, 2024
@dblock dblock marked this pull request as ready for review December 6, 2024 19:25
Copy link
Contributor

github-actions bot commented Dec 6, 2024

Spec Test Coverage Analysis

Total Tested
536 452 (84.33 %)

Copy link
Collaborator

@Tokesh Tokesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi everyone! I wanted to review a PR in Opensearch for the first time. Everything looks great, but I noticed a couple of things that I have encountered in my PRs.

spec/schemas/knn._common.yaml Outdated Show resolved Hide resolved
spec/schemas/knn._common.yaml Outdated Show resolved Hide resolved
spec/schemas/knn._common.yaml Outdated Show resolved Hide resolved
@dblock dblock force-pushed the knn-plugin branch 4 times, most recently from f1f1010 to 9ba2c30 Compare December 9, 2024 12:26
…l_id}`, `_train` and `_search`.

Signed-off-by: dblock <[email protected]>
@Xtansia Xtansia merged commit 8b9a491 into opensearch-project:main Dec 10, 2024
28 checks passed
@dblock dblock deleted the knn-plugin branch December 10, 2024 02:34
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