Standardize Task Execution Restful APIs

[cppwfs]

Rest api's use request params as strings for arguments and options for transport. Java api use maps which are then converted to strings for transport and re-converted back to maps on a server side.

In this case let's pick a standard and remove the duplication of work.

[jvalkeal]

I was thinking to do same as in streams, i.e. for task launch:

POST /tasks/executions/{taskName}

{
  properties: {
    "key1: "value1",
    "key2: "value2"
  },
  arguments: [
    "arg1",
    "arg2"
  ]
}

[jvalkeal]

That above idea doesn't really work as we currently have:

#launch
POST /tasks/executions?name=&properties=&arguments=

#stop
POST /tasks/executions/1

#list
GET /tasks/executions

#details
GET /tasks/executions/1

#delete
DELETE /tasks/executions/1,2?action=CLEANUP,REMOVE_DATA

#count
GET /tasks/executions/current

[siddhantsorann]

Hey, @jvalkeal @cppwfs I'd like to help out here if this is still up for grabs. Would like some more context if possible though.

[jvalkeal]

This would need a proper design as what I outlined above was just idea. Not sure if there should be a totally new controller to setup new rest paths as trying to make existing controller more clean may be difficult.

[siddhantsorann]

I think a fresh new design and controller should be a good approach for this. I have experience with controllers and APIs and would like to help out with the design part as well if that's possible.

[sabbyanandan]

Hi, @siddhantsorann. We will have to think about not breaking the API contracts with the new design, though. A new major release (3.0) of SCDF is not in the pipeline anytime soon, so we will have to work with the minor release boundary, and that means no breaking changes. Also, I am wondering whether if we can do this for Task APIs first, and incrementally move to other primitives in SCDF (streams, audit, etc.) — there are many foundation bits that might either prohibit or help — not fully sure myself.

FWIW, we are working through the 2.8.x backlog right now, so if you see this a fit, feel free to share your design proposal in a shared document, so we can review and iterate on it more easily.

Thank you for your continued interest!