[FEATURE] Add specs for `knn` namespace

opensearch-project / opensearch-api-specification

API specification for OpenSearch

Apache License 2.0

28 stars 29 forks source link

[FEATURE] Add specs for `knn` namespace #226

Open nhtruong opened 2 months ago

nhtruong commented 2 months ago

Part of Adding missing API specs issue

[ ] /_opendistro/_knn/stats/: ["GET"]
[ ] /_opendistro/_knn/stats/{stat}: ["GET"]
[ ] /_opendistro/_knn/warmup/{index}: ["GET"]
[ ] /_opendistro/_knn/{nodeId}/stats/: ["GET"]
[ ] /_opendistro/_knn/{nodeId}/stats/{stat}: ["GET"]

nhtruong commented 2 months ago

@vamshin @navneet1v, Would you mind assigning this Issue to the appropriate person? Thank you.

navneet1v commented 2 months ago

@nhtruong based on this comment from @dblock do we still need to add api specs for these urls?

dblock commented 2 months ago

I should probably take that back, what's the correct way to add and mark these deprecated? And is there a way to provide aliases since these are identical to other _knn APIs?

nhtruong commented 2 months ago

Just responded https://github.com/opensearch-project/opensearch-api-specification/issues/168#issuecomment-2062135294

@navneet1v, if these endpoints are identical to the _plugins counterparts (minus the fact they are deprecated), then our tools will handle it. If not, you'll have to redefine them. For this ticket, would you mind going over the _plugins/knn/ endpoints to make sure that they are correct?