[Feature] openbb-platform-api
Better POST Params Discovery
#7204
+411
−250
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR refactors the POST parameters discovery logic, which was originally intended for Forms. The logic now handles POST endpoints from the Provider Interface, and utilizes an alternative method for the Form endpoint and parameter discovery.
The changes to the README file describe the new situation, and the diff will show what changed.
Examples in the README have been updated accordingly.
Tests have been updated to reflect changes.
This should only be a breaking change if you have specifically implemented the Form logic somewhere.
For POST functions, the endpoint will not generate a widget if the
widget_type
is not one of widget types relying on the method:None of the above widget types are assigned automatically, which effectively disables automatic widget creation for all POST endpoints, without basic user intervention - i.e, at minimum,
{"openapi_extra":{"widget_config":{"type": "ssrm_table"}}