opensearch-project / opensearch-project/flow-framework

[FEATURE] Enhance ease of adding additional defaults to code

Open
#584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
62
Forks
66
Avg merge
3d 20h
Merged PRs (30d)
20

Description

Is your feature request related to a problem?

Currently for 2.13, in order to add a new default file that is attached to a use case we need to add the json file and also add the use case to an enum. This isn't too user friendly as outside users have to add this in multiple different locations. We can also explore a way to more efficiently add these defaults templates through an API for the customer to easily have their own templates in there own cluster.

What solution would you like?

Potential options are having the defaults and template all in one place, but this would still require an enum to be edited on every new template.

Having an enum also has its benefits like more likely stopping errors when a usecase name isn't attached to a file or vice versa ahead of time. We could also focus more on enhancing adding new default templates on a customer's individual cluster through an API.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating the enum and JSON default-template registration for the 2.13 defaults, then inspect the existing customer-facing APIs before choosing between centralizing templates and adding cluster-level template management. Done is not defined because the issue presents multiple possible solutions without acceptance criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.