robosystems-client 0.2.14__py3-none-any.whl → 0.2.16__py3-none-any.whl

robosystems_client/api/subgraphs/create_subgraph.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union
+from typing import Any
 
 import httpx
 
@@ -32,12 +32,12 @@ def _get_kwargs(
 
 
 def _parse_response(
-  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[HTTPValidationError, SubgraphResponse]]:
-  if response.status_code == 201:
-    response_201 = SubgraphResponse.from_dict(response.json())
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | SubgraphResponse | None:
+  if response.status_code == 200:
+    response_200 = SubgraphResponse.from_dict(response.json())
 
-    return response_201
+    return response_200
 
   if response.status_code == 422:
     response_422 = HTTPValidationError.from_dict(response.json())
@@ -51,8 +51,8 @@ def _parse_response(
 
 
 def _build_response(
-  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[HTTPValidationError, SubgraphResponse]]:
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HTTPValidationError | SubgraphResponse]:
   return Response(
     status_code=HTTPStatus(response.status_code),
     content=response.content,
@@ -66,10 +66,10 @@ def sync_detailed(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-) -> Response[Union[HTTPValidationError, SubgraphResponse]]:
+) -> Response[HTTPValidationError | SubgraphResponse]:
   """Create Subgraph
 
-   Create a new subgraph within a parent graph.
+   Create a new subgraph within a parent graph, with optional data forking.
 
   **Requirements:**
   - Valid authentication
@@ -79,8 +79,23 @@ def sync_detailed(
   - Must be within subgraph quota limits
   - Subgraph name must be unique within the parent graph
 
+  **Fork Mode:**
+  When `fork_parent=true`, the operation:
+  - Returns immediately with an operation_id for SSE monitoring
+  - Copies data from parent graph to the new subgraph
+  - Supports selective forking via metadata.fork_options
+  - Tracks progress in real-time via SSE
+
   **Returns:**
-  - Created subgraph details including its unique ID
+  - Without fork: Immediate SubgraphResponse with created subgraph details
+  - With fork: Operation response with SSE monitoring endpoint
+
+  **Subgraph ID format:** `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
+
+  **Usage:**
+  - Subgraphs share parent's credit pool
+  - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
+  - Permissions inherited from parent graph
 
   Args:
       graph_id (str):
@@ -91,7 +106,7 @@ def sync_detailed(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Response[Union[HTTPValidationError, SubgraphResponse]]
+      Response[HTTPValidationError | SubgraphResponse]
   """
 
   kwargs = _get_kwargs(
@@ -111,10 +126,10 @@ def sync(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-) -> Optional[Union[HTTPValidationError, SubgraphResponse]]:
+) -> HTTPValidationError | SubgraphResponse | None:
   """Create Subgraph
 
-   Create a new subgraph within a parent graph.
+   Create a new subgraph within a parent graph, with optional data forking.
 
   **Requirements:**
   - Valid authentication
@@ -124,8 +139,23 @@ def sync(
   - Must be within subgraph quota limits
   - Subgraph name must be unique within the parent graph
 
+  **Fork Mode:**
+  When `fork_parent=true`, the operation:
+  - Returns immediately with an operation_id for SSE monitoring
+  - Copies data from parent graph to the new subgraph
+  - Supports selective forking via metadata.fork_options
+  - Tracks progress in real-time via SSE
+
   **Returns:**
-  - Created subgraph details including its unique ID
+  - Without fork: Immediate SubgraphResponse with created subgraph details
+  - With fork: Operation response with SSE monitoring endpoint
+
+  **Subgraph ID format:** `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
+
+  **Usage:**
+  - Subgraphs share parent's credit pool
+  - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
+  - Permissions inherited from parent graph
 
   Args:
       graph_id (str):
@@ -136,7 +166,7 @@ def sync(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Union[HTTPValidationError, SubgraphResponse]
+      HTTPValidationError | SubgraphResponse
   """
 
   return sync_detailed(
@@ -151,10 +181,10 @@ async def asyncio_detailed(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-) -> Response[Union[HTTPValidationError, SubgraphResponse]]:
+) -> Response[HTTPValidationError | SubgraphResponse]:
   """Create Subgraph
 
-   Create a new subgraph within a parent graph.
+   Create a new subgraph within a parent graph, with optional data forking.
 
   **Requirements:**
   - Valid authentication
@@ -164,8 +194,23 @@ async def asyncio_detailed(
   - Must be within subgraph quota limits
   - Subgraph name must be unique within the parent graph
 
+  **Fork Mode:**
+  When `fork_parent=true`, the operation:
+  - Returns immediately with an operation_id for SSE monitoring
+  - Copies data from parent graph to the new subgraph
+  - Supports selective forking via metadata.fork_options
+  - Tracks progress in real-time via SSE
+
   **Returns:**
-  - Created subgraph details including its unique ID
+  - Without fork: Immediate SubgraphResponse with created subgraph details
+  - With fork: Operation response with SSE monitoring endpoint
+
+  **Subgraph ID format:** `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
+
+  **Usage:**
+  - Subgraphs share parent's credit pool
+  - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
+  - Permissions inherited from parent graph
 
   Args:
       graph_id (str):
@@ -176,7 +221,7 @@ async def asyncio_detailed(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Response[Union[HTTPValidationError, SubgraphResponse]]
+      Response[HTTPValidationError | SubgraphResponse]
   """
 
   kwargs = _get_kwargs(
@@ -194,10 +239,10 @@ async def asyncio(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-) -> Optional[Union[HTTPValidationError, SubgraphResponse]]:
+) -> HTTPValidationError | SubgraphResponse | None:
   """Create Subgraph
 
-   Create a new subgraph within a parent graph.
+   Create a new subgraph within a parent graph, with optional data forking.
 
   **Requirements:**
   - Valid authentication
@@ -207,8 +252,23 @@ async def asyncio(
   - Must be within subgraph quota limits
   - Subgraph name must be unique within the parent graph
 
+  **Fork Mode:**
+  When `fork_parent=true`, the operation:
+  - Returns immediately with an operation_id for SSE monitoring
+  - Copies data from parent graph to the new subgraph
+  - Supports selective forking via metadata.fork_options
+  - Tracks progress in real-time via SSE
+
   **Returns:**
-  - Created subgraph details including its unique ID
+  - Without fork: Immediate SubgraphResponse with created subgraph details
+  - With fork: Operation response with SSE monitoring endpoint
+
+  **Subgraph ID format:** `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
+
+  **Usage:**
+  - Subgraphs share parent's credit pool
+  - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
+  - Permissions inherited from parent graph
 
   Args:
       graph_id (str):
@@ -219,7 +279,7 @@ async def asyncio(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Union[HTTPValidationError, SubgraphResponse]
+      HTTPValidationError | SubgraphResponse
   """
 
   return (

robosystems_client/api/subgraphs/delete_subgraph.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union, cast
+from typing import Any, cast
 
 import httpx
 
@@ -13,7 +13,7 @@ from ...types import Response
 
 def _get_kwargs(
   graph_id: str,
-  subgraph_id: str,
+  subgraph_name: str,
   *,
   body: DeleteSubgraphRequest,
 ) -> dict[str, Any]:
@@ -21,7 +21,7 @@ def _get_kwargs(
 
   _kwargs: dict[str, Any] = {
     "method": "delete",
-    "url": f"/v1/graphs/{graph_id}/subgraphs/{subgraph_id}",
+    "url": f"/v1/graphs/{graph_id}/subgraphs/{subgraph_name}",
   }
 
   _kwargs["json"] = body.to_dict()
@@ -33,8 +33,8 @@ def _get_kwargs(
 
 
 def _parse_response(
-  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]:
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | DeleteSubgraphResponse | HTTPValidationError | None:
   if response.status_code == 200:
     response_200 = DeleteSubgraphResponse.from_dict(response.json())
 
@@ -76,8 +76,8 @@ def _parse_response(
 
 
 def _build_response(
-  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]:
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | DeleteSubgraphResponse | HTTPValidationError]:
   return Response(
     status_code=HTTPStatus(response.status_code),
     content=response.content,
@@ -88,11 +88,11 @@ def _build_response(
 
 def sync_detailed(
   graph_id: str,
-  subgraph_id: str,
+  subgraph_name: str,
   *,
   client: AuthenticatedClient,
   body: DeleteSubgraphRequest,
-) -> Response[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]:
+) -> Response[Any | DeleteSubgraphResponse | HTTPValidationError]:
   """Delete Subgraph
 
    Delete a subgraph database.
@@ -100,6 +100,7 @@ def sync_detailed(
   **Requirements:**
   - Must be a valid subgraph (not parent graph)
   - User must have admin access to parent graph
+  - Subgraph name must be alphanumeric (1-20 characters)
   - Optional backup before deletion
 
   **Deletion Options:**
@@ -114,9 +115,14 @@ def sync_detailed(
   If backup requested, stored in S3 Kuzu database bucket at:
   `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
 
+  **Notes:**
+  - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
+  - Deletion does not affect parent graph's credit pool or permissions
+  - Backup creation consumes credits from parent graph's allocation
+
   Args:
       graph_id (str):
-      subgraph_id (str): Subgraph identifier to delete
+      subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
       body (DeleteSubgraphRequest): Request model for deleting a subgraph.
 
   Raises:
@@ -124,12 +130,12 @@ def sync_detailed(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Response[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]
+      Response[Any | DeleteSubgraphResponse | HTTPValidationError]
   """
 
   kwargs = _get_kwargs(
     graph_id=graph_id,
-    subgraph_id=subgraph_id,
+    subgraph_name=subgraph_name,
     body=body,
   )
 
@@ -142,11 +148,11 @@ def sync_detailed(
 
 def sync(
   graph_id: str,
-  subgraph_id: str,
+  subgraph_name: str,
   *,
   client: AuthenticatedClient,
   body: DeleteSubgraphRequest,
-) -> Optional[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]:
+) -> Any | DeleteSubgraphResponse | HTTPValidationError | None:
   """Delete Subgraph
 
    Delete a subgraph database.
@@ -154,6 +160,7 @@ def sync(
   **Requirements:**
   - Must be a valid subgraph (not parent graph)
   - User must have admin access to parent graph
+  - Subgraph name must be alphanumeric (1-20 characters)
   - Optional backup before deletion
 
   **Deletion Options:**
@@ -168,9 +175,14 @@ def sync(
   If backup requested, stored in S3 Kuzu database bucket at:
   `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
 
+  **Notes:**
+  - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
+  - Deletion does not affect parent graph's credit pool or permissions
+  - Backup creation consumes credits from parent graph's allocation
+
   Args:
       graph_id (str):
-      subgraph_id (str): Subgraph identifier to delete
+      subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
       body (DeleteSubgraphRequest): Request model for deleting a subgraph.
 
   Raises:
@@ -178,12 +190,12 @@ def sync(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Union[Any, DeleteSubgraphResponse, HTTPValidationError]
+      Any | DeleteSubgraphResponse | HTTPValidationError
   """
 
   return sync_detailed(
     graph_id=graph_id,
-    subgraph_id=subgraph_id,
+    subgraph_name=subgraph_name,
     client=client,
     body=body,
   ).parsed
@@ -191,11 +203,11 @@ def sync(
 
 async def asyncio_detailed(
   graph_id: str,
-  subgraph_id: str,
+  subgraph_name: str,
   *,
   client: AuthenticatedClient,
   body: DeleteSubgraphRequest,
-) -> Response[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]:
+) -> Response[Any | DeleteSubgraphResponse | HTTPValidationError]:
   """Delete Subgraph
 
    Delete a subgraph database.
@@ -203,6 +215,7 @@ async def asyncio_detailed(
   **Requirements:**
   - Must be a valid subgraph (not parent graph)
   - User must have admin access to parent graph
+  - Subgraph name must be alphanumeric (1-20 characters)
   - Optional backup before deletion
 
   **Deletion Options:**
@@ -217,9 +230,14 @@ async def asyncio_detailed(
   If backup requested, stored in S3 Kuzu database bucket at:
   `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
 
+  **Notes:**
+  - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
+  - Deletion does not affect parent graph's credit pool or permissions
+  - Backup creation consumes credits from parent graph's allocation
+
   Args:
       graph_id (str):
-      subgraph_id (str): Subgraph identifier to delete
+      subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
       body (DeleteSubgraphRequest): Request model for deleting a subgraph.
 
   Raises:
@@ -227,12 +245,12 @@ async def asyncio_detailed(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Response[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]
+      Response[Any | DeleteSubgraphResponse | HTTPValidationError]
   """
 
   kwargs = _get_kwargs(
     graph_id=graph_id,
-    subgraph_id=subgraph_id,
+    subgraph_name=subgraph_name,
     body=body,
   )
 
@@ -243,11 +261,11 @@ async def asyncio_detailed(
 
 async def asyncio(
   graph_id: str,
-  subgraph_id: str,
+  subgraph_name: str,
   *,
   client: AuthenticatedClient,
   body: DeleteSubgraphRequest,
-) -> Optional[Union[Any, DeleteSubgraphResponse, HTTPValidationError]]:
+) -> Any | DeleteSubgraphResponse | HTTPValidationError | None:
   """Delete Subgraph
 
    Delete a subgraph database.
@@ -255,6 +273,7 @@ async def asyncio(
   **Requirements:**
   - Must be a valid subgraph (not parent graph)
   - User must have admin access to parent graph
+  - Subgraph name must be alphanumeric (1-20 characters)
   - Optional backup before deletion
 
   **Deletion Options:**
@@ -269,9 +288,14 @@ async def asyncio(
   If backup requested, stored in S3 Kuzu database bucket at:
   `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
 
+  **Notes:**
+  - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
+  - Deletion does not affect parent graph's credit pool or permissions
+  - Backup creation consumes credits from parent graph's allocation
+
   Args:
       graph_id (str):
-      subgraph_id (str): Subgraph identifier to delete
+      subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
       body (DeleteSubgraphRequest): Request model for deleting a subgraph.
 
   Raises:
@@ -279,13 +303,13 @@ async def asyncio(
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Union[Any, DeleteSubgraphResponse, HTTPValidationError]
+      Any | DeleteSubgraphResponse | HTTPValidationError
   """
 
   return (
     await asyncio_detailed(
       graph_id=graph_id,
-      subgraph_id=subgraph_id,
+      subgraph_name=subgraph_name,
       client=client,
       body=body,
     )