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

robosystems_client/api/schema/get_graph_schema.py

@@ -5,49 +5,27 @@ import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.get_graph_schema_response_getgraphschema import (
-  GetGraphSchemaResponseGetgraphschema,
-)
 from ...models.http_validation_error import HTTPValidationError
-from ...types import UNSET, Response, Unset
+from ...models.schema_info_response import SchemaInfoResponse
+from ...types import Response
 
 
 def _get_kwargs(
   graph_id: str,
-  *,
-  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] = {}
-
-  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] = {
     "method": "get",
     "url": f"/v1/graphs/{graph_id}/schema",
-    "params": params,
   }
 
-  _kwargs["headers"] = headers
   return _kwargs
 
 
 def _parse_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]:
+) -> Optional[Union[Any, HTTPValidationError, SchemaInfoResponse]]:
   if response.status_code == 200:
-    response_200 = GetGraphSchemaResponseGetgraphschema.from_dict(response.json())
+    response_200 = SchemaInfoResponse.from_dict(response.json())
 
     return response_200
 
@@ -64,6 +42,10 @@ def _parse_response(
     response_500 = cast(Any, None)
     return response_500
 
+  if response.status_code == 504:
+    response_504 = cast(Any, None)
+    return response_504
+
   if client.raise_on_unexpected_status:
     raise errors.UnexpectedStatus(response.status_code, response.content)
   else:
@@ -72,7 +54,7 @@ def _parse_response(
 
 def _build_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]:
+) -> Response[Union[Any, HTTPValidationError, SchemaInfoResponse]]:
   return Response(
     status_code=HTTPStatus(response.status_code),
     content=response.content,
@@ -85,40 +67,59 @@ def sync_detailed(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Response[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]:
+) -> Response[Union[Any, HTTPValidationError, SchemaInfoResponse]]:
   """Get Runtime Graph Schema
 
    Get runtime schema information for the specified graph database.
 
-  This endpoint inspects the actual graph database structure and returns:
+  ## What This Returns
+
+  This endpoint inspects the **actual current state** of the graph database and returns:
   - **Node Labels**: All node types currently in the database
   - **Relationship Types**: All relationship types currently in the database
-  - **Node Properties**: Properties for each node type (limited to first 10 for performance)
+  - **Node Properties**: Properties discovered from actual data (up to 10 properties per node type)
+
+  ## Runtime vs Declared Schema
 
-  This shows what actually exists in the database right now - the runtime state.
-  For the declared schema definition, use GET /schema/export instead.
+  **Use this endpoint** (`/schema`) when you need to know:
+  - What data is ACTUALLY in the database right now
+  - What properties exist on real nodes
+  - What relationships have been created
+  - Current database structure for querying
+
+  **Use `/schema/export` instead** when you need:
+  - The original schema definition used to create the graph
+  - Schema in a specific format (JSON, YAML, Cypher DDL)
+  - Schema for documentation or version control
+  - Schema to replicate in another graph
+
+  ## Example Use Cases
+
+  - **Building queries**: See what node labels and properties exist to write accurate Cypher
+  - **Data exploration**: Discover what's in an unfamiliar graph
+  - **Schema drift detection**: Compare runtime vs declared schema
+  - **API integration**: Dynamically adapt to current graph structure
+
+  ## Performance Note
+
+  Property discovery is limited to 10 properties per node type for performance.
+  For complete schema definitions, use `/schema/export`.
 
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): The graph database to get schema for
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Response[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]
+      Response[Union[Any, HTTPValidationError, SchemaInfoResponse]]
   """
 
   kwargs = _get_kwargs(
     graph_id=graph_id,
-    token=token,
-    authorization=authorization,
   )
 
   response = client.get_httpx_client().request(
@@ -132,41 +133,60 @@ def sync(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Optional[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]:
+) -> Optional[Union[Any, HTTPValidationError, SchemaInfoResponse]]:
   """Get Runtime Graph Schema
 
    Get runtime schema information for the specified graph database.
 
-  This endpoint inspects the actual graph database structure and returns:
+  ## What This Returns
+
+  This endpoint inspects the **actual current state** of the graph database and returns:
   - **Node Labels**: All node types currently in the database
   - **Relationship Types**: All relationship types currently in the database
-  - **Node Properties**: Properties for each node type (limited to first 10 for performance)
+  - **Node Properties**: Properties discovered from actual data (up to 10 properties per node type)
+
+  ## Runtime vs Declared Schema
+
+  **Use this endpoint** (`/schema`) when you need to know:
+  - What data is ACTUALLY in the database right now
+  - What properties exist on real nodes
+  - What relationships have been created
+  - Current database structure for querying
+
+  **Use `/schema/export` instead** when you need:
+  - The original schema definition used to create the graph
+  - Schema in a specific format (JSON, YAML, Cypher DDL)
+  - Schema for documentation or version control
+  - Schema to replicate in another graph
 
-  This shows what actually exists in the database right now - the runtime state.
-  For the declared schema definition, use GET /schema/export instead.
+  ## Example Use Cases
+
+  - **Building queries**: See what node labels and properties exist to write accurate Cypher
+  - **Data exploration**: Discover what's in an unfamiliar graph
+  - **Schema drift detection**: Compare runtime vs declared schema
+  - **API integration**: Dynamically adapt to current graph structure
+
+  ## Performance Note
+
+  Property discovery is limited to 10 properties per node type for performance.
+  For complete schema definitions, use `/schema/export`.
 
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): The graph database to get schema for
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]
+      Union[Any, HTTPValidationError, SchemaInfoResponse]
   """
 
   return sync_detailed(
     graph_id=graph_id,
     client=client,
-    token=token,
-    authorization=authorization,
   ).parsed
 
 
@@ -174,40 +194,59 @@ async def asyncio_detailed(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Response[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]:
+) -> Response[Union[Any, HTTPValidationError, SchemaInfoResponse]]:
   """Get Runtime Graph Schema
 
    Get runtime schema information for the specified graph database.
 
-  This endpoint inspects the actual graph database structure and returns:
+  ## What This Returns
+
+  This endpoint inspects the **actual current state** of the graph database and returns:
   - **Node Labels**: All node types currently in the database
   - **Relationship Types**: All relationship types currently in the database
-  - **Node Properties**: Properties for each node type (limited to first 10 for performance)
+  - **Node Properties**: Properties discovered from actual data (up to 10 properties per node type)
+
+  ## Runtime vs Declared Schema
+
+  **Use this endpoint** (`/schema`) when you need to know:
+  - What data is ACTUALLY in the database right now
+  - What properties exist on real nodes
+  - What relationships have been created
+  - Current database structure for querying
+
+  **Use `/schema/export` instead** when you need:
+  - The original schema definition used to create the graph
+  - Schema in a specific format (JSON, YAML, Cypher DDL)
+  - Schema for documentation or version control
+  - Schema to replicate in another graph
+
+  ## Example Use Cases
+
+  - **Building queries**: See what node labels and properties exist to write accurate Cypher
+  - **Data exploration**: Discover what's in an unfamiliar graph
+  - **Schema drift detection**: Compare runtime vs declared schema
+  - **API integration**: Dynamically adapt to current graph structure
 
-  This shows what actually exists in the database right now - the runtime state.
-  For the declared schema definition, use GET /schema/export instead.
+  ## Performance Note
+
+  Property discovery is limited to 10 properties per node type for performance.
+  For complete schema definitions, use `/schema/export`.
 
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): The graph database to get schema for
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Response[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]
+      Response[Union[Any, HTTPValidationError, SchemaInfoResponse]]
   """
 
   kwargs = _get_kwargs(
     graph_id=graph_id,
-    token=token,
-    authorization=authorization,
   )
 
   response = await client.get_async_httpx_client().request(**kwargs)
@@ -219,41 +258,60 @@ async def asyncio(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Optional[Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]]:
+) -> Optional[Union[Any, HTTPValidationError, SchemaInfoResponse]]:
   """Get Runtime Graph Schema
 
    Get runtime schema information for the specified graph database.
 
-  This endpoint inspects the actual graph database structure and returns:
+  ## What This Returns
+
+  This endpoint inspects the **actual current state** of the graph database and returns:
   - **Node Labels**: All node types currently in the database
   - **Relationship Types**: All relationship types currently in the database
-  - **Node Properties**: Properties for each node type (limited to first 10 for performance)
+  - **Node Properties**: Properties discovered from actual data (up to 10 properties per node type)
+
+  ## Runtime vs Declared Schema
+
+  **Use this endpoint** (`/schema`) when you need to know:
+  - What data is ACTUALLY in the database right now
+  - What properties exist on real nodes
+  - What relationships have been created
+  - Current database structure for querying
+
+  **Use `/schema/export` instead** when you need:
+  - The original schema definition used to create the graph
+  - Schema in a specific format (JSON, YAML, Cypher DDL)
+  - Schema for documentation or version control
+  - Schema to replicate in another graph
+
+  ## Example Use Cases
+
+  - **Building queries**: See what node labels and properties exist to write accurate Cypher
+  - **Data exploration**: Discover what's in an unfamiliar graph
+  - **Schema drift detection**: Compare runtime vs declared schema
+  - **API integration**: Dynamically adapt to current graph structure
+
+  ## Performance Note
 
-  This shows what actually exists in the database right now - the runtime state.
-  For the declared schema definition, use GET /schema/export instead.
+  Property discovery is limited to 10 properties per node type for performance.
+  For complete schema definitions, use `/schema/export`.
 
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): The graph database to get schema for
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
       httpx.TimeoutException: If the request takes longer than Client.timeout.
 
   Returns:
-      Union[Any, GetGraphSchemaResponseGetgraphschema, HTTPValidationError]
+      Union[Any, HTTPValidationError, SchemaInfoResponse]
   """
 
   return (
     await asyncio_detailed(
       graph_id=graph_id,
       client=client,
-      token=token,
-      authorization=authorization,
     )
   ).parsed

robosystems_client/api/schema/validate_schema.py

@@ -8,35 +8,19 @@ from ...client import AuthenticatedClient, Client
 from ...models.error_response import ErrorResponse
 from ...models.schema_validation_request import SchemaValidationRequest
 from ...models.schema_validation_response import SchemaValidationResponse
-from ...types import UNSET, Response, Unset
+from ...types import Response
 
 
 def _get_kwargs(
   graph_id: str,
   *,
   body: SchemaValidationRequest,
-  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] = {}
-
-  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] = {
     "method": "post",
     "url": f"/v1/graphs/{graph_id}/schema/validate",
-    "params": params,
   }
 
   _kwargs["json"] = body.to_dict()
