cribl-control-plane 0.0.31__py3-none-any.whl → 0.0.32__py3-none-any.whl

cribl_control_plane/lakedatasets.py

@@ -37,11 +37,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateCriblLakeDatasetByLakeIDResponse:
-        r"""Create a Lake Dataset in the specified Lake
+        r"""Create a Lake Dataset
 
-        Create a Dataset in the specified Lake
+        Create a new Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake to create the Lake Dataset in.
         :param id:
         :param accelerated_fields:
         :param bucket_name:
@@ -181,11 +181,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateCriblLakeDatasetByLakeIDResponse:
-        r"""Create a Lake Dataset in the specified Lake
+        r"""Create a Lake Dataset
 
-        Create a Dataset in the specified Lake
+        Create a new Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake to create the Lake Dataset in.
         :param id:
         :param accelerated_fields:
         :param bucket_name:
@@ -307,11 +307,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDResponse:
-        r"""List all Lake Datasets in the specified Lake
+        r"""List all Lake Datasets
 
-        Get the list of Dataset contained in the specified Lake
+        Get a list of all Lake Datasets in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Datasets to list.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -396,11 +396,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDResponse:
-        r"""List all Lake Datasets in the specified Lake
+        r"""List all Lake Datasets
 
-        Get the list of Dataset contained in the specified Lake
+        Get a list of all Lake Datasets in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Datasets to list.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -486,12 +486,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeleteCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Delete a Lake Dataset in the specified Lake
+        r"""Delete a Lake Dataset
 
-        Delete a Dataset in the specified Lake
+        Delete the specified Lake Dataset in the specified Lake
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to delete
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to delete.
+        :param id: The <code>id</code> of the Lake Dataset to delete.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -578,12 +578,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeleteCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Delete a Lake Dataset in the specified Lake
+        r"""Delete a Lake Dataset
 
-        Delete a Dataset in the specified Lake
+        Delete the specified Lake Dataset in the specified Lake
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to delete
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to delete.
+        :param id: The <code>id</code> of the Lake Dataset to delete.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -670,12 +670,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Retrieve a Lake Dataset in the specified Lake
+        r"""Get a Lake Dataset
 
-        Get a Dataset in the specified Lake
+        Get the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to get
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to get.
+        :param id: The <code>id</code> of the Lake Dataset to get.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -762,12 +762,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Retrieve a Lake Dataset in the specified Lake
+        r"""Get a Lake Dataset
 
-        Get a Dataset in the specified Lake
+        Get the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to get
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to get.
+        :param id: The <code>id</code> of the Lake Dataset to get.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -872,12 +872,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Update a Lake Dataset in the specified Lake
+        r"""Update a Lake Dataset
 
-        Update a Dataset in the specified Lake
+        Update the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id_param: dataset id to update
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to update.
+        :param id_param: The <code>id</code> of the Lake Dataset to update.
         :param id:
         :param accelerated_fields:
         :param bucket_name:
@@ -1019,12 +1019,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Update a Lake Dataset in the specified Lake
+        r"""Update a Lake Dataset
 
-        Update a Dataset in the specified Lake
+        Update the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id_param: dataset id to update
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to update.
+        :param id_param: The <code>id</code> of the Lake Dataset to update.
         :param id:
         :param accelerated_fields:
         :param bucket_name:

cribl_control_plane/models/createcribllakedatasetbylakeidop.py

