Skip to content

Commit 5909fcd

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.23.0
1 parent d1c8de4 commit 5909fcd

Some content is hidden

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

50 files changed

+1252
-54
lines changed

‎README.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pip install speakeasy-client-sdk-python
1212
<!-- Start SDK Example Usage -->
1313
```python
1414
import speakeasy
15-
from speakeasy.models import operations, shared
15+
from speakeasy.models import operations
1616

1717
s = speakeasy.Speakeasy(
1818
security=shared.Security(
@@ -43,7 +43,7 @@ req = operations.GetApisRequest(
4343
and_=False,
4444
),
4545
)
46-
46+
4747
res = s.apis.get_apis(req)
4848

4949
if res.apis is not None:
@@ -54,64 +54,64 @@ if res.apis is not None:
5454
<!-- Start SDK Available Operations -->
5555
## Available Resources and Operations
5656

57-
### Speakeasy SDK
57+
### [Speakeasy SDK](docs/speakeasy/README.md)
5858

59-
* `validate_api_key` - Validate the current api key.
59+
* [validate_api_key](docs/speakeasy/validateapikey.md) - Validate the current api key.
6060

61-
### api_endpoints
61+
### [api_endpoints](docs/apiendpoints/README.md)
6262

63-
* `delete_api_endpoint` - Delete an ApiEndpoint.
64-
* `find_api_endpoint` - Find an ApiEndpoint via its displayName.
65-
* `generate_open_api_spec_for_api_endpoint` - Generate an OpenAPI specification for a particular ApiEndpoint.
66-
* `generate_postman_collection_for_api_endpoint` - Generate a Postman collection for a particular ApiEndpoint.
67-
* `get_all_api_endpoints` - Get all Api endpoints for a particular apiID.
68-
* `get_all_for_version_api_endpoints` - Get all ApiEndpoints for a particular apiID and versionID.
69-
* `get_api_endpoint` - Get an ApiEndpoint.
70-
* `upsert_api_endpoint` - Upsert an ApiEndpoint.
63+
* [delete_api_endpoint](docs/apiendpoints/deleteapiendpoint.md) - Delete an ApiEndpoint.
64+
* [find_api_endpoint](docs/apiendpoints/findapiendpoint.md) - Find an ApiEndpoint via its displayName.
65+
* [generate_open_api_spec_for_api_endpoint](docs/apiendpoints/generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint.
66+
* [generate_postman_collection_for_api_endpoint](docs/apiendpoints/generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint.
67+
* [get_all_api_endpoints](docs/apiendpoints/getallapiendpoints.md) - Get all Api endpoints for a particular apiID.
68+
* [get_all_for_version_api_endpoints](docs/apiendpoints/getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID.
69+
* [get_api_endpoint](docs/apiendpoints/getapiendpoint.md) - Get an ApiEndpoint.
70+
* [upsert_api_endpoint](docs/apiendpoints/upsertapiendpoint.md) - Upsert an ApiEndpoint.
7171

72-
### apis
72+
### [apis](docs/apis/README.md)
7373

74-
* `delete_api` - Delete an Api.
75-
* `generate_open_api_spec` - Generate an OpenAPI specification for a particular Api.
76-
* `generate_postman_collection` - Generate a Postman collection for a particular Api.
77-
* `get_all_api_versions` - Get all Api versions for a particular ApiEndpoint.
78-
* `get_apis` - Get a list of Apis for a given workspace
79-
* `upsert_api` - Upsert an Api
74+
* [delete_api](docs/apis/deleteapi.md) - Delete an Api.
75+
* [generate_open_api_spec](docs/apis/generateopenapispec.md) - Generate an OpenAPI specification for a particular Api.
76+
* [generate_postman_collection](docs/apis/generatepostmancollection.md) - Generate a Postman collection for a particular Api.
77+
* [get_all_api_versions](docs/apis/getallapiversions.md) - Get all Api versions for a particular ApiEndpoint.
78+
* [get_apis](docs/apis/getapis.md) - Get a list of Apis for a given workspace
79+
* [upsert_api](docs/apis/upsertapi.md) - Upsert an Api
8080

81-
### embeds
81+
### [embeds](docs/embeds/README.md)
8282

83-
* `get_embed_access_token` - Get an embed access token for the current workspace.
84-
* `get_valid_embed_access_tokens` - Get all valid embed access tokens for the current workspace.
85-
* `revoke_embed_access_token` - Revoke an embed access EmbedToken.
83+
* [get_embed_access_token](docs/embeds/getembedaccesstoken.md) - Get an embed access token for the current workspace.
84+
* [get_valid_embed_access_tokens](docs/embeds/getvalidembedaccesstokens.md) - Get all valid embed access tokens for the current workspace.
85+
* [revoke_embed_access_token](docs/embeds/revokeembedaccesstoken.md) - Revoke an embed access EmbedToken.
8686

87-
### metadata
87+
### [metadata](docs/metadata/README.md)
8888

89-
* `delete_version_metadata` - Delete metadata for a particular apiID and versionID.
90-
* `get_version_metadata` - Get all metadata for a particular apiID and versionID.
91-
* `insert_version_metadata` - Insert metadata for a particular apiID and versionID.
89+
* [delete_version_metadata](docs/metadata/deleteversionmetadata.md) - Delete metadata for a particular apiID and versionID.
90+
* [get_version_metadata](docs/metadata/getversionmetadata.md) - Get all metadata for a particular apiID and versionID.
91+
* [insert_version_metadata](docs/metadata/insertversionmetadata.md) - Insert metadata for a particular apiID and versionID.
9292

93-
### plugins
93+
### [plugins](docs/plugins/README.md)
9494

95-
* `get_plugins` - Get all plugins for the current workspace.
96-
* `run_plugin` - Run a plugin
97-
* `upsert_plugin` - Upsert a plugin
95+
* [get_plugins](docs/plugins/getplugins.md) - Get all plugins for the current workspace.
96+
* [run_plugin](docs/plugins/runplugin.md) - Run a plugin
97+
* [upsert_plugin](docs/plugins/upsertplugin.md) - Upsert a plugin
9898

99-
### requests
99+
### [requests](docs/requests/README.md)
100100

101-
* `generate_request_postman_collection` - Generate a Postman collection for a particular request.
102-
* `get_request_from_event_log` - Get information about a particular request.
103-
* `query_event_log` - Query the event log to retrieve a list of requests.
101+
* [generate_request_postman_collection](docs/requests/generaterequestpostmancollection.md) - Generate a Postman collection for a particular request.
102+
* [get_request_from_event_log](docs/requests/getrequestfromeventlog.md) - Get information about a particular request.
103+
* [query_event_log](docs/requests/queryeventlog.md) - Query the event log to retrieve a list of requests.
104104

105-
### schemas
105+
### [schemas](docs/schemas/README.md)
106106

107-
* `delete_schema` - Delete a particular schema revision for an Api.
108-
* `download_schema` - Download the latest schema for a particular apiID.
109-
* `download_schema_revision` - Download a particular schema revision for an Api.
110-
* `get_schema` - Get information about the latest schema.
111-
* `get_schema_diff` - Get a diff of two schema revisions for an Api.
112-
* `get_schema_revision` - Get information about a particular schema revision for an Api.
113-
* `get_schemas` - Get information about all schemas associated with a particular apiID.
114-
* `register_schema` - Register a schema.
107+
* [delete_schema](docs/schemas/deleteschema.md) - Delete a particular schema revision for an Api.
108+
* [download_schema](docs/schemas/downloadschema.md) - Download the latest schema for a particular apiID.
109+
* [download_schema_revision](docs/schemas/downloadschemarevision.md) - Download a particular schema revision for an Api.
110+
* [get_schema](docs/schemas/getschema.md) - Get information about the latest schema.
111+
* [get_schema_diff](docs/schemas/getschemadiff.md) - Get a diff of two schema revisions for an Api.
112+
* [get_schema_revision](docs/schemas/getschemarevision.md) - Get information about a particular schema revision for an Api.
113+
* [get_schemas](docs/schemas/getschemas.md) - Get information about all schemas associated with a particular apiID.
114+
* [register_schema](docs/schemas/registerschema.md) - Register a schema.
115115
<!-- End SDK Available Operations -->
116116

117117
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,4 +342,12 @@ Based on:
342342
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
343343
- Speakeasy CLI 1.22.1 (2.20.1) https://github.com/speakeasy-api/speakeasy
344344
### Releases
345-
- [PyPI v1.18.0] https://pypi.org/project/speakeasy-client-sdk-python/1.18.0 - .
345+
- [PyPI v1.18.0] https://pypi.org/project/speakeasy-client-sdk-python/1.18.0 - .
346+
347+
## 2023-04-25 09:12:41
348+
### Changes
349+
Based on:
350+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
351+
- Speakeasy CLI 1.23.0 (2.21.0) https://github.com/speakeasy-api/speakeasy
352+
### Releases
353+
- [PyPI v1.19.0] https://pypi.org/project/speakeasy-client-sdk-python/1.19.0 - .

‎USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Start SDK Example Usage -->
22
```python
33
import speakeasy
4-
from speakeasy.models import operations, shared
4+
from speakeasy.models import operations
55