@@ -97,8 +81,6 @@ def sync_detailed(
   *,
   client: AuthenticatedClient,
   body: SchemaValidationRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[ErrorResponse, SchemaValidationResponse]]:
   """Validate Schema
 
@@ -126,9 +108,7 @@ def sync_detailed(
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): Graph database identifier
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (SchemaValidationRequest): Request model for schema validation.
 
   Raises:
@@ -142,8 +122,6 @@ def sync_detailed(
   kwargs = _get_kwargs(
     graph_id=graph_id,
     body=body,
-    token=token,
-    authorization=authorization,
   )
 
   response = client.get_httpx_client().request(
@@ -158,8 +136,6 @@ def sync(
   *,
   client: AuthenticatedClient,
   body: SchemaValidationRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[ErrorResponse, SchemaValidationResponse]]:
   """Validate Schema
 
@@ -187,9 +163,7 @@ def sync(
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): Graph database identifier
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (SchemaValidationRequest): Request model for schema validation.
 
   Raises:
@@ -204,8 +178,6 @@ def sync(
     graph_id=graph_id,
     client=client,
     body=body,
-    token=token,
-    authorization=authorization,
   ).parsed
 
 
@@ -214,8 +186,6 @@ async def asyncio_detailed(
   *,
   client: AuthenticatedClient,
   body: SchemaValidationRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[ErrorResponse, SchemaValidationResponse]]:
   """Validate Schema
 
@@ -243,9 +213,7 @@ async def asyncio_detailed(
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): Graph database identifier
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (SchemaValidationRequest): Request model for schema validation.
 
   Raises:
@@ -259,8 +227,6 @@ async def asyncio_detailed(
   kwargs = _get_kwargs(
     graph_id=graph_id,
     body=body,
-    token=token,
-    authorization=authorization,
   )
 
   response = await client.get_async_httpx_client().request(**kwargs)
@@ -273,8 +239,6 @@ async def asyncio(
   *,
   client: AuthenticatedClient,
   body: SchemaValidationRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[ErrorResponse, SchemaValidationResponse]]:
   """Validate Schema
 
