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

[warren830]

Search before asking

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

• Yes I am willing to submit a PR!

Code of Conduct

• I agree to follow this project's Code of Conduct

[e2corporation]

@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.

[klesh]

@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 😃

[keon94]

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

[klesh]

@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

[github-actions]

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]

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.