Skip to content

Commit 1fd06d0

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.114.1
1 parent 66bc89c commit 1fd06d0

File tree

92 files changed

+490
-365
lines changed

Some content is hidden

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

92 files changed

+490
-365
lines changed

‎README.md

Lines changed: 70 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ req = operations.GetApisRequest(
2626
'string',
2727
],
2828
},
29-
op=operations.GetApisOp(
29+
op=operations.QueryParamOp(
3030
and_=False,
3131
),
3232
)
3333

3434
res = s.apis.get_apis(req)
3535

36-
if res.apis is not None:
36+
if res.classes is not None:
3737
# handle response
3838
pass
3939
```
@@ -46,18 +46,7 @@ if res.apis is not None:
4646

4747
* [validate_api_key](docs/sdks/speakeasy/README.md#validate_api_key) - Validate the current api key.
4848

49-
### [api_endpoints](docs/sdks/apiendpoints/README.md)
50-
51-
* [delete_api_endpoint](docs/sdks/apiendpoints/README.md#delete_api_endpoint) - Delete an ApiEndpoint.
52-
* [find_api_endpoint](docs/sdks/apiendpoints/README.md#find_api_endpoint) - Find an ApiEndpoint via its displayName.
53-
* [generate_open_api_spec_for_api_endpoint](docs/sdks/apiendpoints/README.md#generate_open_api_spec_for_api_endpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
54-
* [generate_postman_collection_for_api_endpoint](docs/sdks/apiendpoints/README.md#generate_postman_collection_for_api_endpoint) - Generate a Postman collection for a particular ApiEndpoint.
55-
* [get_all_api_endpoints](docs/sdks/apiendpoints/README.md#get_all_api_endpoints) - Get all Api endpoints for a particular apiID.
56-
* [get_all_for_version_api_endpoints](docs/sdks/apiendpoints/README.md#get_all_for_version_api_endpoints) - Get all ApiEndpoints for a particular apiID and versionID.
57-
* [get_api_endpoint](docs/sdks/apiendpoints/README.md#get_api_endpoint) - Get an ApiEndpoint.
58-
* [upsert_api_endpoint](docs/sdks/apiendpoints/README.md#upsert_api_endpoint) - Upsert an ApiEndpoint.
59-
60-
### [apis](docs/sdks/apis/README.md)
49+
### [.apis](docs/sdks/apis/README.md)
6150

6251
* [delete_api](docs/sdks/apis/README.md#delete_api) - Delete an Api.
6352
* [generate_open_api_spec](docs/sdks/apis/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular Api.
@@ -66,31 +55,24 @@ if res.apis is not None:
6655
* [get_apis](docs/sdks/apis/README.md#get_apis) - Get a list of Apis for a given workspace
6756
* [upsert_api](docs/sdks/apis/README.md#upsert_api) - Upsert an Api
6857

69-
### [embeds](docs/sdks/embeds/README.md)
58+
### [.api_endpoints](docs/sdks/apiendpoints/README.md)
7059

71-
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
72-
* [get_valid_embed_access_tokens](docs/sdks/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
73-
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
60+
* [delete_api_endpoint](docs/sdks/apiendpoints/README.md#delete_api_endpoint) - Delete an ApiEndpoint.
61+
* [find_api_endpoint](docs/sdks/apiendpoints/README.md#find_api_endpoint) - Find an ApiEndpoint via its displayName.
62+
* [generate_open_api_spec_for_api_endpoint](docs/sdks/apiendpoints/README.md#generate_open_api_spec_for_api_endpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
63+
* [generate_postman_collection_for_api_endpoint](docs/sdks/apiendpoints/README.md#generate_postman_collection_for_api_endpoint) - Generate a Postman collection for a particular ApiEndpoint.
64+
* [get_all_api_endpoints](docs/sdks/apiendpoints/README.md#get_all_api_endpoints) - Get all Api endpoints for a particular apiID.
65+
* [get_all_for_version_api_endpoints](docs/sdks/apiendpoints/README.md#get_all_for_version_api_endpoints) - Get all ApiEndpoints for a particular apiID and versionID.
66+
* [get_api_endpoint](docs/sdks/apiendpoints/README.md#get_api_endpoint) - Get an ApiEndpoint.
67+
* [upsert_api_endpoint](docs/sdks/apiendpoints/README.md#upsert_api_endpoint) - Upsert an ApiEndpoint.
7468

75-
### [metadata](docs/sdks/metadata/README.md)
69+
### [.metadata](docs/sdks/metadata/README.md)
7670

7771
* [delete_version_metadata](docs/sdks/metadata/README.md#delete_version_metadata) - Delete metadata for a particular apiID and versionID.
7872
* [get_version_metadata](docs/sdks/metadata/README.md#get_version_metadata) - Get all metadata for a particular apiID and versionID.
7973
* [insert_version_metadata](docs/sdks/metadata/README.md#insert_version_metadata) - Insert metadata for a particular apiID and versionID.
8074

81-
### [plugins](docs/sdks/plugins/README.md)
82-
83-
* [get_plugins](docs/sdks/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
84-
* [run_plugin](docs/sdks/plugins/README.md#run_plugin) - Run a plugin
85-
* [upsert_plugin](docs/sdks/plugins/README.md#upsert_plugin) - Upsert a plugin
86-
87-
### [requests](docs/sdks/requests/README.md)
88-
89-
* [generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
90-
* [get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
91-
* [query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
92-
93-
### [schemas](docs/sdks/schemas/README.md)
75+
### [.schemas](docs/sdks/schemas/README.md)
9476

9577
* [delete_schema](docs/sdks/schemas/README.md#delete_schema) - Delete a particular schema revision for an Api.
9678
* [download_schema](docs/sdks/schemas/README.md#download_schema) - Download the latest schema for a particular apiID.
@@ -100,6 +82,24 @@ if res.apis is not None:
10082
* [get_schema_revision](docs/sdks/schemas/README.md#get_schema_revision) - Get information about a particular schema revision for an Api.
10183
* [get_schemas](docs/sdks/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
10284
* [register_schema](docs/sdks/schemas/README.md#register_schema) - Register a schema.
85+
86+
### [.requests](docs/sdks/requests/README.md)
87+
88+
* [generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
89+
* [get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
90+
* [query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
91+
92+
### [.plugins](docs/sdks/plugins/README.md)
93+
94+
* [get_plugins](docs/sdks/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
95+
* [run_plugin](docs/sdks/plugins/README.md#run_plugin) - Run a plugin
96+
* [upsert_plugin](docs/sdks/plugins/README.md#upsert_plugin) - Upsert a plugin
97+
98+
### [.embeds](docs/sdks/embeds/README.md)
99+
100+
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
101+
* [get_valid_embed_access_tokens](docs/sdks/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
102+
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
103103
<!-- End SDK Available Operations -->
104104

105105

@@ -126,8 +126,6 @@ Here's an example of one such pagination call:
126126
# Error Handling
127127

128128
Handling errors in your 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.
129-
130-
131129
<!-- End Error Handling -->
132130

133131

@@ -145,20 +143,19 @@ You can override the default server globally by passing a server name to the `se
145143

