Skip to content

Commit 7884557

Browse files
chore: 🐝 Update SDK - Generate 0.52.2 (#109)
Co-authored-by: speakeasybot <[email protected]>
1 parent 048c847 commit 7884557

File tree

888 files changed

+15661
-1585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

888 files changed

+15661
-1585
lines changed

.speakeasy/gen.lock

+883-609
Large diffs are not rendered by default.

.speakeasy/workflow.lock

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
speakeasyVersion: 1.291.0
1+
speakeasyVersion: 1.453.10
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:4cbacce549695d61a4b6fcd07742e8eb25c528061ad1db3e002239fcea2956fa
6-
sourceBlobDigest: sha256:8745bd06d95a1f1a7073a8a702c4bd4db2c5967d58f562d11de4f89ac7f872f5
5+
sourceRevisionDigest: sha256:3712f551c1bc9d55089a54598938b61b271ddcc1a81583646d883bae9f085825
6+
sourceBlobDigest: sha256:fa5143179ee978611fb032f3948584f4cbf071857ff2ff6611fbac17e1b67eb9
77
tags:
88
- latest
9-
- main
9+
- speakeasy-sdk-regen-1730420397
10+
- 1.0.0
1011
targets:
1112
python-api:
1213
source: my-source
1314
sourceNamespace: my-source
14-
sourceRevisionDigest: sha256:4cbacce549695d61a4b6fcd07742e8eb25c528061ad1db3e002239fcea2956fa
15-
sourceBlobDigest: sha256:8745bd06d95a1f1a7073a8a702c4bd4db2c5967d58f562d11de4f89ac7f872f5
16-
outLocation: /github/workspace/repo
15+
sourceRevisionDigest: sha256:3712f551c1bc9d55089a54598938b61b271ddcc1a81583646d883bae9f085825
16+
sourceBlobDigest: sha256:fa5143179ee978611fb032f3948584f4cbf071857ff2ff6611fbac17e1b67eb9
17+
codeSamplesNamespace: my-source-python-code-samples
18+
codeSamplesRevisionDigest: sha256:06fc180ad0f496ce01459cc965e47d9c73051b3339c4ffa34dd99997da5e2bf9
1719
workflow:
1820
workflowVersion: 1.0.0
1921
speakeasyVersion: latest
2022
sources:
2123
my-source:
2224
inputs:
23-
- location: ./airbyte-api.openapi.yaml
25+
- location: https://raw.githubusercontent.com/airbytehq/airbyte-platform/refs/heads/main/airbyte-api/server-api/src/main/openapi/api_sdk.yaml
2426
registry:
2527
location: registry.speakeasyapi.dev/airbyte/airbyte-prod/my-source
2628
targets:
@@ -30,3 +32,7 @@ workflow:
3032
publish:
3133
pypi:
3234
token: $PYPI_TOKEN
35+
codeSamples:
36+
registry:
37+
location: registry.speakeasyapi.dev/airbyte/airbyte-prod/my-source-python-code-samples
38+
blocking: false

.speakeasy/workflow.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ targets:
1313
publish:
1414
pypi:
1515
token: $PYPI_TOKEN
16+
codeSamples:
17+
registry:
18+
location: registry.speakeasyapi.dev/airbyte/airbyte-prod/my-source-python-code-samples
19+
blocking: false

README.md

+39-65
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,21 @@ The Developer Portal UI can also be used to help build your integration by showi
1616
<!-- Start Summary [summary] -->
1717
## Summary
1818

19-
airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.
19+
airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.
2020
<!-- End Summary [summary] -->
2121

2222
<!-- Start Table of Contents [toc] -->
2323
## Table of Contents
24+
<!-- $toc-max-depth=2 -->
25+
* [Authentication](#authentication)
26+
* [SDK Installation](#sdk-installation)
27+
* [SDK Example Usage](#sdk-example-usage)
28+
* [Available Resources and Operations](#available-resources-and-operations)
29+
* [Error Handling](#error-handling)
30+
* [Server Selection](#server-selection)
31+
* [Custom HTTP Client](#custom-http-client)
32+
* [Authentication](#authentication-1)
2433

25-
* [SDK Installation](#sdk-installation)
26-
* [SDK Example Usage](#sdk-example-usage)
27-
* [Available Resources and Operations](#available-resources-and-operations)
28-
* [Error Handling](#error-handling)
29-
* [Server Selection](#server-selection)
30-
* [Custom HTTP Client](#custom-http-client)
31-
* [Authentication](#authentication)
3234
<!-- End Table of Contents [toc] -->
3335

3436
<!-- Start SDK Installation [installation] -->
@@ -53,8 +55,8 @@ from airbyte_api import models
5355
s = airbyte_api.AirbyteAPI(
5456
security=models.Security(
5557
basic_auth=models.SchemeBasicAuth(
56-
password="",
57-
username="",
58+
password='',
59+
username='',
5860
),
5961
),
6062
)
@@ -160,11 +162,22 @@ if res.connection_response is not None:
160162
<!-- Start Error Handling [errors] -->
161163
## Error Handling
162164

163-
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
165+
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
164166

165-
| Error Object | Status Code | Content Type |
166-
| --------------- | --------------- | --------------- |
167-
| errors.SDKError | 4xx-5xx | */* |
167+
By default, an API error will raise a errors.SDKError exception, which has the following properties:
168+
169+
| Property | Type | Description |
170+
|-----------------|------------------|-----------------------|
171+
| `.status_code` | *int* | The HTTP status code |
172+
| `.message` | *str* | The error message |
173+
| `.raw_response` | *httpx.Response* | The raw HTTP response |
174+
| `.body` | *str* | The response content |
175+
176+
When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_connection` method may raise the following exceptions:
177+
178+
| Error Type | Status Code | Content Type |
179+
| --------------- | ----------- | ------------ |
180+
| errors.SDKError | 4XX, 5XX | \*/\* |
168181

169182
### Example
170183

@@ -175,8 +188,8 @@ from airbyte_api import errors, models
175188
s = airbyte_api.AirbyteAPI(
176189
security=models.Security(
177190
basic_auth=models.SchemeBasicAuth(
178-
password="",
179-
username="",
191+
password='',
192+
username='',
180193
),
181194
),
182195
)
@@ -206,45 +219,6 @@ if res.connection_response is not None:
206219
<!-- Start Server Selection [server] -->
207220
## Server Selection
208221

209-
### Select Server by Index
210-
211-
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
212-
213-
| # | Server | Variables |
214-
| - | ------ | --------- |
215-
| 0 | `https://api.airbyte.com/v1` | None |
216-
217-
#### Example
218-
219-
```python
220-
import airbyte_api
221-
from airbyte_api import models
222-
223-
s = airbyte_api.AirbyteAPI(
224-
server_idx=0,
225-
security=models.Security(
226-
basic_auth=models.SchemeBasicAuth(
227-
password="",
228-
username="",
229-
),
230-
),
231-
)
232-
233-
234-
res = s.connections.create_connection(request=models.ConnectionCreateRequest(
235-
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
236-
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
237-
name='Postgres-to-Bigquery',
238-
namespace_format='${SOURCE_NAMESPACE}',
239-
))
240-
241-
if res.connection_response is not None:
242-
# handle response
243-
pass
244-
245-
```
246-
247-
248222
### Override Server URL Per-Client
249223

250224
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -253,11 +227,11 @@ import airbyte_api
253227
from airbyte_api import models
254228

255229
s = airbyte_api.AirbyteAPI(
256-
server_url="https://api.airbyte.com/v1",
230+
server_url='https://api.airbyte.com/v1',
257231
security=models.Security(
258232
basic_auth=models.SchemeBasicAuth(
259-
password="",
260-
username="",
233+
password='',
234+
username='',
261235
),
262236
),
263237
)
@@ -304,11 +278,11 @@ s = airbyte_api.AirbyteAPI(client=http_client)
304278

305279
This SDK supports the following security schemes globally:
306280

307-
| Name | Type | Scheme |
308-
| -------------------- | -------------------- | -------------------- |
309-
| `basic_auth` | http | HTTP Basic |
310-
| `bearer_auth` | http | HTTP Bearer |
311-
| `client_credentials` | oauth2 | OAuth2 token |
281+
| Name | Type | Scheme |
282+
| -------------------- | ------ | ------------ |
283+
| `basic_auth` | http | HTTP Basic |
284+
| `bearer_auth` | http | HTTP Bearer |
285+
| `client_credentials` | oauth2 | OAuth2 token |
312286

313287
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
314288
```python
@@ -318,8 +292,8 @@ from airbyte_api import models
318292
s = airbyte_api.AirbyteAPI(
319293
security=models.Security(
320294
basic_auth=models.SchemeBasicAuth(
321-
password="",
322-
username="",
295+
password='',
296+
username='',
323297
),
324298
),
325299
)

RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -958,4 +958,14 @@ Based on:
958958
### Generated
959959
- [python v0.52.1] .
960960
### Releases
961-
- [PyPI v0.52.1] https://pypi.org/project/airbyte-api/0.52.1 - .
961+
- [PyPI v0.52.1] https://pypi.org/project/airbyte-api/0.52.1 - .
962+
963+
## 2024-12-11 00:19:25
964+
### Changes
965+
Based on:
966+
- OpenAPI Doc
967+
- Speakeasy CLI 1.453.10 (2.474.15) https://github.com/speakeasy-api/speakeasy
968+
### Generated
969+
- [python v0.52.2] .
970+
### Releases
971+
- [PyPI v0.52.2] https://pypi.org/project/airbyte-api/0.52.2 - .

USAGE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ from airbyte_api import models
66
s = airbyte_api.AirbyteAPI(
77
security=models.Security(
88
basic_auth=models.SchemeBasicAuth(
9-
password="",
10-
username="",
9+
password='',
10+
username='',
1111
),
1212
),
1313
)

0 commit comments

Comments
 (0)