cribl-control-plane 0.1.1rc3__tar.gz → 0.1.1rc5__tar.gz

{cribl_control_plane-0.1.1rc3 → cribl_control_plane-0.1.1rc5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cribl-control-plane
-Version: 0.1.1rc3
+Version: 0.1.1rc5
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -382,7 +382,7 @@ with CriblControlPlane(
 
 ### [packs](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md)
 
-* [install](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#install) - Create or install a Pack
+* [install](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#install) - Install a Pack
 * [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#list) - List all Packs
 * [upload](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#upload) - Upload a Pack file
 * [delete](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#delete) - Uninstall a Pack

{cribl_control_plane-0.1.1rc3 → cribl_control_plane-0.1.1rc5}/README-PYPI.md

@@ -364,7 +364,7 @@ with CriblControlPlane(
 
 ### [packs](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md)
 
-* [install](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#install) - Create or install a Pack
+* [install](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#install) - Install a Pack
 * [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#list) - List all Packs
 * [upload](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#upload) - Upload a Pack file
 * [delete](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/packs/README.md#delete) - Uninstall a Pack

{cribl_control_plane-0.1.1rc3 → cribl_control_plane-0.1.1rc5}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "cribl-control-plane"
-version = "0.1.1rc3"
+version = "0.1.1rc5"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

{cribl_control_plane-0.1.1rc3 → cribl_control_plane-0.1.1rc5}/src/cribl_control_plane/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "cribl-control-plane"
-__version__: str = "0.1.1rc3"
-__openapi_doc_version__: str = "4.15.0-alpha.1760464789107-7d63bffb"
+__version__: str = "0.1.1rc5"
+__openapi_doc_version__: str = "4.15.0-alpha.1760607052180-31a53a17"
 __gen_version__: str = "2.723.11"
-__user_agent__: str = "speakeasy-sdk/python 0.1.1rc3 2.723.11 4.15.0-alpha.1760464789107-7d63bffb cribl-control-plane"
+__user_agent__: str = "speakeasy-sdk/python 0.1.1rc5 2.723.11 4.15.0-alpha.1760607052180-31a53a17 cribl-control-plane"
 
 try:
     if __package__ is not None:

{cribl_control_plane-0.1.1rc3 → cribl_control_plane-0.1.1rc5}/src/cribl_control_plane/models/updatepacksop.py

@@ -10,7 +10,7 @@ from typing_extensions import Annotated, TypedDict
 
 class UpdatePacksRequestTypedDict(TypedDict):
     filename: str
-    r"""Filename of the pack file to upload"""
+    r"""Filename of the Pack file to upload."""
     request_body: Union[bytes, IO[bytes], io.BufferedReader]
     r"""Binary file content"""
 
@@ -19,7 +19,7 @@ class UpdatePacksRequest(BaseModel):
     filename: Annotated[
         str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
     ]
-    r"""Filename of the pack file to upload"""
+    r"""Filename of the Pack file to upload."""
 
     request_body: Annotated[
         Union[bytes, IO[bytes], io.BufferedReader], FieldMetadata(request=True)

{cribl_control_plane-0.1.1rc3 → cribl_control_plane-0.1.1rc5}/src/cribl_control_plane/packs.py

@@ -24,9 +24,9 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Create or install a Pack
+        r"""Install a Pack
 
-        Create or install a Pack.
+        Install a Pack.<br><br>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br><br>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -116,9 +116,9 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Create or install a Pack
+        r"""Install a Pack
 
-        Create or install a Pack.
+        Install a Pack.<br><br>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br><br>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -383,9 +383,9 @@ class Packs(BaseSDK):
     ) -> models.UploadPackResponse:
         r"""Upload a Pack file
 
-        Upload a Pack file. Returns a source identifier that can be used to install the pack via the install a Pack endpoint.
+        Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs source</code>, which you must call separately.
 
-        :param filename: Filename of the pack file to upload
+        :param filename: Filename of the Pack file to upload.
         :param request_body: Binary file content
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -480,9 +480,9 @@ class Packs(BaseSDK):
     ) -> models.UploadPackResponse:
         r"""Upload a Pack file
 
-        Upload a Pack file. Returns a source identifier that can be used to install the pack via the install a Pack endpoint.
+        Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs source</code>, which you must call separately.
 
-        :param filename: Filename of the pack file to upload
+        :param filename: Filename of the Pack file to upload.
         :param request_body: Binary file content
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -928,7 +928,7 @@ class Packs(BaseSDK):
     ) -> models.UpdatePacksByIDResponse:
         r"""Upgrade a Pack
 
-        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack.Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
         :param id: The <code>id</code> of the Pack to upgrade.
         :param source:
@@ -1036,7 +1036,7 @@ class Packs(BaseSDK):
     ) -> models.UpdatePacksByIDResponse:
         r"""Upgrade a Pack
 
-        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack.Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
         :param id: The <code>id</code> of the Pack to upgrade.
         :param source: