opensearch-project / opensearch-project/flow-framework

[FEATURE] Enhance status API with template in response

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

Nobody has claimed this yet.

backlog 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?

The status API should be enhanced to also return the full template from the GC index upon using the all=true param query

What solution would you like?

I already implemented a part of the solution by having the ability to combine the workflowState and Template object, now currently it just requires doing the fetch on both indices and being able to convert the user correctly to json, there is a TODO for this in the code.

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

Start at the status API implementation and locate the TODO concerning conversion of the combined workflowState and Template object to JSON. Trace how the workflow-state and GC indices are fetched for the all=true query. Done means the response includes the full template from the GC index and the combined user data serializes correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.