Skip to content

Commit

Permalink
chore: regenerate using speakeasy 1.439.0 and platform-api 116f85a5d8…
Browse files Browse the repository at this point in the history
…0f9a2d896d13f392192ffbe214fcfe
  • Loading branch information
pmalek committed Nov 14, 2024
1 parent 68361d1 commit 7742961
Show file tree
Hide file tree
Showing 154 changed files with 7,349 additions and 746 deletions.
298 changes: 286 additions & 12 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ generation:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
go:
version: 0.1.5
version: 0.1.6
additionalDependencies: {}
allowUnknownFieldsInWeakUnions: false
clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError
flattenGlobalSecurity: true
imports:
option: openapi
Expand Down
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ By Default, an API error will return `sdkerrors.SDKError`. When custom error res

For example, the `ListControlPlanes` function may return the following errors:

| Error Type | Status Code | Content Type |
| ---------------------------- | ---------------------------- | ---------------------------- |
| sdkerrors.BadRequestError | 400 | application/problem+json |
| sdkerrors.UnauthorizedError | 401 | application/problem+json |
| sdkerrors.ForbiddenError | 403 | application/problem+json |
| sdkerrors.ServiceUnavailable | 503 | application/problem+json |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
| Error Type | Status Code | Content Type |
| ---------------------------- | ----------- | ------------------------ |
| sdkerrors.BadRequestError | 400 | application/problem+json |
| sdkerrors.UnauthorizedError | 401 | application/problem+json |
| sdkerrors.ForbiddenError | 403 | application/problem+json |
| sdkerrors.ServiceUnavailable | 503 | application/problem+json |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

### Example

Expand Down Expand Up @@ -96,14 +96,14 @@ func main() {

### Select Server by Index

You can override the default server globally using the `WithServerIndex` option 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:
You can override the default server globally using the `WithServerIndex(serverIndex int)` option 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:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://global.api.konghq.com` | None |
| 1 | `https://us.api.konghq.com` | None |
| 2 | `https://eu.api.konghq.com` | None |
| 3 | `https://au.api.konghq.com` | None |
| # | Server |
| --- | ------------------------------- |
| 0 | `https://global.api.konghq.com` |
| 1 | `https://us.api.konghq.com` |
| 2 | `https://eu.api.konghq.com` |
| 3 | `https://au.api.konghq.com` |

#### Example

Expand Down Expand Up @@ -146,10 +146,9 @@ func main() {

```


### Override Server URL Per-Client

The default server can also be overridden globally using the `WithServerURL` option when initializing the SDK client instance. For example:
The default server can also be overridden globally using the `WithServerURL(serverURL string)` option when initializing the SDK client instance. For example:
```go
package main

Expand Down Expand Up @@ -259,11 +258,11 @@ This can be a convenient way to configure timeouts, cookies, proxies, custom hea

This SDK supports the following security schemes globally:

| Name | Type | Scheme |
| -------------------------- | -------------------------- | -------------------------- |
| `PersonalAccessToken` | http | HTTP Bearer |
| `SystemAccountAccessToken` | http | HTTP Bearer |
| `KonnectAccessToken` | http | HTTP Bearer |
| Name | Type | Scheme |
| -------------------------- | ---- | ----------- |
| `PersonalAccessToken` | http | HTTP Bearer |
| `SystemAccountAccessToken` | http | HTTP Bearer |
| `KonnectAccessToken` | http | HTTP Bearer |

You can set the security parameters through the `WithSecurity` option 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:
```go
Expand Down
Loading

0 comments on commit 7742961

Please sign in to comment.