summaryrefslogtreecommitdiffstats
path: root/website/content/platform/usage/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'website/content/platform/usage/index.md')
-rw-r--r--website/content/platform/usage/index.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/website/content/platform/usage/index.md b/website/content/platform/usage/index.md
index 3483a3662d8..13ce82322ae 100644
--- a/website/content/platform/usage/index.md
+++ b/website/content/platform/usage/index.md
@@ -145,6 +145,7 @@ HTTP_PROXY="http://10.10.10.10:8000"
| table_style | dark | ["dark", "light"] | "The default color style to use with the OpenBB Charting Extension tables. Options are "dark" and "light"" |
| request_timeout | 15 | Any positive integer. | Specifies the timeout duration for HTTP requests. |
| metadata | True | [True, False] | Enables or disables the collection of metadata which provides information about operations including arguments duration route and timestamp. Disabling this feature may improve performance in cases where contextual information is not needed or when the additional computation time and storage space are a concern. |
+| field_order | False | [True, False] | Enables or disables the information on the field order defined with Pydantic models. Useful for frontend as the API returns JSON which is an unordered collection. |
| output_type | OBBject | ["OBBject", "dataframe", "numpy", "dict", "chart", "polars"] | Specifies the type of data the application will output when a command or endpoint is accessed. Note that choosing data formats only available in Python such as `dataframe` | `numpy` or `polars` will render the application's API non-functional. |
User settings can be set from the Python interface directly.