opensearch-project / opensearch-project/OpenSearch
Modularize search pipelines APIs
Open
Nobody has claimed this yet.
Plugins
Search
- Dominant language
- Java
- Stars
- 13.7k
- Forks
- 3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 108
Description
As called out by @andrross in https://github.com/opensearch-project/OpenSearch/pull/7283, we've been inconsistent between what parts of the search pipeline API are internal and what parts are designed for consumption by plugin developers.
We should annotate classes that are part of the plugin interface with @opensearch.api, while the internal implementation details are annotated with @opensearch.internal. The API classes should (probably?) be moved into a separate Java package, like org.opensearch.search.pipeline.api.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.