@@ -302,9 +266,7 @@ async def asyncio(
   This operation is included - no credit consumption required.
 
   Args:
-      graph_id (str): Graph database identifier
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (SchemaValidationRequest): Request model for schema validation.
 
   Raises:
@@ -320,7 +282,5 @@ async def asyncio(
       graph_id=graph_id,
       client=client,
       body=body,
-      token=token,
-      authorization=authorization,
     )
   ).parsed

robosystems_client/api/subgraphs/create_subgraph.py

@@ -8,35 +8,19 @@ from ...client import AuthenticatedClient, Client
 from ...models.create_subgraph_request import CreateSubgraphRequest
 from ...models.http_validation_error import HTTPValidationError
 from ...models.subgraph_response import SubgraphResponse
-from ...types import UNSET, Response, Unset
+from ...types import Response
 
 
 def _get_kwargs(
   graph_id: str,
   *,
   body: CreateSubgraphRequest,
-  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] = {}
-
-  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] = {
     "method": "post",
     "url": f"/v1/graphs/{graph_id}/subgraphs",
-    "params": params,
   }
 
   _kwargs["json"] = body.to_dict()
@@ -82,8 +66,6 @@ def sync_detailed(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[HTTPValidationError, SubgraphResponse]]:
   """Create Subgraph
 
@@ -101,9 +83,7 @@ def sync_detailed(
   - Created subgraph details including its unique ID
 
   Args:
-      graph_id (str): Parent graph ID (e.g., 'kg1a2b3c4d5')
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (CreateSubgraphRequest): Request model for creating a subgraph.
 
   Raises:
@@ -117,8 +97,6 @@ def sync_detailed(
   kwargs = _get_kwargs(
     graph_id=graph_id,
     body=body,
-    token=token,
-    authorization=authorization,
   )
 
   response = client.get_httpx_client().request(
@@ -133,8 +111,6 @@ def sync(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[HTTPValidationError, SubgraphResponse]]:
   """Create Subgraph
 