146144
For example:
147145

148-
149146
```python
150147
import speakeasy
151148
from speakeasy.models import shared
152149

153150
s = speakeasy.Speakeasy(
151+
server="prod",
154152
security=shared.Security(
155153
api_key="",
156154
),
157-
server="prod"
158155
)
159156

160157

161-
res = s.speakeasy.validate_api_key()
158+
res = s.validate_api_key()
162159

163160
if res.status_code == 200:
164161
# handle response
@@ -170,20 +167,19 @@ if res.status_code == 200:
170167

171168
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:
172169

173-
174170
```python
175171
import speakeasy
176172
from speakeasy.models import shared
177173

178174
s = speakeasy.Speakeasy(
175+
server_url="https://api.prod.speakeasyapi.dev",
179176
security=shared.Security(
180177
api_key="",
181178
),
182-
server_url="https://api.prod.speakeasyapi.dev"
183179
)
184180

185181

186-
res = s.speakeasy.validate_api_key()
182+
res = s.validate_api_key()
187183

188184
if res.status_code == 200:
189185
# handle response
@@ -209,9 +205,42 @@ http_client = requests.Session()
209205
http_client.headers.update({'x-custom-header': 'someValue'})
210206
s = speakeasy.Speakeasy(client: http_client)
211207
```
208+
<!-- End Custom HTTP Client -->
212209

213210

214-
<!-- End Custom HTTP Client -->
211+
212+
<!-- Start Authentication -->
213+
214+
# Authentication
215+
216+
## Per-Client Security Schemes
217+
218+
Your SDK supports the following security scheme globally:
219+
220+
| Name | Type | Scheme |
221+
| --------- | --------- | --------- |
222+
| `api_key` | apiKey | API key |
223+
224+
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
225+
226+
```python
227+
import speakeasy
228+
from speakeasy.models import shared
229+
230+
s = speakeasy.Speakeasy(
231+
security=shared.Security(
232+
api_key="",
233+
),
234+
)
235+
236+
237+
res = s.validate_api_key()
238+
239+
if res.status_code == 200:
240+
# handle response
241+
pass
242+
```
243+
<!-- End Authentication -->
215244

216245
<!-- Placeholder for Future Speakeasy SDK Sections -->
217246

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1026,4 +1026,14 @@ Based on:
10261026
### Generated
10271027
- [python v2.1.1] .
10281028
### Releases
1029-
- [PyPI v2.1.1] https://pypi.org/project/speakeasy-client-sdk-python/2.1.1 - .
1029+
- [PyPI v2.1.1] https://pypi.org/project/speakeasy-client-sdk-python/2.1.1 - .
1030+
1031+
## 2023-11-07 00:09:58
1032+
### Changes
1033+
Based on:
1034+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1035+
- Speakeasy CLI 1.114.1 (2.181.1) https://github.com/speakeasy-api/speakeasy
1036+
### Generated
1037+
- [python v3.0.0] .
1038+
### Releases
1039+
- [PyPI v3.0.0] https://pypi.org/project/speakeasy-client-sdk-python/3.0.0 - .

‎USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ req = operations.GetApisRequest(
1717
'string',
1818
],
1919
},
20-
op=operations.GetApisOp(
20+
op=operations.QueryParamOp(
2121
and_=False,
2222
),
2323
)
2424

2525
res = s.apis.get_apis(req)
2626

27-
if res.apis is not None:
27+
if res.classes is not None:
2828
# handle response
2929
pass
3030
```