@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class CreateCriblLakeDatasetByLakeIDRequestTypedDict(TypedDict):
     lake_id: str
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake to create the Lake Dataset in."""
     cribl_lake_dataset: CriblLakeDatasetTypedDict
     r"""CriblLakeDataset object"""
 
@@ -22,7 +22,7 @@ class CreateCriblLakeDatasetByLakeIDRequest(BaseModel):
         pydantic.Field(alias="lakeId"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake to create the Lake Dataset in."""
 
     cribl_lake_dataset: Annotated[
         CriblLakeDataset,

cribl_control_plane/models/createinputhectokenbyidop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class CreateInputHecTokenByIDRequestTypedDict(TypedDict):
     id: str
-    r"""HEC Source id"""
+    r"""The <code>id</code> of the Splunk HEC Source."""
     add_hec_token_request: AddHecTokenRequestTypedDict
     r"""AddHecTokenRequest object"""
 
@@ -19,7 +19,7 @@ class CreateInputHecTokenByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""HEC Source id"""
+    r"""The <code>id</code> of the Splunk HEC Source."""
 
     add_hec_token_request: Annotated[
         AddHecTokenRequest,

cribl_control_plane/models/createoutputtestbyidop.py

@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class CreateOutputTestByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to send sample event data to."""
     output_test_request: OutputTestRequestTypedDict
     r"""OutputTestRequest object"""
 
@@ -20,7 +20,7 @@ class CreateOutputTestByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to send sample event data to."""
 
     output_test_request: Annotated[
         OutputTestRequest,

cribl_control_plane/models/createversionundoop.py

@@ -9,7 +9,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class CreateVersionUndoRequestTypedDict(TypedDict):
     group: NotRequired[str]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to undo the uncommited changes for."""
 
 
 class CreateVersionUndoRequest(BaseModel):
@@ -17,7 +17,7 @@ class CreateVersionUndoRequest(BaseModel):
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to undo the uncommited changes for."""
 
 
 class CreateVersionUndoResponseTypedDict(TypedDict):

cribl_control_plane/models/deletecribllakedatasetbylakeidandidop.py

@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class DeleteCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
     lake_id: str
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake that contains the Lake Dataset to delete."""
     id: str
-    r"""dataset id to delete"""
+    r"""The <code>id</code> of the Lake Dataset to delete."""
 
 
 class DeleteCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
@@ -22,12 +22,12 @@ class DeleteCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
         pydantic.Field(alias="lakeId"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake that contains the Lake Dataset to delete."""
 
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""dataset id to delete"""
+    r"""The <code>id</code> of the Lake Dataset to delete."""
 
 
 class DeleteCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):

cribl_control_plane/models/deleteinputbyidop.py

@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class DeleteInputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to DELETE"""
+    r"""The <code>id</code> of the Source to delete."""
 
 
 class DeleteInputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to DELETE"""
+    r"""The <code>id</code> of the Source to delete."""
 
 
 class DeleteInputByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/deleteoutputbyidop.py

@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class DeleteOutputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to DELETE"""
+    r"""The <code>id</code> of the Destination to delete."""
 
 
 class DeleteOutputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to DELETE"""
+    r"""The <code>id</code> of the Destination to delete."""
 
 
 class DeleteOutputByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/deleteoutputpqbyidop.py

@@ -9,14 +9,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class DeleteOutputPqByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to clear the PQ for."""
 
 
 class DeleteOutputPqByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to clear the PQ for."""
 
 
 class DeleteOutputPqByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/deletepacksbyidop.py

@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class DeletePacksByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Pack name"""
+    r"""The <code>id</code> of the Pack to uninstall."""
 
 
 class DeletePacksByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Pack name"""
+    r"""The <code>id</code> of the Pack to uninstall."""
 
 
 class DeletePacksByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py

@@ -21,7 +21,7 @@ class GetConfigGroupACLTeamsByProductAndIDProduct(str, Enum):
 
 
 class GetConfigGroupACLTeamsByProductAndIDType(str, Enum):
-    r"""resource type by which to filter access levels"""
+    r"""Filter for limiting the response to ACL entries for the specified RBAC resource type."""
 
     GROUPS = "groups"
     DATASETS = "datasets"
@@ -39,7 +39,7 @@ class GetConfigGroupACLTeamsByProductAndIDRequestTypedDict(TypedDict):
     id: str
     r"""The <code>id</code> of the Worker Group or Edge Fleet to get the team ACL for."""
     type: NotRequired[GetConfigGroupACLTeamsByProductAndIDType]
-    r"""resource type by which to filter access levels"""
+    r"""Filter for limiting the response to ACL entries for the specified RBAC resource type."""
 
 
 class GetConfigGroupACLTeamsByProductAndIDRequest(BaseModel):
@@ -58,7 +58,7 @@ class GetConfigGroupACLTeamsByProductAndIDRequest(BaseModel):
         Optional[GetConfigGroupACLTeamsByProductAndIDType],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""resource type by which to filter access levels"""
+    r"""Filter for limiting the response to ACL entries for the specified RBAC resource type."""
 
 
 class GetConfigGroupACLTeamsByProductAndIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getcribllakedatasetbylakeidandidop.py

@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
     lake_id: str
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake that contains the Lake Dataset to get."""
     id: str
-    r"""dataset id to get"""
+    r"""The <code>id</code> of the Lake Dataset to get."""
 
 
 class GetCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
@@ -22,12 +22,12 @@ class GetCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
         pydantic.Field(alias="lakeId"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake that contains the Lake Dataset to get."""
 
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""dataset id to get"""
+    r"""The <code>id</code> of the Lake Dataset to get."""
 
 
 class GetCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getcribllakedatasetbylakeidop.py

@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetCriblLakeDatasetByLakeIDRequestTypedDict(TypedDict):
     lake_id: str
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake that contains the Lake Datasets to list."""
 
 
 class GetCriblLakeDatasetByLakeIDRequest(BaseModel):
@@ -20,7 +20,7 @@ class GetCriblLakeDatasetByLakeIDRequest(BaseModel):
         pydantic.Field(alias="lakeId"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""lake id that contains the Datasets"""
+    r"""The <code>id</code> of the Lake that contains the Lake Datasets to list."""
 
 
 class GetCriblLakeDatasetByLakeIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getinputbyidop.py

@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetInputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Source to get."""
 
 
 class GetInputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Source to get."""
 
 
 class GetInputByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getmasterworkerentryop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetMasterWorkerEntryRequestTypedDict(TypedDict):
     filter_exp: NotRequired[str]
-    r"""Filter expression evaluated against nodes"""
+    r"""Filter expression to evaluate against Nodes for inclusion in the response."""
 
 
 class GetMasterWorkerEntryRequest(BaseModel):
@@ -19,7 +19,7 @@ class GetMasterWorkerEntryRequest(BaseModel):
         pydantic.Field(alias="filterExp"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Filter expression evaluated against nodes"""
+    r"""Filter expression to evaluate against Nodes for inclusion in the response."""
 
 
 class GetMasterWorkerEntryResponseTypedDict(TypedDict):

cribl_control_plane/models/getoutputbyidop.py

@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetOutputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Destination to get."""
 
 
 class GetOutputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to GET"""
+    r"""The <code>id</code> of the Destination to get."""
 
 
 class GetOutputByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getoutputpqbyidop.py

@@ -9,14 +9,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetOutputPqByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to get PQ job information for."""
 
 
 class GetOutputPqByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to get PQ job information for."""
 
 
 class GetOutputPqByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getoutputsamplesbyidop.py

@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetOutputSamplesByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to get sample event data for."""
 
 
 class GetOutputSamplesByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Destination Id"""
+    r"""The <code>id</code> of the Destination to get sample event data for."""
 
 
 class GetOutputSamplesByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/getpacksop.py

@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetPacksRequestTypedDict(TypedDict):
     with_: NotRequired[str]
-    r"""Comma separated list of entities, \"outputs\", \"inputs\" """
+    r"""Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>."""
 
 
 class GetPacksRequest(BaseModel):
@@ -20,7 +20,7 @@ class GetPacksRequest(BaseModel):
         pydantic.Field(alias="with"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Comma separated list of entities, \"outputs\", \"inputs\" """
+    r"""Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>."""
 
 
 class GetPacksResponseTypedDict(TypedDict):

cribl_control_plane/models/getsummaryop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class GetSummaryMode(str, Enum):
-    r"""product filter"""
+    r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
 
     WORKER = "worker"
     MANAGED_EDGE = "managed-edge"
@@ -18,7 +18,7 @@ class GetSummaryMode(str, Enum):
 
 class GetSummaryRequestTypedDict(TypedDict):
     mode: NotRequired[GetSummaryMode]
-    r"""product filter"""
+    r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
 
 
 class GetSummaryRequest(BaseModel):
@@ -26,7 +26,7 @@ class GetSummaryRequest(BaseModel):
         Optional[GetSummaryMode],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""product filter"""
+    r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
 
 
 class GetSummaryResponseTypedDict(TypedDict):

cribl_control_plane/models/getversioncountop.py

@@ -10,9 +10,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetVersionCountRequestTypedDict(TypedDict):
     group: NotRequired[str]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the count for."""
     id: NotRequired[str]
-    r"""Commit ID"""
+    r"""The Git commit hash to use as the starting point for the count."""
 
 
 class GetVersionCountRequest(BaseModel):
@@ -20,14 +20,14 @@ class GetVersionCountRequest(BaseModel):
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the count for."""
 
     id: Annotated[
         Optional[str],
         pydantic.Field(alias="ID"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit ID"""
+    r"""The Git commit hash to use as the starting point for the count."""
 
 
 class GetVersionCountResponseTypedDict(TypedDict):

cribl_control_plane/models/getversiondiffop.py

@@ -10,13 +10,13 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetVersionDiffRequestTypedDict(TypedDict):
     commit: NotRequired[str]
-    r"""Commit hash (default is HEAD)"""
+    r"""The Git commit hash to get the diff for."""
     group: NotRequired[str]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff for."""
     filename: NotRequired[str]
-    r"""Filename"""
+    r"""The relative path of the file to get the diff for."""
     diff_line_limit: NotRequired[float]
-    r"""Limit maximum lines in the diff"""
+    r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
 
 
 class GetVersionDiffRequest(BaseModel):
@@ -24,26 +24,26 @@ class GetVersionDiffRequest(BaseModel):
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit hash (default is HEAD)"""
+    r"""The Git commit hash to get the diff for."""
 
     group: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff for."""
 
     filename: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Filename"""
+    r"""The relative path of the file to get the diff for."""
 
     diff_line_limit: Annotated[
         Optional[float],
         pydantic.Field(alias="diffLineLimit"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Limit maximum lines in the diff"""
+    r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
 
 
 class GetVersionDiffResponseTypedDict(TypedDict):