@@ -152,9 +128,7 @@ def sync(
   - Created subgraph details including its unique ID
 
   Args:
-      graph_id (str): Parent graph ID (e.g., 'kg1a2b3c4d5')
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (CreateSubgraphRequest): Request model for creating a subgraph.
 
   Raises:
@@ -169,8 +143,6 @@ def sync(
     graph_id=graph_id,
     client=client,
     body=body,
-    token=token,
-    authorization=authorization,
   ).parsed
 
 
@@ -179,8 +151,6 @@ async def asyncio_detailed(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[HTTPValidationError, SubgraphResponse]]:
   """Create Subgraph
 
@@ -198,9 +168,7 @@ async def asyncio_detailed(
   - Created subgraph details including its unique ID
 
   Args:
-      graph_id (str): Parent graph ID (e.g., 'kg1a2b3c4d5')
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (CreateSubgraphRequest): Request model for creating a subgraph.
 
   Raises:
@@ -214,8 +182,6 @@ async def asyncio_detailed(
   kwargs = _get_kwargs(
     graph_id=graph_id,
     body=body,
-    token=token,
-    authorization=authorization,
   )
 
   response = await client.get_async_httpx_client().request(**kwargs)
@@ -228,8 +194,6 @@ async def asyncio(
   *,
   client: AuthenticatedClient,
   body: CreateSubgraphRequest,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[HTTPValidationError, SubgraphResponse]]:
   """Create Subgraph
 
@@ -247,9 +211,7 @@ async def asyncio(
   - Created subgraph details including its unique ID
 
   Args:
-      graph_id (str): Parent graph ID (e.g., 'kg1a2b3c4d5')
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+      graph_id (str):
       body (CreateSubgraphRequest): Request model for creating a subgraph.
 
   Raises:
@@ -265,7 +227,5 @@ async def asyncio(
       graph_id=graph_id,
       client=client,
       body=body,
-      token=token,
-      authorization=authorization,
     )
   ).parsed