This commit is contained in:
Pratyush Shukla
2024-03-11 13:53:35 +05:30
parent 02e64a4d8c
commit cf16c430b9

View File

@@ -1549,9 +1549,9 @@ class ReferenceGenerator:
standard_model
] # pylint: disable=protected-access
# openbb provider is always present hence its the standard field
reference[path]["parameters"][
"standard"
] = cls.get_provider_field_params(standard_model, "QueryParams")
reference[path]["parameters"]["standard"] = (
cls.get_provider_field_params(standard_model, "QueryParams")
)
# Add `provider` parameter fields to the openbb provider
provider_parameter_fields = cls.get_provider_parameter_info(route_func)
@@ -1596,24 +1596,24 @@ class ReferenceGenerator:
elif route_method == {"POST"}:
# Add endpoint parameters fields for POST methods
docstring = route_func.__doc__
reference[path]["parameters"][
"standard"
] = ReferenceGenerator.get_post_method_parameters_info(docstring)
reference[path]["parameters"]["standard"] = (
ReferenceGenerator.get_post_method_parameters_info(docstring)
)
# Add endpoint returns data
# Currently only OBBject object is returned
if route_method == {"GET"}:
providers = provider_parameter_fields["type"]
reference[path]["returns"][
"OBBject"
] = DocstringGenerator.get_OBBject_description(
standard_model, providers, "website"
reference[path]["returns"]["OBBject"] = (
DocstringGenerator.get_OBBject_description(
standard_model, providers, "website"
)
)
elif route_method == {"POST"}:
docstring = route_func.__doc__
reference[path]["returns"][
"OBBject"
] = cls.get_post_method_returns_info(docstring)
reference[path]["returns"]["OBBject"] = (
cls.get_post_method_returns_info(docstring)
)
return reference