incubator-devlake icon indicating copy to clipboard operation
incubator-devlake copied to clipboard

[Feature][Framework] Add api to verify the pipeline options for the plugin

Open warren830 opened this issue 3 years ago • 4 comments

Search before asking

  • [X] I had searched in the issues and found no similar feature requirement.

Description

We need to add apis to verify pipeline options to let users verify request body before creating blueprint or pipeline

Use case

No response

Related issues

#2449

Are you willing to submit a PR?

  • [X] Yes I am willing to submit a PR!

Code of Conduct

warren830 avatar Aug 18 '22 07:08 warren830

@klesh @warren830 Not sure if I understand the intent based on the description, but it sounds like UI needs to post an additional payload request to "verify" it's data and then send a final post request to blueprints or pipelines? This behavior doesn't seem practical at all for Config-UI, it would be better utilized by Direct API users using Postman and such. Backend should be internally validating the Request payload for each GET, POST and PATCH request and respond accordingly if there is an error.

e2corporation avatar Aug 19 '22 15:08 e2corporation

@e2corporation The intent of this feature is for Documentation's sake, we can't describe all plugins options in a single API endpoint /blueprints because options are plugin specific. As of config-ui, we don't have a plan at this point, it is up to you to determine 😃

klesh avatar Aug 22 '22 07:08 klesh

Is this something we can solve by using a JSON-Schema for these request payloads?

keon94 avatar Aug 30 '22 23:08 keon94

@keon94 Yeah, sure. The problem is we can not put JSON-Schema for all plugins to a "Framework" level API. We need to put them to "Plugin" level API endpoints

klesh avatar Aug 31 '22 01:08 klesh

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Oct 31 '22 00:10 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Dec 27 '22 00:12 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Feb 07 '23 00:02 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Mar 13 '23 00:03 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Apr 15 '23 00:04 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar May 23 '23 00:05 github-actions[bot]