Skip to content

Commit ddd2191

Browse files
committed
AI-1343 docs: update tools md wrt improved tools desc in data apps
1 parent bbc4d08 commit ddd2191

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

TOOLS.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ filtering.
4444
- [create_oauth_url](#create_oauth_url): Generates an OAuth authorization URL for a Keboola component configuration.
4545

4646
### Other Tools
47-
- [deploy_data_app](#deploy_data_app): Deploys a data app or stops running data app in the Keboola environment given the action and configuration ID.
47+
- [deploy_data_app](#deploy_data_app): Deploys/redeploys a data app or stops running data app in the Keboola environment given the action and
48+
configuration ID.
4849
- [get_data_apps](#get_data_apps): Lists summaries of data apps in the project given the limit and offset or gets details of a data apps by
49-
providing its configuration IDs.
50+
providing their configuration IDs.
5051
- [modify_data_app](#modify_data_app): Creates or updates a Streamlit data
5152

5253
Considerations:
@@ -886,7 +887,12 @@ EXAMPLES:
886887

887888
**Description**:
888889

889-
Deploys a data app or stops running data app in the Keboola environment given the action and configuration ID.
890+
Deploys/redeploys a data app or stops running data app in the Keboola environment given the action and
891+
configuration ID.
892+
893+
Considerations:
894+
- Redeploying a data app takes some time, and the app temporarily may have status "stopped" during this process
895+
because it needs to restart.
890896

891897

892898
**Input JSON Schema**:
@@ -926,7 +932,7 @@ Deploys a data app or stops running data app in the Keboola environment given th
926932
**Description**:
927933

928934
Lists summaries of data apps in the project given the limit and offset or gets details of a data apps by
929-
providing its configuration IDs.
935+
providing their configuration IDs.
930936

931937
Considerations:
932938
- If configuration_ids are provided, the tool will return details of the data apps by their configuration IDs.
@@ -983,7 +989,7 @@ query following current sql dialect and returns a pandas DataFrame with the resu
983989
`query_data` tool to inspect the data in the workspace before using it in the data app.
984990
- If you're updating an existing data app, provide the `configuration_id` parameter and the `change_description`
985991
parameter.
986-
- If the data app is deployed and is updated, it needs to be redeployed to apply the changes.
992+
- If the data app is updated while running, it must be redeployed for the changes to take effect.
987993

988994

989995
**Input JSON Schema**:

0 commit comments

Comments
 (0)