-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.101.0
- Loading branch information
1 parent
4987c7e
commit 85d1fba
Showing
186 changed files
with
19,868 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| env: | ||
| browser: true | ||
| es2021: true | ||
| node: true | ||
| extends: | ||
| - eslint:recommended | ||
| - plugin:@typescript-eslint/recommended | ||
| overrides: [] | ||
| parser: "@typescript-eslint/parser" | ||
| parserOptions: | ||
| ecmaVersion: latest | ||
| sourceType: module | ||
| plugins: | ||
| - "@typescript-eslint" | ||
| rules: | ||
| "@typescript-eslint/no-explicit-any": "off" | ||
| "no-prototype-builtins": "off" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # This allows generated code to be indexed correctly | ||
| *.ts linguist-generated=false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| dist/ | ||
| node_modules/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # openapi | ||
|
|
||
| <div align="left"> | ||
| <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> | ||
| <a href="https://github.com/TristanSpeakEasy/sdk-mono-repo-test.git/actions"><img src="https://img.shields.io/github/actions/workflow/status/TristanSpeakEasy/sdk-mono-repo-test/speakeasy_sdk_generation.yml?style=for-the-badge" /></a> | ||
|
|
||
| </div> | ||
|
|
||
| <!-- Start SDK Installation --> | ||
| # SDK Installation | ||
|
|
||
| ## NPM | ||
|
|
||
| ```bash | ||
| npm add openapi | ||
| ``` | ||
|
|
||
| ## Yarn | ||
|
|
||
| ```bash | ||
| yarn add openapi | ||
| ``` | ||
| <!-- End SDK Installation --> | ||
|
|
||
| ## SDK Example Usage | ||
| <!-- Start SDK Example Usage --> | ||
|
|
||
|
|
||
| ```typescript | ||
| import { SDK } from "openapi"; | ||
|
|
||
| (async () => { | ||
| const sdk = new SDK({ | ||
| apiKey: "", | ||
| }); | ||
|
|
||
| const res = await sdk.apis.getApis({ | ||
| metadata: { | ||
| South: ["Southwest"], | ||
| }, | ||
| op: { | ||
| and: false, | ||
| }, | ||
| }); | ||
|
|
||
| if (res.statusCode == 200) { | ||
| // handle response | ||
| } | ||
| })(); | ||
|
|
||
| ``` | ||
| <!-- End SDK Example Usage --> | ||
|
|
||
| <!-- Start SDK Available Operations --> | ||
| # Available Resources and Operations | ||
|
|
||
| ## [SDK](docs/sdks/sdk/README.md) | ||
|
|
||
| * [validateApiKey](docs/sdks/sdk/README.md#validateapikey) - Validate the current api key. | ||
|
|
||
| ## [apiEndpoints](docs/sdks/apiendpoints/README.md) | ||
|
|
||
| * [deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint. | ||
| * [findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName. | ||
| * [generateOpenApiSpecForApiEndpoint](docs/sdks/apiendpoints/README.md#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint. | ||
| * [generatePostmanCollectionForApiEndpoint](docs/sdks/apiendpoints/README.md#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint. | ||
| * [getAllApiEndpoints](docs/sdks/apiendpoints/README.md#getallapiendpoints) - Get all Api endpoints for a particular apiID. | ||
| * [getAllForVersionApiEndpoints](docs/sdks/apiendpoints/README.md#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID. | ||
| * [getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint. | ||
| * [upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint. | ||
|
|
||
| ## [apis](docs/sdks/apis/README.md) | ||
|
|
||
| * [deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api. | ||
| * [generateOpenApiSpec](docs/sdks/apis/README.md#generateopenapispec) - Generate an OpenAPI specification for a particular Api. | ||
| * [generatePostmanCollection](docs/sdks/apis/README.md#generatepostmancollection) - Generate a Postman collection for a particular Api. | ||
| * [getAllApiVersions](docs/sdks/apis/README.md#getallapiversions) - Get all Api versions for a particular ApiEndpoint. | ||
| * [getApis](docs/sdks/apis/README.md#getapis) - Get a list of Apis for a given workspace | ||
| * [upsertApi](docs/sdks/apis/README.md#upsertapi) - Upsert an Api | ||
|
|
||
| ## [embeds](docs/sdks/embeds/README.md) | ||
|
|
||
| * [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace. | ||
| * [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace. | ||
| * [revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken. | ||
|
|
||
| ## [metadata](docs/sdks/metadata/README.md) | ||
|
|
||
| * [deleteVersionMetadata](docs/sdks/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID. | ||
| * [getVersionMetadata](docs/sdks/metadata/README.md#getversionmetadata) - Get all metadata for a particular apiID and versionID. | ||
| * [insertVersionMetadata](docs/sdks/metadata/README.md#insertversionmetadata) - Insert metadata for a particular apiID and versionID. | ||
|
|
||
| ## [plugins](docs/sdks/plugins/README.md) | ||
|
|
||
| * [getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace. | ||
| * [runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin | ||
| * [upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin | ||
|
|
||
| ## [requests](docs/sdks/requests/README.md) | ||
|
|
||
| * [generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request. | ||
| * [getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request. | ||
| * [queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests. | ||
|
|
||
| ## [schemas](docs/sdks/schemas/README.md) | ||
|
|
||
| * [deleteSchema](docs/sdks/schemas/README.md#deleteschema) - Delete a particular schema revision for an Api. | ||
| * [downloadSchema](docs/sdks/schemas/README.md#downloadschema) - Download the latest schema for a particular apiID. | ||
| * [downloadSchemaRevision](docs/sdks/schemas/README.md#downloadschemarevision) - Download a particular schema revision for an Api. | ||
| * [getSchema](docs/sdks/schemas/README.md#getschema) - Get information about the latest schema. | ||
| * [getSchemaDiff](docs/sdks/schemas/README.md#getschemadiff) - Get a diff of two schema revisions for an Api. | ||
| * [getSchemaRevision](docs/sdks/schemas/README.md#getschemarevision) - Get information about a particular schema revision for an Api. | ||
| * [getSchemas](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID. | ||
| * [registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema. | ||
| <!-- End SDK Available Operations --> | ||
|
|
||
| <!-- Start Dev Containers --> | ||
|
|
||
|
|
||
|
|
||
| <!-- End Dev Containers --> | ||
|
|
||
| <!-- Placeholder for Future Speakeasy SDK Sections --> | ||
|
|
||
| # Development | ||
|
|
||
| ## Maturity | ||
|
|
||
| This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage | ||
| to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally | ||
| looking for the latest version. | ||
|
|
||
| ## Contributions | ||
|
|
||
| While we value open-source contributions to this SDK, this library is generated programmatically. | ||
| Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release! | ||
|
|
||
| ### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
|
|
||
|
|
||
| ## 2023-10-18 08:22:40 | ||
| ### Changes | ||
| Based on: | ||
| - OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml | ||
| - Speakeasy CLI 1.101.0 (2.161.0) https://github.com/speakeasy-api/speakeasy | ||
| ### Generated | ||
| - [typescript v0.1.0] speakeasy | ||
| ### Releases | ||
| - [NPM v0.1.0] https://www.npmjs.com/package/openapi/v/0.1.0 - speakeasy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <!-- Start SDK Example Usage --> | ||
|
|
||
|
|
||
| ```typescript | ||
| import { SDK } from "openapi"; | ||
|
|
||
| (async () => { | ||
| const sdk = new SDK({ | ||
| apiKey: "", | ||
| }); | ||
|
|
||
| const res = await sdk.apis.getApis({ | ||
| metadata: { | ||
| South: ["Southwest"], | ||
| }, | ||
| op: { | ||
| and: false, | ||
| }, | ||
| }); | ||
|
|
||
| if (res.statusCode == 200) { | ||
| // handle response | ||
| } | ||
| })(); | ||
|
|
||
| ``` | ||
| <!-- End SDK Example Usage --> |
10 changes: 10 additions & 0 deletions
10
speakeasy/docs/models/operations/deleteapiendpointrequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # DeleteApiEndpointRequest | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | ||
| | `apiEndpointID` | *string* | :heavy_check_mark: | The ID of the ApiEndpoint to delete. | | ||
| | `apiID` | *string* | :heavy_check_mark: | The ID of the Api the ApiEndpoint belongs to. | | ||
| | `versionID` | *string* | :heavy_check_mark: | The version ID of the Api the ApiEndpoint belongs to. | |
11 changes: 11 additions & 0 deletions
11
speakeasy/docs/models/operations/deleteapiendpointresponse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # DeleteApiEndpointResponse | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | ||
| | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | ||
| | `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response | | ||
| | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | | ||
| | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # DeleteApiRequest | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | | ||
| | `apiID` | *string* | :heavy_check_mark: | The ID of the Api to delete. | | ||
| | `versionID` | *string* | :heavy_check_mark: | The version ID of the Api to delete. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # DeleteApiResponse | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | ||
| | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | ||
| | `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response | | ||
| | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | | ||
| | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # DeleteSchemaRequest | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | | ||
| | `apiID` | *string* | :heavy_check_mark: | The ID of the Api to delete schemas for. | | ||
| | `revisionID` | *string* | :heavy_check_mark: | The revision ID of the schema to delete. | | ||
| | `versionID` | *string* | :heavy_check_mark: | The version ID of the Api to delete metadata for. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # DeleteSchemaResponse | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | ||
| | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | ||
| | `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response | | ||
| | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | | ||
| | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
11 changes: 11 additions & 0 deletions
11
speakeasy/docs/models/operations/deleteversionmetadatarequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # DeleteVersionMetadataRequest | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | | ||
| | `apiID` | *string* | :heavy_check_mark: | The ID of the Api to delete metadata for. | | ||
| | `metaKey` | *string* | :heavy_check_mark: | The key of the metadata to delete. | | ||
| | `metaValue` | *string* | :heavy_check_mark: | The value of the metadata to delete. | | ||
| | `versionID` | *string* | :heavy_check_mark: | The version ID of the Api to delete metadata for. | |
11 changes: 11 additions & 0 deletions
11
speakeasy/docs/models/operations/deleteversionmetadataresponse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # DeleteVersionMetadataResponse | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | ||
| | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | ||
| | `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response | | ||
| | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | | ||
| | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # DownloadSchemaRequest | ||
|
|
||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | | ||
| | `apiID` | *string* | :heavy_check_mark: | The ID of the Api to download the schema for. | | ||
| | `versionID` | *string* | :heavy_check_mark: | The version ID of the Api to delete metadata for. | |
Oops, something went wrong.