Skip to content

Commit 8517d3a

Browse files
chore: update readme and action to v3.9
1 parent 2aee67a commit 8517d3a

File tree

2 files changed

+63
-4
lines changed

2 files changed

+63
-4
lines changed

.github/workflows/generation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77

88
jobs:
99
generate:
10-
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v3.7
10+
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v3.9
1111
with:
1212
speakeasy_version: latest
1313
openapi_doc_location: https://docs.speakeasyapi.dev/openapi.yaml

README.md

100755100644
Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ This is the Speakeasy API Client SDK for Python. It is generated from our OpenAP
44

55
This SDK was generated using Speakeasy's SDK Generator. For more information on how to use the generator to generate your own SDKs, please see the [Speakeasy Client SDK Generator Docs](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks).
66

7-
## Installation
7+
<!-- Start SDK Installation -->
8+
## SDK Installation
89

910
```bash
1011
pip install speakeasy-client-sdk-python
1112
```
13+
<!-- End SDK Installation -->
1214

1315
## Example usage
1416
```python
@@ -31,11 +33,68 @@ req = operations.GetApisRequest(
3133
)
3234
)
3335

34-
res = s.get_apis(req)
36+
res = s.apis.get_apis(req)
3537

3638
if res.status_code == 200:
3739
print(res.apis)
3840
else:
3941
print(res.error)
4042

41-
```
43+
```
44+
45+
46+
<!-- Start SDK Available Operations -->
47+
## SDK Available Operations
48+
49+
### ApiEndpoints
50+
51+
* `delete_api_endpoint` - Delete an ApiEndpoint.
52+
* `find_api_endpoint` - Find an ApiEndpoint via its displayName.
53+
* `generate_open_api_spec_for_api_endpoint` - Generate an OpenAPI specification for a particular ApiEndpoint.
54+
* `generate_postman_collection_for_api_endpoint` - Generate a Postman collection for a particular ApiEndpoint.
55+
* `get_all_api_endpoints` - Get all Api endpoints for a particular apiID.
56+
* `get_all_for_version_api_endpoints` - Get all ApiEndpoints for a particular apiID and versionID.
57+
* `get_api_endpoint` - Get an ApiEndpoint.
58+
* `upsert_api_endpoint` - Upsert an ApiEndpoint.
59+
60+
### Apis
61+
62+
* `delete_api` - Delete an Api.
63+
* `generate_open_api_spec` - Generate an OpenAPI specification for a particular Api.
64+
* `generate_postman_collection` - Generate a Postman collection for a particular Api.
65+
* `get_all_api_versions` - Get all Api versions for a particular ApiEndpoint.
66+
* `get_apis` - Get a list of Apis for a given workspace
67+
* `upsert_api` - Upsert an Api
68+
69+
### Embeds
70+
71+
* `get_embed_access_token` - Get an embed access token for the current workspace.
72+
* `get_valid_embed_access_tokens` - Get all valid embed access tokens for the current workspace.
73+
* `revoke_embed_access_token` - Revoke an embed access EmbedToken.
74+
75+
### Metadata
76+
77+
* `delete_version_metadata` - Delete metadata for a particular apiID and versionID.
78+
* `get_version_metadata` - Get all metadata for a particular apiID and versionID.
79+
* `insert_version_metadata` - Insert metadata for a particular apiID and versionID.
80+
81+
### Requests
82+
83+
* `generate_request_postman_collection` - Generate a Postman collection for a particular request.
84+
* `get_request_from_event_log` - Get information about a particular request.
85+
* `query_event_log` - Query the event log to retrieve a list of requests.
86+
87+
### Schemas
88+
89+
* `delete_schema` - Delete a particular schema revision for an Api.
90+
* `download_schema` - Download the latest schema for a particular apiID.
91+
* `download_schema_revision` - Download a particular schema revision for an Api.
92+
* `get_schema` - Get information about the latest schema.
93+
* `get_schema_diff` - Get a diff of two schema revisions for an Api.
94+
* `get_schema_revision` - Get information about a particular schema revision for an Api.
95+
* `get_schemas` - Get information about all schemas associated with a particular apiID.
96+
* `register_schema` - Register a schema.
97+
98+
<!-- End SDK Available Operations -->
99+
100+
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

0 commit comments

Comments
 (0)