From 2c4960a7ab962ad5adaa4eb2636a4ac7862ea251 Mon Sep 17 00:00:00 2001 From: Celal Zamanoglu <95054566+celalzamanoglu@users.noreply.github.com> Date: Tue, 9 Dec 2025 19:12:34 +0300 Subject: [PATCH] hide folder endpoints from docs (#4238) --- skyvern/forge/sdk/routes/agent_protocol.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/skyvern/forge/sdk/routes/agent_protocol.py b/skyvern/forge/sdk/routes/agent_protocol.py index 5f8021ef..0add3b12 100644 --- a/skyvern/forge/sdk/routes/agent_protocol.py +++ b/skyvern/forge/sdk/routes/agent_protocol.py @@ -945,12 +945,13 @@ async def delete_workflow( ################# Folder Endpoints ################# -@legacy_base_router.post("/folders", response_model=Folder, tags=["agent"]) +@legacy_base_router.post("/folders", response_model=Folder, tags=["agent"], include_in_schema=False) @legacy_base_router.post("/folders/", response_model=Folder, include_in_schema=False) @base_router.post( "/folders", response_model=Folder, tags=["Workflows"], + include_in_schema=False, description="Create a new folder to organize workflows", summary="Create folder", responses={ @@ -984,12 +985,13 @@ async def create_folder( ) -@legacy_base_router.get("/folders/{folder_id}", response_model=Folder, tags=["agent"]) +@legacy_base_router.get("/folders/{folder_id}", response_model=Folder, tags=["agent"], include_in_schema=False) @legacy_base_router.get("/folders/{folder_id}/", response_model=Folder, include_in_schema=False) @base_router.get( "/folders/{folder_id}", response_model=Folder, tags=["Workflows"], + include_in_schema=False, description="Get a specific folder by ID", summary="Get folder", responses={ @@ -1025,12 +1027,13 @@ async def get_folder( ) -@legacy_base_router.get("/folders", response_model=list[Folder], tags=["agent"]) +@legacy_base_router.get("/folders", response_model=list[Folder], tags=["agent"], include_in_schema=False) @legacy_base_router.get("/folders/", response_model=list[Folder], include_in_schema=False) @base_router.get( "/folders", response_model=list[Folder], tags=["Workflows"], + include_in_schema=False, description="Get all folders for the organization", summary="Get folders", responses={ @@ -1079,12 +1082,13 @@ async def get_folders( return result -@legacy_base_router.put("/folders/{folder_id}", response_model=Folder, tags=["agent"]) +@legacy_base_router.put("/folders/{folder_id}", response_model=Folder, tags=["agent"], include_in_schema=False) @legacy_base_router.put("/folders/{folder_id}/", response_model=Folder, include_in_schema=False) @base_router.put( "/folders/{folder_id}", response_model=Folder, tags=["Workflows"], + include_in_schema=False, description="Update a folder's title or description", summary="Update folder", responses={ @@ -1123,11 +1127,12 @@ async def update_folder( ) -@legacy_base_router.delete("/folders/{folder_id}", tags=["agent"]) +@legacy_base_router.delete("/folders/{folder_id}", tags=["agent"], include_in_schema=False) @legacy_base_router.delete("/folders/{folder_id}/", include_in_schema=False) @base_router.delete( "/folders/{folder_id}", tags=["Workflows"], + include_in_schema=False, description="Delete a folder. Optionally delete all workflows in the folder.", summary="Delete folder", responses={ @@ -1153,12 +1158,15 @@ async def delete_folder( return {"status": "deleted", "folder_id": folder_id, "workflows_deleted": delete_workflows} -@legacy_base_router.put("/workflows/{workflow_permanent_id}/folder", response_model=Workflow, tags=["agent"]) +@legacy_base_router.put( + "/workflows/{workflow_permanent_id}/folder", response_model=Workflow, tags=["agent"], include_in_schema=False +) @legacy_base_router.put("/workflows/{workflow_permanent_id}/folder/", response_model=Workflow, include_in_schema=False) @base_router.put( "/workflows/{workflow_permanent_id}/folder", response_model=Workflow, tags=["Workflows"], + include_in_schema=False, description="Update a workflow's folder assignment for the latest version", summary="Update workflow folder", responses={