Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13,378 changes: 8,986 additions & 4,392 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
python:
version: 0.8.1
version: 0.9.0
additionalDependencies:
dev: {}
main: {}
Expand All @@ -44,13 +44,18 @@ python:
authors:
- Speakeasy
baseErrorName: CriblControlPlaneError
bodyVariantOverloads: false
clientServerStatusCodesAsErrors: true
constFieldCasing: upper
defaultErrorName: APIError
description: Python Client SDK Generated by Speakeasy.
enableCustomCodeRegions: false
enumFormat: enum
envVarPrefix: CRIBLCONTROLPLANE
errorSchemaValidation: true
eventStreamClassNames:
async: EventStreamAsync
sync: EventStream
fixFlags:
asyncPaginationSep2025: true
conflictResistantModelImportsFeb2026: true
Expand All @@ -70,19 +75,25 @@ python:
webhooks: ""
inferUnionDiscriminators: true
inputModelSuffix: input
inputTypedDictSuffix: TypedDict
legacyPyright: true
license: ""
maxMethodParams: 999
methodArguments: infer-optional-args
methodTimeoutArgument: timeout-ms
methodTimeoutUnits: milliseconds
moduleName: ""
multipartArrayFormat: legacy
optionalDependencies: {}
outputModelSuffix: output
packageManager: poetry
packageName: cribl-control-plane
preApplyUnionDiscriminators: false
pytestFilterWarnings: []
pytestTimeout: 0
rawResponseHelpers: false
responseFormat: flat
responseSchemaValidation: true
sseFlatResponse: false
templateVersion: v2
useAsyncHooks: false
31,783 changes: 22,312 additions & 9,471 deletions .speakeasy/out.openapi.yaml

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
speakeasyVersion: 1.764.0
speakeasyVersion: 1.784.0
sources:
Cribl API Reference:
sourceNamespace: cribl-api-reference
sourceRevisionDigest: sha256:2285e1da4eb22e187a97684a38b3208074a56ec8e08454d80599ce38360942eb
sourceBlobDigest: sha256:98e511ead4e90616b9c3ad19fc225f9d298668b7d9ef02a7fdf33220a8980186
sourceRevisionDigest: sha256:249de9535b9eeb5f528e1270b3a3458bf64cca16312442d776762bbac8f38bad
sourceBlobDigest: sha256:97a237d16becc47926318a4645c69c913ff8a0e597e37686dc5d5ac0087e899e
tags:
- latest
- 4.18.1-37206a7f
- 4.18.2-fd1f0d2f
targets:
cribl-control-plane:
source: Cribl API Reference
sourceNamespace: cribl-api-reference
sourceRevisionDigest: sha256:2285e1da4eb22e187a97684a38b3208074a56ec8e08454d80599ce38360942eb
sourceBlobDigest: sha256:98e511ead4e90616b9c3ad19fc225f9d298668b7d9ef02a7fdf33220a8980186
sourceRevisionDigest: sha256:249de9535b9eeb5f528e1270b3a3458bf64cca16312442d776762bbac8f38bad
sourceBlobDigest: sha256:97a237d16becc47926318a4645c69c913ff8a0e597e37686dc5d5ac0087e899e
codeSamplesNamespace: cribl-api-reference-python-code-samples
codeSamplesRevisionDigest: sha256:c6dbd88ed6ea559aa7681d840a58118232a3418270e8461125b86f99ed6e233a
codeSamplesRevisionDigest: sha256:cf203998f17bb3505966181661e012b83c4e6a8c72f3f6db2983a204dd8479db
workflow:
workflowVersion: 1.0.0
speakeasyVersion: 1.764.0
speakeasyVersion: 1.784.0
sources:
Cribl API Reference:
inputs:
Expand Down
54 changes: 24 additions & 30 deletions README-PYPI.md

Large diffs are not rendered by default.

54 changes: 24 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,18 +222,19 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

### [Collectors](docs/sdks/collectorssdk/README.md)