‎docs/models/operations/downloadschemaresponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `two_hundred_application_json_schema` | *Optional[requests_http.Response]* | :heavy_minus_sign: | OK |
9+
| `two_hundred_application_x_yaml_schema` | *Optional[requests_http.Response]* | :heavy_minus_sign: | OK |
810
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
911
| `error` | [Optional[shared.Error]](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
10-
| `schema` | *Optional[requests_http.Response]* | :heavy_minus_sign: | OK |
1112
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
1213
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎docs/models/operations/downloadschemarevisionresponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `two_hundred_application_json_schema` | *Optional[requests_http.Response]* | :heavy_minus_sign: | OK |
9+
| `two_hundred_application_x_yaml_schema` | *Optional[requests_http.Response]* | :heavy_minus_sign: | OK |
810
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
911
| `error` | [Optional[shared.Error]](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
10-
| `schema` | *Optional[requests_http.Response]* | :heavy_minus_sign: | OK |
1112
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
1213
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎docs/models/operations/registerschemarequestbodyfile.md renamed to ‎docs/models/operations/file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# RegisterSchemaRequestBodyFile
1+
# File
22

33

44
## Fields
55

66
| Field | Type | Required | Description |
77
| ------------------ | ------------------ | ------------------ | ------------------ |
88
| `content` | *bytes* | :heavy_check_mark: | N/A |
9-
| `file` | *str* | :heavy_check_mark: | N/A |
9+
| `file_name` | *str* | :heavy_check_mark: | N/A |

0 commit comments

Comments
 (0)