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

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):

cribl_control_plane/models/getversionfilesop.py

@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetVersionFilesRequestTypedDict(TypedDict):
     group: NotRequired[str]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
     id: NotRequired[str]
-    r"""Commit ID"""
+    r"""The Git commit hash to use as the starting point for the request."""
 
 
 class GetVersionFilesRequest(BaseModel):
@@ -21,14 +21,14 @@ class GetVersionFilesRequest(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 file names and status 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 request."""
 
 
 class GetVersionFilesResponseTypedDict(TypedDict):

cribl_control_plane/models/getversionop.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .gitlogresult import GitLogResult, GitLogResultTypedDict
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetVersionRequestTypedDict(TypedDict):
+    group: NotRequired[str]
+    r"""Group ID"""
+    count: NotRequired[float]
+    r"""Maximum number of commits to return"""
+
+
+class GetVersionRequest(BaseModel):
+    group: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Group ID"""
+
+    count: Annotated[
+        Optional[float],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of commits to return"""
+
+
+class GetVersionResponseTypedDict(TypedDict):
+    r"""a list of GitLogResult objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[GitLogResultTypedDict]]
+
+
+class GetVersionResponse(BaseModel):
+    r"""a list of GitLogResult objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[GitLogResult]] = None

cribl_control_plane/models/getversionshowop.py

@@ -10,13 +10,13 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetVersionShowRequestTypedDict(TypedDict):
     commit: NotRequired[str]
-    r"""Commit hash (default is HEAD)"""
+    r"""The Git commit hash to retrieve the diff and log message for."""
     group: NotRequired[str]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
     filename: NotRequired[str]
-    r"""Filename"""
+    r"""The relative path of the file to get the diff and log message 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 GetVersionShowRequest(BaseModel):
@@ -24,26 +24,26 @@ class GetVersionShowRequest(BaseModel):
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Commit hash (default is HEAD)"""
+    r"""The Git commit hash to retrieve the diff and log message 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 and log message 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 and log message 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 GetVersionShowResponseTypedDict(TypedDict):

cribl_control_plane/models/getversionstatusop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class GetVersionStatusRequestTypedDict(TypedDict):
     group: NotRequired[str]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to get the status for."""
 
 
 class GetVersionStatusRequest(BaseModel):
@@ -18,7 +18,7 @@ class GetVersionStatusRequest(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 status for."""
 
 
 class GetVersionStatusResponseTypedDict(TypedDict):

cribl_control_plane/models/gitlogresult.py

@@ -0,0 +1,33 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GitLogResultTypedDict(TypedDict):
+    author_email: NotRequired[str]
+    author_name: NotRequired[str]
+    body: NotRequired[str]
+    date_: NotRequired[str]
+    hash: NotRequired[str]
+    message: NotRequired[str]
+    refs: NotRequired[str]
+
+
+class GitLogResult(BaseModel):
+    author_email: Optional[str] = None
+
+    author_name: Optional[str] = None
+
+    body: Optional[str] = None
+
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+
+    hash: Optional[str] = None
+
+    message: Optional[str] = None
+
+    refs: Optional[str] = None

cribl_control_plane/models/listmasterworkerentryop.py

@@ -11,17 +11,17 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class ListMasterWorkerEntryRequestTypedDict(TypedDict):
     filter_exp: NotRequired[str]
-    r"""Filter expression evaluated against nodes"""
-    sort: NotRequired[str]
-    r"""Sorting object (JSON stringified) expression evaluated against nodes"""
+    r"""Filter expression to evaluate against Nodes for inclusion in the response."""
     sort_exp: NotRequired[str]
-    r"""Sorting expression evaluated against nodes"""
+    r"""Sorting expression to evaluate against Nodes to specify the sort order for the response."""
+    filter_: NotRequired[str]
+    r"""JSON-stringified filter object to evaluate against Nodes for inclusion in the response."""
+    sort: NotRequired[str]
+    r"""JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response."""
     limit: NotRequired[int]
-    r"""Maximum number of nodes to return"""
+    r"""Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches."""
     offset: NotRequired[int]
-    r"""Pagination offset"""
-    filter_: NotRequired[str]
-    r"""Filter object (JSON stringified) to select nodes"""
+    r"""Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches."""
 
 
 class ListMasterWorkerEntryRequest(BaseModel):
@@ -30,39 +30,39 @@ class ListMasterWorkerEntryRequest(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."""
 
-    sort: Annotated[
+    sort_exp: Annotated[
         Optional[str],
+        pydantic.Field(alias="sortExp"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Sorting object (JSON stringified) expression evaluated against nodes"""
+    r"""Sorting expression to evaluate against Nodes to specify the sort order for the response."""
 
-    sort_exp: Annotated[
+    filter_: Annotated[
         Optional[str],
-        pydantic.Field(alias="sortExp"),
+        pydantic.Field(alias="filter"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Sorting expression evaluated against nodes"""
+    r"""JSON-stringified filter object to evaluate against Nodes for inclusion in the response."""
 
-    limit: Annotated[
-        Optional[int],
+    sort: Annotated[
+        Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Maximum number of nodes to return"""
+    r"""JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response."""
 
-    offset: Annotated[
+    limit: Annotated[
         Optional[int],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Pagination offset"""
+    r"""Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches."""
 
-    filter_: Annotated[
-        Optional[str],
-        pydantic.Field(alias="filter"),
+    offset: Annotated[
+        Optional[int],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Filter object (JSON stringified) to select nodes"""
+    r"""Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches."""
 
 
 class ListMasterWorkerEntryResponseTypedDict(TypedDict):

cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py

@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdateCriblLakeDatasetByLakeIDAndIDRequestTypedDict(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 update."""
     id_param: str
-    r"""dataset id to update"""
+    r"""The <code>id</code> of the Lake Dataset to update."""
     cribl_lake_dataset: CriblLakeDatasetTypedDict
     r"""CriblLakeDataset object"""
 
@@ -24,14 +24,14 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequest(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 update."""
 
     id_param: Annotated[
         str,
         pydantic.Field(alias="id"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""dataset id to update"""
+    r"""The <code>id</code> of the Lake Dataset to update."""
 
     cribl_lake_dataset: Annotated[
         CriblLakeDataset,

cribl_control_plane/models/updateinputbyidop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdateInputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to PATCH"""
+    r"""The <code>id</code> of the Source to update."""
     input: InputTypedDict
     r"""Input object"""
 
@@ -19,7 +19,7 @@ class UpdateInputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to PATCH"""
+    r"""The <code>id</code> of the Source to update."""
 
     input: Annotated[
         Input, FieldMetadata(request=RequestMetadata(media_type="application/json"))

cribl_control_plane/models/updateinputhectokenbyidandtokenop.py

@@ -10,9 +10,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdateInputHecTokenByIDAndTokenRequestTypedDict(TypedDict):
     id: str
-    r"""HEC Source id"""
+    r"""The <code>id</code> of the Splunk HEC Source."""
     token: str
-    r"""token to update"""
+    r"""The <code>id</code> of the HEC token to update."""
     update_hec_token_request: UpdateHecTokenRequestTypedDict
     r"""UpdateHecTokenRequest object"""
 
@@ -21,12 +21,12 @@ class UpdateInputHecTokenByIDAndTokenRequest(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."""
 
     token: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""token to update"""
+    r"""The <code>id</code> of the HEC token to update."""
 
     update_hec_token_request: Annotated[
         UpdateHecTokenRequest,

cribl_control_plane/models/updateoutputbyidop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdateOutputByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Unique ID to PATCH"""
+    r"""The <code>id</code> of the Destination to update."""
     output: OutputTypedDict
     r"""Output object"""
 
@@ -19,7 +19,7 @@ class UpdateOutputByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Unique ID to PATCH"""
+    r"""The <code>id</code> of the Destination to update."""
 
     output: Annotated[
         Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))

cribl_control_plane/models/updatepacksbyidop.py

@@ -14,7 +14,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class UpdatePacksByIDRequestTypedDict(TypedDict):
     id: str
-    r"""Pack name"""
+    r"""The <code>id</code> of the Pack to upgrade."""
     source: NotRequired[str]
     r"""body string required Pack source"""
     minor: NotRequired[str]
@@ -27,7 +27,7 @@ class UpdatePacksByIDRequest(BaseModel):
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Pack name"""
+    r"""The <code>id</code> of the Pack to upgrade."""
 
     source: Annotated[
         Optional[str],