* [create](docs/sdks/collectorssdk/README.md#create) - Create a Collector
* [list](docs/sdks/collectorssdk/README.md#list) - List all Collectors
* [delete](docs/sdks/collectorssdk/README.md#delete) - Delete a Collector
* [create](docs/sdks/collectorssdk/README.md#create) - Create a Collector
* [get](docs/sdks/collectorssdk/README.md#get) - Get a Collector
* [update](docs/sdks/collectorssdk/README.md#update) - Update a Collector
* [delete](docs/sdks/collectorssdk/README.md#delete) - Delete a Collector

### [DatabaseConnections](docs/sdks/databaseconnections/README.md)

* [list](docs/sdks/databaseconnections/README.md#list) - List Database Connections
* [create](docs/sdks/databaseconnections/README.md#create) - Create Database Connection
* [delete](docs/sdks/databaseconnections/README.md#delete) - Delete a Database Connection
* [get](docs/sdks/databaseconnections/README.md#get) - Get a Database Connection
* [update](docs/sdks/databaseconnections/README.md#update) - Update a Database Connection
* [delete](docs/sdks/databaseconnections/README.md#delete) - Delete a Database Connection

### [Destinations](docs/sdks/destinations/README.md)

Expand All @@ -255,13 +256,13 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

#### [Destinations.Statuses](docs/sdks/destinationsstatuses/README.md)

* [get](docs/sdks/destinationsstatuses/README.md#get) - Get the status of a Destination
* [list](docs/sdks/destinationsstatuses/README.md#list) - List the status of all Destinations
* [get](docs/sdks/destinationsstatuses/README.md#get) - Get the status of a Destination

### [Functions](docs/sdks/functions/README.md)

* [get](docs/sdks/functions/README.md#get) - Get a Function
* [list](docs/sdks/functions/README.md#list) - List all Functions
* [get](docs/sdks/functions/README.md#get) - Get a Function

### [Groups](docs/sdks/groupssdk/README.md)

Expand Down Expand Up @@ -290,17 +291,17 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

### [Lakes.Datasets](docs/sdks/datasets/README.md)

* [create](docs/sdks/datasets/README.md#create) - Create a Lake Dataset (Cribl.Cloud only)
* [list](docs/sdks/datasets/README.md#list) - List all Lake Datasets (Cribl.Cloud only)
* [delete](docs/sdks/datasets/README.md#delete) - Delete a Lake Dataset (Cribl.Cloud only)
* [create](docs/sdks/datasets/README.md#create) - Create a Lake Dataset (Cribl.Cloud only)
* [get](docs/sdks/datasets/README.md#get) - Get a Lake Dataset (Cribl.Cloud only)
* [update](docs/sdks/datasets/README.md#update) - Update a Lake Dataset (Cribl.Cloud only)
* [delete](docs/sdks/datasets/README.md#delete) - Delete a Lake Dataset (Cribl.Cloud only)

### [Nodes](docs/sdks/nodes/README.md)

* [count](docs/sdks/nodes/README.md#count) - Get a count of Worker, Edge, or Outpost Nodes
* [get](docs/sdks/nodes/README.md#get) - Get detailed metadata for a Worker, Edge, or Outpost Node
* [list](docs/sdks/nodes/README.md#list) - Get detailed metadata for Worker, Edge, or Outpost Nodes
* [get](docs/sdks/nodes/README.md#get) - Get detailed metadata for a Worker, Edge, or Outpost Node
* [restart](docs/sdks/nodes/README.md#restart) - Restart Worker, Edge, or Outpost Nodes

#### [Nodes.Summaries](docs/sdks/summaries/README.md)
Expand All @@ -312,9 +313,9 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl
* [install](docs/sdks/packs/README.md#install) - Install a Pack
* [list](docs/sdks/packs/README.md#list) - List all Packs
* [upload](docs/sdks/packs/README.md#upload) - Upload a Pack file
* [delete](docs/sdks/packs/README.md#delete) - Uninstall a Pack
* [get](docs/sdks/packs/README.md#get) - Get a Pack
* [update](docs/sdks/packs/README.md#update) - Upgrade a Pack
* [delete](docs/sdks/packs/README.md#delete) - Uninstall a Pack

#### [Packs.Destinations](docs/sdks/packsdestinations/README.md)

Expand All @@ -336,22 +337,22 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

##### [Packs.Destinations.Statuses](docs/sdks/packsdestinationsstatuses/README.md)

* [get](docs/sdks/packsdestinationsstatuses/README.md#get) - Get the status of a Destination within a Pack
* [list](docs/sdks/packsdestinationsstatuses/README.md#list) - List the status of all Destinations within a Pack
* [get](docs/sdks/packsdestinationsstatuses/README.md#get) - Get the status of a Destination within a Pack

#### [Packs.Pipelines](docs/sdks/packspipelines/README.md)

* [create](docs/sdks/packspipelines/README.md#create) - Create a Pipeline within a Pack
* [list](docs/sdks/packspipelines/README.md#list) - List all Pipelines within a Pack
* [delete](docs/sdks/packspipelines/README.md#delete) - Delete a Pipeline within a Pack
* [create](docs/sdks/packspipelines/README.md#create) - Create a Pipeline within a Pack
* [get](docs/sdks/packspipelines/README.md#get) - Get a Pipeline within a Pack
* [update](docs/sdks/packspipelines/README.md#update) - Update a Pipeline within a Pack
* [delete](docs/sdks/packspipelines/README.md#delete) - Delete a Pipeline within a Pack

#### [Packs.Routes](docs/sdks/packsroutes/README.md)

* [list](docs/sdks/packsroutes/README.md#list) - List all Routes within a Pack
* [get](docs/sdks/packsroutes/README.md#get) - Get a Routing table within a Pack
* [update](docs/sdks/packsroutes/README.md#update) - Update a Route within a Pack
* [list](docs/sdks/packsroutes/README.md#list) - List all Routes within a Pack
* [append](docs/sdks/packsroutes/README.md#append) - Add a Route to the end of the Routing table within a Pack

#### [Packs.Sources](docs/sdks/packssources/README.md)
Expand All @@ -374,22 +375,22 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

##### [Packs.Sources.Statuses](docs/sdks/packssourcesstatuses/README.md)

* [get](docs/sdks/packssourcesstatuses/README.md#get) - Get the status of a Source within a Pack
* [list](docs/sdks/packssourcesstatuses/README.md#list) - List the status of all Sources within a Pack
* [get](docs/sdks/packssourcesstatuses/README.md#get) - Get the status of a Source within a Pack

### [Pipelines](docs/sdks/pipelines/README.md)

* [create](docs/sdks/pipelines/README.md#create) - Create a Pipeline
* [list](docs/sdks/pipelines/README.md#list) - List all Pipelines
* [create](docs/sdks/pipelines/README.md#create) - Create a Pipeline
* [delete](docs/sdks/pipelines/README.md#delete) - Delete a Pipeline
* [get](docs/sdks/pipelines/README.md#get) - Get a Pipeline
* [update](docs/sdks/pipelines/README.md#update) - Update a Pipeline

### [Routes](docs/sdks/routessdk/README.md)

* [list](docs/sdks/routessdk/README.md#list) - List all Routes
* [get](docs/sdks/routessdk/README.md#get) - Get a Routing table
* [update](docs/sdks/routessdk/README.md#update) - Update a Route
* [list](docs/sdks/routessdk/README.md#list) - List all Routes
* [append](docs/sdks/routessdk/README.md#append) - Add a Route to the end of the Routing table

### [Sources](docs/sdks/sources/README.md)
Expand All @@ -407,25 +408,25 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

#### [Sources.Pq](docs/sdks/sourcespq/README.md)

* [clear](docs/sdks/sourcespq/README.md#clear) - Clear the persistent queue for a Source
* [get](docs/sdks/sourcespq/README.md#get) - Get information about the latest job to clear the persistent queue for a Source
* [clear](docs/sdks/sourcespq/README.md#clear) - Clear the persistent queue for a Source

#### [Sources.Statuses](docs/sdks/sourcesstatuses/README.md)

* [get](docs/sdks/sourcesstatuses/README.md#get) - Get the status of a Source
* [list](docs/sdks/sourcesstatuses/README.md#list) - List the status of all Sources
* [get](docs/sdks/sourcesstatuses/README.md#get) - Get the status of a Source

### [System.Captures](docs/sdks/captures/README.md)

* [create](docs/sdks/captures/README.md#create) - Capture live incoming data
* [create](docs/sdks/captures/README.md#create) - Capture live data

### [System.Settings](docs/sdks/settings/README.md)

* [restart](docs/sdks/settings/README.md#restart) - Restart the Cribl server

#### [System.Settings.Cribl](docs/sdks/cribl/README.md)

* [list](docs/sdks/cribl/README.md#list) - Get Cribl system settings
* [list](docs/sdks/cribl/README.md#list) - Get system settings
* [update](docs/sdks/cribl/README.md#update) - Update system settings

### [Versions.Branches](docs/sdks/branches/README.md)
Expand All @@ -435,9 +436,9 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_pl

### [Versions.Commits](docs/sdks/commits/README.md)

* [list](docs/sdks/commits/README.md#list) - List the commit history
* [create](docs/sdks/commits/README.md#create) - Create a new commit for pending changes to the Cribl configuration
* [diff](docs/sdks/commits/README.md#diff) - Get the diff for a commit
* [list](docs/sdks/commits/README.md#list) - List the commit history
* [push](docs/sdks/commits/README.md#push) - Push local commits to the remote repository
* [revert](docs/sdks/commits/README.md#revert) - Revert a commit in the local repository
* [get](docs/sdks/commits/README.md#get) - Get the diff and log message for a commit
Expand Down Expand Up @@ -517,7 +518,7 @@ with CriblControlPlane(
),
) as ccp_client:

res = ccp_client.sources.statuses.list()
res = ccp_client.packs.sources.statuses.list(pack="<value>")

while res is not None:
# Handle items
Expand Down Expand Up @@ -750,15 +751,11 @@ The `CriblControlPlane` class implements the context manager protocol and regist
[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers

```python
from cribl_control_plane import CriblControlPlane, models
import os
from cribl_control_plane import CriblControlPlane
def main():

with CriblControlPlane(
"https://api.example.com",
security=models.Security(
bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
),
) as ccp_client:
# Rest of application here...

Expand All @@ -768,9 +765,6 @@ async def amain():

async with CriblControlPlane(
"https://api.example.com",
security=models.Security(
bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
),
) as ccp_client:
# Rest of application here...
```
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -678,4 +678,14 @@ Based on:
### Generated
- [python v0.8.1] .
### Releases
- [PyPI v0.8.1] https://pypi.org/project/cribl-control-plane/0.8.1 - .
- [PyPI v0.8.1] https://pypi.org/project/cribl-control-plane/0.8.1 - .

## 2026-06-24 02:14:17
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.784.0 (2.911.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.9.0] .
### Releases
- [PyPI v0.9.0] https://pypi.org/project/cribl-control-plane/0.9.0 - .
16 changes: 4 additions & 12 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
from cribl_control_plane import CriblControlPlane, models
import os
from cribl_control_plane import CriblControlPlane


with CriblControlPlane(
"https://api.example.com",
security=models.Security(
bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
),
) as ccp_client:

res = ccp_client.database_connections.create(auth_type="connectionString", database_type=models.DatabaseConnectionType.MYSQL, description="Production MySQL database for customer data", id="mysql-prod-db", connection_string="mysql://admin:password123@mysql.example.com:3306/production?ssl=true", connection_timeout=10000, tags="production,mysql,customer-data")
res = ccp_client.auth.tokens.get(password="6j50J9421x29IhO", username="Lilly_Weissnat")

# Handle response
print(res)
Expand All @@ -25,19 +21,15 @@ The same SDK client can also be used to make asynchronous requests by importing
```python
# Asynchronous Example
import asyncio
from cribl_control_plane import CriblControlPlane, models
import os
from cribl_control_plane import CriblControlPlane

async def main():

async with CriblControlPlane(
"https://api.example.com",
security=models.Security(
bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
),
) as ccp_client:

res = await ccp_client.database_connections.create_async(auth_type="connectionString", database_type=models.DatabaseConnectionType.MYSQL, description="Production MySQL database for customer data", id="mysql-prod-db", connection_string="mysql://admin:password123@mysql.example.com:3306/production?ssl=true", connection_timeout=10000, tags="production,mysql,customer-data")
res = await ccp_client.auth.tokens.get_async(password="6j50J9421x29IhO", username="Lilly_Weissnat")

# Handle response
print(res)
Expand Down
1 change: 1 addition & 0 deletions docs/errors/healthserverstatuserror.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Health status of the Leader or Worker Node.

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `overlay` | [models.HealthOverlayStatus](../models/healthoverlaystatus.md) | :heavy_check_mark: | N/A |
| `role` | [Optional[models.Role]](../models/role.md) | :heavy_minus_sign: | Leader Node role: <code>primary</code> or <code>standby</code>. |
| `start_time` | *int* | :heavy_check_mark: | Timestamp (in Unix time) when the Cribl process started. |
| `status` | [models.HealthServerStatusStatus](../models/healthserverstatusstatus.md) | :heavy_check_mark: | Health state: <code>healthy</code>, <code>standby</code>, or <code>shutting down</code>. |
10 changes: 10 additions & 0 deletions docs/models/activehealthoverlaystatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ActiveHealthOverlayStatus


## Fields

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `binary_version` | *str* | :heavy_check_mark: | Binary version targeted by the active overlay. | 4.12.0 |
| `overlay_id` | *str* | :heavy_check_mark: | Active overlay identifier. | **Example 1:** patch.0<br/>**Example 2:** sideload.a1b2c3d |
| `state` | *Literal["active"]* | :heavy_check_mark: | Current overlay state. | active |
Loading
Loading