66
s = speakeasy.Speakeasy(
77
security=shared.Security(
@@ -32,7 +32,7 @@ req = operations.GetApisRequest(
3232
and_=False,
3333
),
3434
)
35-
35+
3636
res = s.apis.get_apis(req)
3737

3838
if res.apis is not None:

‎docs/apiendpoints/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# api_endpoints
2+
3+
REST APIs for managing ApiEndpoint entities
4+
5+
6+
* [delete_api_endpoint](deleteapiendpoint.md) - Delete an ApiEndpoint.
7+
* [find_api_endpoint](findapiendpoint.md) - Find an ApiEndpoint via its displayName.
8+
* [generate_open_api_spec_for_api_endpoint](generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint.
9+
* [generate_postman_collection_for_api_endpoint](generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint.
10+
* [get_all_api_endpoints](getallapiendpoints.md) - Get all Api endpoints for a particular apiID.
11+
* [get_all_for_version_api_endpoints](getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID.
12+
* [get_api_endpoint](getapiendpoint.md) - Get an ApiEndpoint.
13+
* [upsert_api_endpoint](upsertapiendpoint.md) - Upsert an ApiEndpoint.

‎docs/apiendpoints/deleteapiendpoint.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# delete_api_endpoint
2+
Available in: `api_endpoints`
3+
4+
Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
5+
6+
## Example Usage
7+
```python
8+
import speakeasy
9+
from speakeasy.models import operations
10+
11+
s = speakeasy.Speakeasy(
12+
security=shared.Security(
13+
api_key="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.DeleteAPIEndpointRequest(
19+
api_endpoint_id="delectus",
20+
api_id="tempora",
21+
version_id="suscipit",
22+
)
23+
24+
res = s.api_endpoints.delete_api_endpoint(req)
25+
26+
if res.status_code == 200:
27+
# handle response
28+
```

‎docs/apiendpoints/findapiendpoint.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# find_api_endpoint
2+
Available in: `api_endpoints`
3+
4+
Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema).
5+
This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints.
6+
7+
## Example Usage
8+
```python
9+
import speakeasy
10+
from speakeasy.models import operations
11+
12+
s = speakeasy.Speakeasy(
13+
security=shared.Security(
14+
api_key="YOUR_API_KEY_HERE",
15+
),
16+
)
17+
18+
19+
req = operations.FindAPIEndpointRequest(
20+
api_id="molestiae",
21+
display_name="minus",
22+
version_id="placeat",
23+
)
24+
25+
res = s.api_endpoints.find_api_endpoint(req)
26+
27+
if res.api_endpoint is not None:
28+
# handle response
29+
```

‎docs/apiendpoints/generateopenapispecforapiendpoint.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# generate_open_api_spec_for_api_endpoint
2+
Available in: `api_endpoints`
3+
4+
This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document.
5+
Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
6+
7+
## Example Usage
8+
```python
9+
import speakeasy
10+
from speakeasy.models import operations
11+
12+
s = speakeasy.Speakeasy(
13+
security=shared.Security(
14+
api_key="YOUR_API_KEY_HERE",
15+
),
16+
)
17+
18+
19+
req = operations.GenerateOpenAPISpecForAPIEndpointRequest(
20+
api_endpoint_id="voluptatum",
21+
api_id="iusto",
22+
version_id="excepturi",
23+
)
24+
25+
res = s.api_endpoints.generate_open_api_spec_for_api_endpoint(req)
26+
27+
if res.generate_open_api_spec_diff is not None:
28+
# handle response
29+
```

‎docs/apiendpoints/generatepostmancollectionforapiendpoint.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# generate_postman_collection_for_api_endpoint
2+
Available in: `api_endpoints`
3+
4+
Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.
5+
6+
## Example Usage
7+
```python
8+
import speakeasy
9+
from speakeasy.models import operations
10+
11+
s = speakeasy.Speakeasy(
12+
security=shared.Security(
13+
api_key="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.GeneratePostmanCollectionForAPIEndpointRequest(
19+
api_endpoint_id="nisi",
20+
api_id="recusandae",
21+
version_id="temporibus",
22+
)
23+
24+
res = s.api_endpoints.generate_postman_collection_for_api_endpoint(req)
25+
26+
if res.postman_collection is not None:
27+
# handle response
28+
```

‎docs/apiendpoints/getallapiendpoints.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# get_all_api_endpoints
2+
Available in: `api_endpoints`
3+
4+
Get all Api endpoints for a particular apiID.
5+
6+
## Example Usage
7+
```python
8+
import speakeasy
9+
from speakeasy.models import operations
10+
11+
s = speakeasy.Speakeasy(
12+
security=shared.Security(
13+
api_key="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.GetAllAPIEndpointsRequest(
19+
api_id="ab",
20+
)
21+
22+
res = s.api_endpoints.get_all_api_endpoints(req)
23+
24+
if res.api_endpoints is not None:
25+
# handle response
26+
```

‎docs/apiendpoints/getallforversionapiendpoints.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# get_all_for_version_api_endpoints
2+
Available in: `api_endpoints`
3+
4+
Get all ApiEndpoints for a particular apiID and versionID.
5+
6+
## Example Usage
7+
```python
8+
import speakeasy
9+
from speakeasy.models import operations
10+
11+
s = speakeasy.Speakeasy(
12+
security=shared.Security(
13+
api_key="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.GetAllForVersionAPIEndpointsRequest(
19+
api_id="quis",
20+
version_id="veritatis",
21+
)
22+
23+
res = s.api_endpoints.get_all_for_version_api_endpoints(req)
24+
25+
if res.api_endpoints is not None:
26+
# handle response
27+
```

0 commit comments

Comments
 (0)