Skip to content

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented Aug 18, 2025

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:

  • "ssrm_table"
  • "omni"
  • "multi_file_viewer"

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"}}

@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 labels Aug 18, 2025
@deeleeramone deeleeramone requested a review from piiq August 18, 2025 04:07
@deeleeramone deeleeramone added this pull request to the merge queue Sep 5, 2025
Merged via the queue into develop with commit f84ac76 Sep 5, 2025
9 checks passed
@piiq piiq deleted the feature/platform-api-post-params branch September 16, 2025 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants