Skip to content

Spice OSS v1.1 docs updates #917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Apr 1, 2025
Merged

Spice OSS v1.1 docs updates #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fb9b569
Update default value for tool_recursion_limit (#915)
sgrebnov Mar 31, 2025
1efd4eb
Docs for MCP (#895)
Jeadie Mar 31, 2025
5ab1f86
docs for LLM and embedding eval scorers (#908)
Jeadie Mar 31, 2025
42d6516
Docs for parameterized prompts (#907)
Jeadie Mar 31, 2025
dd1a8f4
Perplexity / WebSearch documentation. (#897)
Jeadie Mar 31, 2025
8dc928a
Update openapi docs for v1.1.0 (#919)
ewgenius Mar 31, 2025
e66564b
Fix broken linnks - add missing .md extension and correct anchor (#920)
ewgenius Mar 31, 2025
fac46d9
Clarify the behavior of `refresh_on_startup: auto` (#918)
phillipleblanc Mar 31, 2025
b000e89
Add MCP and IMAP recipes (#922)
lukekim Mar 31, 2025
eb131ef
Update the FAQ (#924)
lukekim Mar 31, 2025
08710f7
Merge branch 'trunk' into release/1.1
lukekim Mar 31, 2025
6511977
feat: IMAP connector (#883)
peasee Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/api/HTTP/get-datasets.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This endpoint returns a list of configured datasets. The response
sidebar_label: "List Datasets"
hide_title: true
hide_table_of_contents: true
api: eJzVVt9v2zYQ/leIe0lrME5SYMCmtyBphwxFUzTZ9uAYDk2dLaYUqZKUE9fQ/z4cRdlyomRB15e95Id4vPvuu++Ot4Eglh6yCZyLIDwGD1MOOXrpVBWUNZDBdaE8Q5NXVpnAHIbaGc8E08oHZhdMWrNQy9phzvLkZMyuC2QOfWWNRyaFYXNkC+tKEQLmTHg2Gv1xdflpNGLWsdHo7Oqv0YjfGGFyJvJcUWih2ULpgM53DkRVaYU5q70yS/atRrdmlXCiRLIaAwdboRN0+SKHDJYYZh0k4LAzhWyyASNKhAx8EKGmY0XJRqfAweG3WjnMIVsI7ZGDlwWWArINhHVF9+bWahQGmoZvfbUZPvb1mM6OCSIv9Hgas8/WezXXyFZC1+iZcMgO7rw1B+xNjgtR6/CWCDuQfnUwfhVMH5wyS+CApi6p0OQOOEi/olIHFTSZfWiR95PxtnYSX07mQypQxzKbr1l7j73B8XLM2W1lfVg69JlQOZZ2VqL3Yon+9u2rEpjsMjC11jBtmildaynzZPju+Jh+7SP7mNTZq7+0JqAJZBuVJKNSjiIh2eYpdXZ+hzLsgZzAwtmSsBBHdLL1M0Mj5hpz4CCkRJ2EuP085VA50mdQLexBq6f6ekz53wWGAh3rX2exQ6MH0lZUVUocGt5iHpDEU2Gm2t0X6LDvhQJoK0XAnBy2CnmNQ7LsdN5DtM/EY7733ZzVPtiS7a48SZHDbmZ87nveRVp/EuVesIS5aYaL+Po69G7/SxnSpMk2YA1eLuIQSkGitKn39mNcVmkQtlcfE8mfbfILo4ISWn1vP39BkVPznivfafS9c9bFo4VDX5Bdbxyc2bKyBk24ajE3UyKqO01vxZfUhBcBS8oPH0RZkcFkkyQH2+b3ayN91zcZ5ELp9ezO1s4IPdtKOSIbLEeaDsM9E1yNRF4KSvTMnZJffVaoFc5KDMIH63CcZui4m0E7QN2Xn43luem3i7xEg07oHwoWD5splQYfwhHN9KFB1mm9VyK4MYSQEwg+EJgPBbwx+/Xkz5aRt7CJjBvz+nrwoTLs+XqOT55oTMbx5w09zg2HX4behwsT0MXWQrdCx5D6gVkpa0ebzH2hNNLMkejjtjH8jkTaKy3U8AsyRPypYbXBhwolbUKvDtvEVEoMhU2rTdxoQgEZHK1Ojnr42ozaJad2GjIoQqiyoyOa4LqwPmS/Hv92/GSifaRjluMKta1KNCFxM2Zn3YrH7lUo2O3hIXm8HQO9xR5l7VRYx3iiUrOvSH9P6UyZhY18pMnhahNUfDkH3p5KSczZzkQricbHhyb1ymklZIGH78YEXuVogloodPsnDQdKv3V8Mj5pP5FwSmF6zuKGcL6jbQ/RZlfl/9UCnITX02XDWxFsklomsDqhbHv7PkmCDjabufD4p9NNQ5/blY+qmnfvRjeOYol3q3NcVyGD9gl7bPwCsT9xFR7MvMW5Xct/EOd/3nJfwLbdsnfYpvSPUwQu9hGHAkVOMp9s0q1TKbHqZ/RkoSUv22nx+/traJp/ADQv6IY=
api: eJzVVt9v2zYQ/leIe0lrME5SYMCmtyBphwxFUzTZ9uAYDk2dLaYUqZKUE9fQ/z4cRdlyomRB15e95Id4vPvuu++Ot4Eglh6yCZyLIDwGD1MOOXrpVBWUNZDBdaE8Q5NXVpnAHIbaGc8E08oHZhdMWrNQy9phzvLkZMyuC2QOfWWNRyaFYXNkC+tKEQLmTHg2Gv1xdflpNGLWsdHo7Oqv0YjfGGFyJvJcUWih2ULpgM53DkRVaYU5q70yS/atRrdmlXCiRLIaAwdboRN0+SKHDJYYZh0k4LAzhWyyASNKhAx8EKGmY0XJRqfAweG3WjnMIVsI7ZGDlwWWArINhHVF9+bWahQGmoZvfbUZPvb1mM6OCSIv9Hgas8/WezXXyFZC1+iZcMgO7rw1B+xNjgtR6/CWCDuQfnUwfhVMH5wyS+CApi6p0OQOOEi/olIHFTSZfWiR95PxtnYSX07mQypQxzKbr1l7j73B8XLM2W1lfVg69JlQOZZ2VqL3Yon+9u2rEpjsMjC11jBtmildaynzZPju+Jh+7SP7mNTZq7+0JqAJZBuVJKNSjiIh2eYpdXZ+hzLsgZzAwtmSsBBHdLL1M0Mj5hpz4CCkRJ2EuP085VA50mdQLexBq6f6ekz53wWGAh3rX2exQ6MH0lZUVUocGt5iHpDEU2Gm2t0X6LDvhQJoK0XAnBy2CnmNQ7LsdN5DtM/EY7733ZzVPtiS7a48SZHDbmZ87nveRVp/EuVesIS5aYaL+Po69G7/SxnSpMk2YA1eLuIQSkGitKn39mNcVmkQtlcfE8mfbfILo4ISWn1vP39BkVPznivfafS9c9bFo4VDX7R2V0UdgjLLc3tv+tPhzJaVNWjCVZtCMyXeutP0dHxJPXkRsKR08UGUFRlMNkmBsJ0Ffm2k79oog1wovZ7d2doZoWdbZUegg9VJw2K4hYKrkbhMQYmtuVPyq88KtcJZiUH4YB2O00gddyNpB6j78rOxPDcMd5GXaNAJ/UPB4mEzpdLgQziiET801zrp90oEN4YQcgLBBwLzoYA3Zr+e/Nky8hY2kXFjXl8PPlSGPV/P8ckTjck4/ryht7rh8MvQc3FhArrYaehW6BhSezArZe1osbkvlEYaQRJ9XD6Gn5VIe6WFGn5Qhog/Naw2+FChpMXo1WGbmEqJobBp04kLTiggg6PVyVEPX5tRu/PUTkMGRQhVdnREA10X1ofs1+Pfjp8MuI90zHJcobZViSYkbsbsrNv42L0KBbs9PCSPt2Ogp9mjrJ0K6xhPVGr2FenvKZ0ps7CRjzQ5XG2Cig/pwFNUKYk525loJdH4+O6kXjmthCzw8N2YwKscTVALhW7/pOFA6beOT8Yn7ScSTilMz1lcGM53tO0h2uyq/L/ah5PwerpseCuCTVLLBFYnlG1v/SdJ0MFmMxce/3S6aehzuwFSVfPuGenGUSzxbpOO2ytk0L5oj41fIPYnbsaDmbc4t1v6D+L8z0vvC9i2S/cO25T+cYrAxT7iUKDISeaTTbp1KiVW/Yye7LfkZTstfn9/DU3zD1sU7eQ=
sidebar_class_name: "get api-method"
info_path: docs/api/HTTP/runtime
custom_edit_url: null
Expand Down Expand Up @@ -64,7 +64,7 @@ and additional filters can be applied using query parameters.
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"List of datasets","content":{"application/json":{"schema":{"type":"object","required":["from","name","replication_enabled","acceleration_enabled"],"properties":{"acceleration_enabled":{"type":"boolean","description":"Whether acceleration is enabled for the dataset"},"from":{"type":"string","description":"The source where the dataset is located"},"name":{"type":"string","description":"The name of the dataset"},"properties":{"type":"object","description":"Custom properties for the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"replication_enabled":{"type":"boolean","description":"Whether replication is enabled for the dataset"},"status":{"oneOf":[{"type":"null"},{"description":"Optional status of the dataset","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing"],"title":"ComponentStatus"}]}},"title":"DatasetResponseItem"},"example":[{"from":"postgres:syncs","name":"daily_journal_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"databricks:hive_metastore.default.messages","name":"messages_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"postgres:aidemo_messages","name":"general","replication_enabled":false,"acceleration_enabled":false}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name,replication_enabled,acceleration_enabled\npostgres:syncs,daily_journal_accelerated,false,true\ndatabricks:hive_metastore.default.messages,messages_accelerated,false,true\npostgres:aidemo_messages,general,false,false\n"}}},"500":{"description":"Internal server error occurred while processing datasets","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing datasets"}}}}}
responses={{"200":{"description":"List of datasets","content":{"application/json":{"schema":{"type":"object","required":["from","name","replication_enabled","acceleration_enabled"],"properties":{"acceleration_enabled":{"type":"boolean","description":"Whether acceleration is enabled for the dataset"},"from":{"type":"string","description":"The source where the dataset is located"},"name":{"type":"string","description":"The name of the dataset"},"properties":{"type":"object","description":"Custom properties for the dataset","additionalProperties":{},"propertyNames":{"type":"string"}},"replication_enabled":{"type":"boolean","description":"Whether replication is enabled for the dataset"},"status":{"oneOf":[{"type":"null"},{"description":"Optional status of the dataset","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}]}},"title":"DatasetResponseItem"},"example":[{"from":"postgres:syncs","name":"daily_journal_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"databricks:hive_metastore.default.messages","name":"messages_accelerated","replication_enabled":false,"acceleration_enabled":true},{"from":"postgres:aidemo_messages","name":"general","replication_enabled":false,"acceleration_enabled":false}]},"text/csv":{"schema":{"type":"string"},"example":"\nfrom,name,replication_enabled,acceleration_enabled\npostgres:syncs,daily_journal_accelerated,false,true\ndatabricks:hive_metastore.default.messages,messages_accelerated,false,true\npostgres:aidemo_messages,general,false,false\n"}}},"500":{"description":"Internal server error occurred while processing datasets","content":{"text/plain":{"schema":{"type":"string"},"example":"An unexpected error occurred while processing datasets"}}}}}
>

</StatusCodes>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/api/HTTP/get-models.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "List all models, both machine learning and language models, availa
sidebar_label: "List Models"
hide_title: true
hide_table_of_contents: true
api: eJy1Vttu4zYQ/RVinjYAfUnQAq3egu22cLHbAHt5coyYFkcWtxTJJSlnXUP/Xgwpy3bipEaLPtkih2fOXM6QO4hiHaCYw+0MFhwkhtIrF5U1UMB7FSITWrPGStSBs5WNNWtEWSuDTKPwRpk1E0YyLcy6FWscTMVGKC1WGpkyLNbIfGuianAMHKxDL8jHTEIBa4wP+RRwcMKLBiN6IrUDIxqEAirrGxGBgyJa31r0W3hK9nONLNsxW2WPGJw1AdkbHK/HnC2/BmuWzHq2LMNmeUVUPH5rlUcJRSV0QA6hrLERUOwgbh35DtErswYOaNqGMkUowKEMG8pYVFGT2a+ZYtfxgXWIIrbhddazikXfImfKlLqVGBLzfJLiQFHWOadDHvuoLmO/slajMNB1CzLPRwMZ3Eyn9HOm4rbqq0guf/909wcb8l9aE9FEOiic06pMZZyklBS75+7t6iuW8YTp/LAoRRSUQ+epI6LKxNLqAUJ4LyhvKmIT/glaSWqv/Y59NCgfVtvzPgLGI7z54Mi0WtOJpw77RujONd4ej4kQbKlERMkeVaxZrFXI2eRMVUyYLQEoea7BnsNSI+27OYHQ4T68iwDI4gSAvRH6UWwDW6bP5VVC3OfpIsxgW18iq7xt2GOtyvoI/VEEpq2QKAfRWYdGqCVny+BUiUJln704ih1Yg3dVUnvvOxWAdHTG9yCMo4h6Rx6F3JIfZVRUQqu/lFnTN3pv/fIK+IuSnh2dAA4fCQk4/KICTTDqqXeEkbYqj6EmuyPxv7WNswZN/JSj6hZdd9i9c2huZx9y/V4p4AtnPvaqpazhd9E4MtgNKKBVGMREWVRpqLo4+uGghQJy+xzXGnJl+qNZDZT6Q20gpTSVIoFG/B5H2KxQSmXWIyHFaDq9ucjLSJmI3gh94m6eIfuF0TWV6HjhhpL8lE3OLX6PExrB56bOQalDvuDeKMkzT75nx/dMePZxb1LaeNZrJs55cntvzgd/YjsEye+fBMZPw7qHPSp0FM2P52bxrAdjAf0GPUttzGxZtt7TeKmVRua8LTEEuoaHO/TSIX3aTwkeCrh1jhkb2aAilESSaDYYa9tf2emujjUUMNlcTwbfmWu+vFuvoYA6RldMJtqWQtc2xOKn6c/TZ4PlPW0ziRvU1jVoYh/1mL21plLr1mMeqMvRiBCXY6AbLWDZehW3yZ9w6uFPpP8L2lOmsqkpekn1D5DzM41Gk2QHE61KJM0Vw21+60RZ4+hmTOSVRBNVpdCf7nQcKPwMfD2+zkvOhtgIcwSW7tkP+6Sd8Nkd6ve/PcB6nSQROS2UIZapXLu+qnPYkBr7ui44UOloebdbiYBfvO46Ws6vGsq+3A/L/Vvkxaj+3UvtLOdU7sPzcCN0S0b59riY0H97hL1CbHgBHogt6MMrYpYalUONQlIfzXf9qduyRHcczjMVE8ogxt/efYau+xsGfQtj
api: eJy1Vttu4zYQ/RVinjYAfUnQAq3egt1t4WK3ATbbJ8eIaWlszZYitSRlxzX078WQsmwnTmq06JMtcnjmzOUMuYOgVh6yKdxOYCahQJ87qgNZAxl8Ih+E0lpUtkDtpVjYUIpK5SUZFBqVM2RWQplCaGVWjVphb6rWirRaaBRkRChRuMYEqnAIEmyNTrGPSQEZrDA8plMgoVZOVRjQMakdGFUhZLC0rlIBJBDT+t6g28Jzsl9LFMlO2GXyiL62xqN4h8PVUIr5N2/NXFgn5rlfz6+YisPvDTksIFsq7VGCz0usFGQ7CNuaffvgyKxAApqm4kwxCkjI/ZozFihoNvslUWxb2bP2QYXGv816shTBNSgFmVw3BfrIPJ3kOFDlZcppn8cuqsvYL6zVqAy07YzN01HPBjfjMf+cqbhddlVkl7/d3/0u+vzn1gQ0gQ+qutaUxzKOYkqy3Uv3dvEN83DCdHpYLFRQnMPacUcESsTi6gFCOac4bxSw8v8ETQW3137HbgwWj4vteR8ewxHetHdkGq35xHOHXSO05xpvjyeU9zYnFbAQGwqlCCX5lE0paCmU2TIAFeca7CUsN9K+myMIH+7CuwiALU4AxDulN2rrxTx+zq8i4j5PF2F627gcxdLZSmxKyssj9I3yQltVYNGLztZoFM2lmPuaclSUfHbiyHZgDd4to9o737EArKMzvnthHEXUOXKoii37IUOBlKa/yKz4G52zbn4F8lVJT45OgIQvjAQSPpDnCcY99ZEx4tbSoS+T3X3ZhEBm9cFuzPEseG+r2ho04T4F2c7a9rB7V6O5nXxO5Xyjnq+c+dKJmJOIT6qq2WDXo4Am32uLk0pxxtZh8MNBGhmkbjouPaRCdUeTOLgSh1JBzHCsTAQN+BQGWC2wKMisBqpQg/H45iIvAzIBnVH6xN00QXYLg2uu2PHCDSf5OZuUW3wKI57I54bQQbh9vuDBUCETT7lnJ/dMZPLxYGLaZJJvIi5ldPtgzgd/YtsHKR+eBSZPw3qAPSq0HM2P50bzpAMTHt0anYhdLWyeN87xtClJo6idzdF7vpX7K/XSmX3aTxEeMrita2FsEL2osGCSTLPCUNruBo9Xdyghg9H6etT7TlzTXd44DRmUIdTZaKRtrnRpfch+Gv88fjFnPvG2KHCN2tYVmtBFPRTvrVnSqnGY5ut8MGDE+RD4gvOYN47CNvpTNT3+ifx/xntkljY2RSep7j1yfsTxpCrEwURTjqy5rL/cb2uVlzi4GTJ5KtAEWhK6051WAoefgK+H12mptj5UyhyBxWv38z5pJ3x2h/r9b++xTidRRLVWZJhlLNeuq+oU1qzGrq4zCVw6Xt7tFsrjH063LS+nRw5nv9jPzv3T5NWo/t3D7SznWO7Da3GtdMNG6TK5mNB/e5O9Qax/EB6IzfjDETOLjSqhRFVwH0133anbPMf6OJwXKmaUXoy/fvwKbfs3P7kQwQ==
sidebar_class_name: "get api-method"
info_path: docs/api/HTTP/runtime
custom_edit_url: null
Expand Down Expand Up @@ -63,7 +63,7 @@ List all models, both machine learning and language models, available in the run
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"List of models in JSON format","content":{"application/json":{"schema":{"type":"object","required":["object","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","object","owned_by"],"properties":{"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated with this model, if any"},"id":{"type":"string","description":"The name of the model"},"object":{"type":"string","description":"The type of the model (always `model`)"},"owned_by":{"type":"string","description":"The source from which the model was loaded (e.g., `openai`, `spiceai`)"},"status":{"oneOf":[{"type":"null"},{"description":"The status of the model (e.g., `ready`, `initializing`, `error`)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing"],"title":"ComponentStatus"}]}},"title":"OpenAIModel"}},"object":{"type":"string"}},"title":"OpenAIModelResponse"},"example":{"object":"list","data":[{"id":"gpt-4","object":"model","owned_by":"openai","datasets":null,"status":"ready"},{"id":"text-embedding-ada-002","object":"model","owned_by":"openai-internal","datasets":["text-dataset-1","text-dataset-2"],"status":"ready"}]}},"text/csv":{"schema":{"type":"string"},"example":"\nid,object,owned_by,datasets,status\ngpt-4,model,openai,,ready\ntext-embedding-ada-002,model,openai-internal,\"text-dataset-1,text-dataset-2\",ready\n"}}},"500":{"description":"Internal server error occurred while processing models","content":{"application/json":{"schema":{},"example":{"error":"App not initialized"}}}}}}
responses={{"200":{"description":"List of models in JSON format","content":{"application/json":{"schema":{"type":"object","required":["object","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","object","owned_by"],"properties":{"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated with this model, if any"},"id":{"type":"string","description":"The name of the model"},"object":{"type":"string","description":"The type of the model (always `model`)"},"owned_by":{"type":"string","description":"The source from which the model was loaded (e.g., `openai`, `spiceai`)"},"status":{"oneOf":[{"type":"null"},{"description":"The status of the model (e.g., `ready`, `initializing`, `error`)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}]}},"title":"OpenAIModel"}},"object":{"type":"string"}},"title":"OpenAIModelResponse"},"example":{"object":"list","data":[{"id":"gpt-4","object":"model","owned_by":"openai","datasets":null,"status":"ready"},{"id":"text-embedding-ada-002","object":"model","owned_by":"openai-internal","datasets":["text-dataset-1","text-dataset-2"],"status":"ready"}]}},"text/csv":{"schema":{"type":"string"},"example":"\nid,object,owned_by,datasets,status\ngpt-4,model,openai,,ready\ntext-embedding-ada-002,model,openai-internal,\"text-dataset-1,text-dataset-2\",ready\n"}}},"500":{"description":"Internal server error occurred while processing models","content":{"application/json":{"schema":{},"example":{"error":"App not initialized"}}}}}}
>

</StatusCodes>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/api/HTTP/get-status.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Return the status of all connections (http, flight, metrics, opent
sidebar_label: "Check Runtime Status"
hide_title: true
hide_table_of_contents: true
api: eJy1VsFu2zgQ/RViTg3AyHZ2F011C5JuESAoFkm6l8hoGWlssaVIlqS8dQ39+2JIyZbWDrqH9mSaHL6ZeW9mqB0EsfaQP8E71OiEgiWHCn3ppA3SaMjhHkPrNAs1Mh9EaD0zKyaUYqXRGkuy8uxVHYLlbKXkug6cNRicLD1nxqIOqJA2tmdMJhzX6iAbzICDsegEYdxWkMMaw8fkBDhY4USDAR3FtwMtGoQcVsY1IgAHScF9bdFt4b8hP9bIkh3FGj2it0Z75AxlqNGxAj57owtghtal3xSQsRtciVYFz4LZG1CQDr+20mEF+Uoojxx8WWMjIN9B2FqKygcn9Ro4oG4bopMuAydgYjTIoMjszxR81y0JNIXkCeZiPqefaRp30scEDkT3CiDRUxodUAe6JqxVsow0zqLjfHcconBOEFUyYONH++b5M5ZhkuVTIpuyqayRmk57WZYcrCPRgkyR701OkHGsymA96DJK7RVm64yzD/d3pMntX0xUlUPvz6Djvfj/xwNZvoxeABVqAbRKxZrWfcGmP5OiLSAG0Kd/pNHjpC2S08YajToMPu9RVFvObrUMUij5Xeo1ZzfSi2eFFWdvnTOOMwxldgb8xYIaXwcOERQ4DDjAIQLFo5VDX5PdqPSuh7AeUiZdNz4beLrBIKRKp/hNNJbOD81H5I3LIu3ks9ni4nU2z+bZIr+cX84P5ZL3gXb80MCR9h+gvJnPJyiT7EdgvW5TtPezq/HdPUWjexOJfxDL778tXo/xEs/dkgjEb2FGPX6q4XoJx0xG93xwxhNkoePwPMkkj/QVuh+sJ3niY3IKPcze97MrPqRe6EnCxziUI+8TI+3/ODWP4jk11YbaX69pTF4//D2dRZESq4Q8PYVOkfISbhdDaTDUpn8c4qsQashhtlnM9i+FR7cZnonWqYOIypRC1caH/HL+Zn40L+7omFW4QWVsQy2bkDJ2bfRKrluH7B8Zavbp/JwQP2VAk9tj2ToZttGfsPLjF6T1ks6kXpmYbt9a/VN3clR5K0us2MFEyRK1j4Our9MrK8oazy8yCl5WqINcSXTTk44DpZ+AF9kibVnjQyP0COy6xvILu0/u2MPA3iSw3UHLX/zy9wUxqpeOJ/V2vchPsFlMXh5SkrZ3u2fh8YNTXUfb6SOAxKiGVh8e6hdz+9mfCCeziXVx+GLZCNWSUSyijXCSYo2Fw6FGUZGuT7v+1lVZoh3fOnrkCWXfHO/ePkLX/QvCQ08d
api: eJy1VlFv2zgM/isCn1ZAdZLeHdb5rWh3Q4FiOLTdvdTBptpMrM2WPInOlgv83w+U7MS+pNgedk9xJOoj+X0kpR2QWntIn+AdGnSqgqWEAn3udEPaGkjhHql1RlCJwpOi1gu7EqqqRG6NwZytvHhVEjVSrCq9LkmKGsnp3EthGzSEFfLC9kzoiONaQ7rGBCTYBp1ijNsCUlgjfYxOQEKjnKqR0HF8OzCqRkhhZV2tCCRoDu5ri24L/w35sUQR7TjW4BF9Y41HKVBTiU5k8Nlbk4Gw/J37TQaJuMGVaivyguzegIN0+LXVDgtIV6ryKMHnJdYK0h3QtuGoPDlt1iABTVsznXwYJAMzo6SpYrM/Y/Bdt2TQGJJnmIv5nH+madxpHxI4EN0rgExPbg2hIT6mmqbSeaBxFhynu+MQlXOKqdKEtR+t2+fPmNMky6dINmdTNFYb3u1lWUpoHItGOka+NzlBxrEqg/Wgyyi1V5isEyk+3N+xJrd/CVUUDr0/g0724v+MB7Z8GT0DLtQM+CsWa/zuCzb+mRRtBiGAPv0jjR4nbRGd1o01aGjweY+q2EpxazRpVel/tFlLcaO9eq6wkOKtc9ZJgZQnZyBfLKjxcZAQQEHCgAMSAlDYWjn0ZbR7KFsibdY39psZV+L1EOVDTKzrxnsDbTdISldxF7+ruuH9Qy8yl+MqiSvpbLa4eJ3Mk3mySC/nl/ND9aR93J089HNQ4Qcob+bzCcqEjBFYL+MU7f3sanx2z9jo3ETxH8Ty+2+L12O8SHu3ZALxO8245U/1X6/omMngXg7OZITMTJilJ5mUgb7M9HP2JE9yTE5mhlH8fnYlh9QzM0n4GIdzlH1irP0fp8ZT2Oce2/A0MGuemtcPf09HU6CkqZQ+PZROkfISbhdCqZFK298V4ZKgElKYbRaz/cXh0W2GW6N11UHEyuaqKq2n9HL+Zn40Pu54WxS4wco2NXdwRErEtTUrvW4dim+aSvHp/JwRPyXAg9xj3jpN2+BPNfrjF+TvJe9ps7Ih3b61+pvv5OTyjc6xEAeTSudofJh7fZ1eNSov8fwi4eB1gYb0SqOb7nQSOP0IvEgWcamxnmplRmDXJeZfxH10Jx4G9iaB7Q5a/s8Pgb4gRvXSyajerhf5CTaLyUXESvLybvesPH5wVdfxcnwTsBjF0OrDvf1ibr/6xXAym1AXhwfMRlUtG4Ui2iinOdZQOBJKVAXr+rTrT13lOTbjU0d3PqPsm+Pd20foun8Bo8ZUew==
sidebar_class_name: "get api-method"
info_path: docs/api/HTTP/runtime
custom_edit_url: null
Expand Down Expand Up @@ -63,7 +63,7 @@ Return the status of all connections (http, flight, metrics, opentelemetry) in t
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"List of connection statuses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","endpoint","status"],"properties":{"endpoint":{"type":"string","description":"The endpoint of the connection (e.g., URL or IP address)"},"name":{"type":"string","description":"The name of the connection (e.g., \"http\", \"flight\", \"metrics\", \"opentelemetry\")"},"status":{"description":"The status of the component (e.g., Ready, Initializing, Disabled, Error, etc.)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing"],"title":"ComponentStatus"}},"title":"ConnectionDetails"}},"example":[{"name":"http","endpoint":"http://127.0.0.1:8080","status":"Ready"},{"name":"flight","endpoint":"http://127.0.0.1:9000","status":"Initializing"},{"name":"metrics","endpoint":"N/A","status":"Disabled"},{"name":"opentelemetry","endpoint":"http://127.0.0.1:4317","status":"Error"}]},"text/csv":{"schema":{"type":"string"},"example":"name,endpoint,status\nhttp,http://127.0.0.1:8080,Ready\nflight,http://127.0.0.1:9000,Initializing\nmetrics,N/A,Disabled\nopentelemetry,http://127.0.0.1:4317,Error"}}},"500":{"description":"Error converting to CSV","content":{"text/plain":{"schema":{"type":"string"},"example":"Error converting to CSV"}}}}}
responses={{"200":{"description":"List of connection statuses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","endpoint","status"],"properties":{"endpoint":{"type":"string","description":"The endpoint of the connection (e.g., URL or IP address)"},"name":{"type":"string","description":"The name of the connection (e.g., \"http\", \"flight\", \"metrics\", \"opentelemetry\")"},"status":{"description":"The status of the component (e.g., Ready, Initializing, Disabled, Error, etc.)","type":"string","enum":["Initializing","Ready","Disabled","Error","Refreshing","ShuttingDown"],"title":"ComponentStatus"}},"title":"ConnectionDetails"}},"example":[{"name":"http","endpoint":"http://127.0.0.1:8080","status":"Ready"},{"name":"flight","endpoint":"http://127.0.0.1:9000","status":"Initializing"},{"name":"metrics","endpoint":"N/A","status":"Disabled"},{"name":"opentelemetry","endpoint":"http://127.0.0.1:4317","status":"Error"}]},"text/csv":{"schema":{"type":"string"},"example":"name,endpoint,status\nhttp,http://127.0.0.1:8080,Ready\nflight,http://127.0.0.1:9000,Initializing\nmetrics,N/A,Disabled\nopentelemetry,http://127.0.0.1:4317,Error"}}},"500":{"description":"Error converting to CSV","content":{"text/plain":{"schema":{"type":"string"},"example":"Error converting to CSV"}}}}}
>

</StatusCodes>
Expand Down
Loading