robosystems-client 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

robosystems_client/api/query/execute_cypher_query.py

@@ -16,14 +16,10 @@ def _get_kwargs(
   *,
   body: CypherQueryRequest,
   mode: Union[None, ResponseMode, Unset] = UNSET,
-  chunk_size: Union[Unset, int] = 1000,
+  chunk_size: Union[None, Unset, int] = UNSET,
   test_mode: Union[Unset, bool] = False,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> dict[str, Any]:
   headers: dict[str, Any] = {}
-  if not isinstance(authorization, Unset):
-    headers["authorization"] = authorization
 
   params: dict[str, Any] = {}
 
@@ -36,17 +32,15 @@ def _get_kwargs(
     json_mode = mode
   params["mode"] = json_mode
 
-  params["chunk_size"] = chunk_size
+  json_chunk_size: Union[None, Unset, int]
+  if isinstance(chunk_size, Unset):
+    json_chunk_size = UNSET
+  else:
+    json_chunk_size = chunk_size
+  params["chunk_size"] = json_chunk_size
 
   params["test_mode"] = test_mode
 
-  json_token: Union[None, Unset, str]
-  if isinstance(token, Unset):
-    json_token = UNSET
-  else:
-    json_token = token
-  params["token"] = json_token
-
   params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
   _kwargs: dict[str, Any] = {
@@ -67,11 +61,12 @@ def _parse_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
 ) -> Optional[Union[Any, HTTPValidationError]]:
   if response.status_code == 200:
-    # Check if this is NDJSON - if so, skip parsing (will be handled by client)
     content_type = response.headers.get("content-type", "")
-    stream_format = response.headers.get("x-stream-format", "")
-    if "application/x-ndjson" in content_type or stream_format == "ndjson":
-      return None  # Skip parsing, client will handle NDJSON
+    if (
+      "application/x-ndjson" in content_type
+      or response.headers.get("x-stream-format") == "ndjson"
+    ):
+      return None
     response_200 = response.json()
     return response_200
 
@@ -131,12 +126,10 @@ def sync_detailed(
   client: AuthenticatedClient,
   body: CypherQueryRequest,
   mode: Union[None, ResponseMode, Unset] = UNSET,
-  chunk_size: Union[Unset, int] = 1000,
+  chunk_size: Union[None, Unset, int] = UNSET,
   test_mode: Union[Unset, bool] = False,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[Any, HTTPValidationError]]:
-  """Execute Cypher Query (Read-Only)
+  r"""Execute Cypher Query (Read-Only)
 
    Execute a read-only Cypher query with intelligent response optimization.
 
@@ -146,6 +139,16 @@ def sync_detailed(
   1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
   2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
 
+  **Security Best Practice - Use Parameterized Queries:**
+  ALWAYS use query parameters instead of string interpolation to prevent injection attacks:
+  - ✅ SAFE: `MATCH (n:Entity {type: $entity_type}) RETURN n` with `parameters: {\"entity_type\":
+  \"Company\"}`
+  - ❌ UNSAFE: `MATCH (n:Entity {type: \"Company\"}) RETURN n` with user input concatenated into query
+  string
+
+  Query parameters provide automatic escaping and type safety. All examples in this API use
+  parameterized queries.
+
   This endpoint automatically selects the best execution strategy based on:
   - Query characteristics (size, complexity)
   - Client capabilities (SSE, NDJSON, JSON)
@@ -193,12 +196,10 @@ def sync_detailed(
   Queue position is based on subscription tier for priority.
 
   Args:
-      graph_id (str): Graph database identifier
+      graph_id (str):
       mode (Union[None, ResponseMode, Unset]): Response mode override
-      chunk_size (Union[Unset, int]): Rows per chunk for streaming Default: 1000.
+      chunk_size (Union[None, Unset, int]): Rows per chunk for streaming
       test_mode (Union[Unset, bool]): Enable test mode for better debugging Default: False.
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
       body (CypherQueryRequest): Request model for Cypher query execution.
 
   Raises:
@@ -215,8 +216,6 @@ def sync_detailed(
     mode=mode,
     chunk_size=chunk_size,
     test_mode=test_mode,
-    token=token,
-    authorization=authorization,
   )
 
   response = client.get_httpx_client().request(
@@ -232,12 +231,10 @@ def sync(
   client: AuthenticatedClient,
   body: CypherQueryRequest,
   mode: Union[None, ResponseMode, Unset] = UNSET,
-  chunk_size: Union[Unset, int] = 1000,
+  chunk_size: Union[None, Unset, int] = UNSET,
   test_mode: Union[Unset, bool] = False,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[Any, HTTPValidationError]]:
-  """Execute Cypher Query (Read-Only)
+  r"""Execute Cypher Query (Read-Only)
 
    Execute a read-only Cypher query with intelligent response optimization.
 
@@ -247,6 +244,16 @@ def sync(
   1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
   2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
 
+  **Security Best Practice - Use Parameterized Queries:**
+  ALWAYS use query parameters instead of string interpolation to prevent injection attacks:
+  - ✅ SAFE: `MATCH (n:Entity {type: $entity_type}) RETURN n` with `parameters: {\"entity_type\":
+  \"Company\"}`
+  - ❌ UNSAFE: `MATCH (n:Entity {type: \"Company\"}) RETURN n` with user input concatenated into query
+  string
+
+  Query parameters provide automatic escaping and type safety. All examples in this API use
+  parameterized queries.
+
   This endpoint automatically selects the best execution strategy based on:
   - Query characteristics (size, complexity)
   - Client capabilities (SSE, NDJSON, JSON)
@@ -294,12 +301,10 @@ def sync(
   Queue position is based on subscription tier for priority.
 
   Args:
-      graph_id (str): Graph database identifier
+      graph_id (str):
       mode (Union[None, ResponseMode, Unset]): Response mode override
-      chunk_size (Union[Unset, int]): Rows per chunk for streaming Default: 1000.
+      chunk_size (Union[None, Unset, int]): Rows per chunk for streaming
       test_mode (Union[Unset, bool]): Enable test mode for better debugging Default: False.
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
       body (CypherQueryRequest): Request model for Cypher query execution.
 
   Raises:
@@ -317,8 +322,6 @@ def sync(
     mode=mode,
     chunk_size=chunk_size,
     test_mode=test_mode,
-    token=token,
-    authorization=authorization,
   ).parsed
 
 
@@ -328,12 +331,10 @@ async def asyncio_detailed(
   client: AuthenticatedClient,
   body: CypherQueryRequest,
   mode: Union[None, ResponseMode, Unset] = UNSET,
-  chunk_size: Union[Unset, int] = 1000,
+  chunk_size: Union[None, Unset, int] = UNSET,
   test_mode: Union[Unset, bool] = False,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[Any, HTTPValidationError]]:
-  """Execute Cypher Query (Read-Only)
+  r"""Execute Cypher Query (Read-Only)
 
    Execute a read-only Cypher query with intelligent response optimization.
 
@@ -343,6 +344,16 @@ async def asyncio_detailed(
   1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
   2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
 
+  **Security Best Practice - Use Parameterized Queries:**
+  ALWAYS use query parameters instead of string interpolation to prevent injection attacks:
+  - ✅ SAFE: `MATCH (n:Entity {type: $entity_type}) RETURN n` with `parameters: {\"entity_type\":
+  \"Company\"}`
+  - ❌ UNSAFE: `MATCH (n:Entity {type: \"Company\"}) RETURN n` with user input concatenated into query
+  string
+
+  Query parameters provide automatic escaping and type safety. All examples in this API use
+  parameterized queries.
+
   This endpoint automatically selects the best execution strategy based on:
   - Query characteristics (size, complexity)
   - Client capabilities (SSE, NDJSON, JSON)
@@ -390,12 +401,10 @@ async def asyncio_detailed(
   Queue position is based on subscription tier for priority.
 
   Args:
-      graph_id (str): Graph database identifier
+      graph_id (str):
       mode (Union[None, ResponseMode, Unset]): Response mode override
-      chunk_size (Union[Unset, int]): Rows per chunk for streaming Default: 1000.
+      chunk_size (Union[None, Unset, int]): Rows per chunk for streaming
       test_mode (Union[Unset, bool]): Enable test mode for better debugging Default: False.
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
       body (CypherQueryRequest): Request model for Cypher query execution.
 
   Raises:
@@ -412,8 +421,6 @@ async def asyncio_detailed(
     mode=mode,
     chunk_size=chunk_size,
     test_mode=test_mode,
-    token=token,
-    authorization=authorization,
   )
 
   response = await client.get_async_httpx_client().request(**kwargs)
@@ -427,12 +434,10 @@ async def asyncio(
   client: AuthenticatedClient,
   body: CypherQueryRequest,
   mode: Union[None, ResponseMode, Unset] = UNSET,
-  chunk_size: Union[Unset, int] = 1000,
+  chunk_size: Union[None, Unset, int] = UNSET,
   test_mode: Union[Unset, bool] = False,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[Any, HTTPValidationError]]:
-  """Execute Cypher Query (Read-Only)
+  r"""Execute Cypher Query (Read-Only)
 
    Execute a read-only Cypher query with intelligent response optimization.
 
@@ -442,6 +447,16 @@ async def asyncio(
   1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
   2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
 
+  **Security Best Practice - Use Parameterized Queries:**
+  ALWAYS use query parameters instead of string interpolation to prevent injection attacks:
+  - ✅ SAFE: `MATCH (n:Entity {type: $entity_type}) RETURN n` with `parameters: {\"entity_type\":
+  \"Company\"}`
+  - ❌ UNSAFE: `MATCH (n:Entity {type: \"Company\"}) RETURN n` with user input concatenated into query
+  string
+
+  Query parameters provide automatic escaping and type safety. All examples in this API use
+  parameterized queries.
+
   This endpoint automatically selects the best execution strategy based on:
   - Query characteristics (size, complexity)
   - Client capabilities (SSE, NDJSON, JSON)
@@ -489,12 +504,10 @@ async def asyncio(
   Queue position is based on subscription tier for priority.
 
   Args:
-      graph_id (str): Graph database identifier
+      graph_id (str):
       mode (Union[None, ResponseMode, Unset]): Response mode override
-      chunk_size (Union[Unset, int]): Rows per chunk for streaming Default: 1000.
+      chunk_size (Union[None, Unset, int]): Rows per chunk for streaming
       test_mode (Union[Unset, bool]): Enable test mode for better debugging Default: False.
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
       body (CypherQueryRequest): Request model for Cypher query execution.
 
   Raises:
@@ -513,7 +526,5 @@ async def asyncio(
       mode=mode,
       chunk_size=chunk_size,
       test_mode=test_mode,
-      token=token,
-      authorization=authorization,
     )
   ).parsed