go get github.com/speakeasy-api/speakeasy-client-sdk-go
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.GetApisRequest{}
ctx := context.Background()
res, err := s.Apis.GetApis(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.Apis != nil {
// handle response
}
}
- DeleteAPI - Delete an Api.
- GenerateOpenAPISpec - Generate an OpenAPI specification for a particular Api.
- GeneratePostmanCollection - Generate a Postman collection for a particular Api.
- GetAllAPIVersions - Get all Api versions for a particular ApiEndpoint.
- GetApis - Get a list of Apis for a given workspace
- UpsertAPI - Upsert an Api
- DeleteAPIEndpoint - Delete an ApiEndpoint.
- FindAPIEndpoint - Find an ApiEndpoint via its displayName.
- GenerateOpenAPISpecForAPIEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
- GeneratePostmanCollectionForAPIEndpoint - Generate a Postman collection for a particular ApiEndpoint.
- GetAllAPIEndpoints - Get all Api endpoints for a particular apiID.
- GetAllForVersionAPIEndpoints - Get all ApiEndpoints for a particular apiID and versionID.
- GetAPIEndpoint - Get an ApiEndpoint.
- UpsertAPIEndpoint - Upsert an ApiEndpoint.
- DeleteVersionMetadata - Delete metadata for a particular apiID and versionID.
- GetVersionMetadata - Get all metadata for a particular apiID and versionID.
- InsertVersionMetadata - Insert metadata for a particular apiID and versionID.
- DeleteSchema - Delete a particular schema revision for an Api.
- DownloadSchema - Download the latest schema for a particular apiID.
- DownloadSchemaRevision - Download a particular schema revision for an Api.
- GetSchema - Get information about the latest schema.
- GetSchemaDiff - Get a diff of two schema revisions for an Api.
- GetSchemaRevision - Get information about a particular schema revision for an Api.
- GetSchemas - Get information about all schemas associated with a particular apiID.
- RegisterSchema - Register a schema.
- GetBlob - Get blob for a particular digest
- GetManifest - Get manifest for a particular reference
- GetNamespaces - Each namespace contains many revisions.
- GetRevisions
- GetTags
- PostTags - Add tags to an existing revision
- Preflight - Get access token for communicating with OCI distribution endpoints
- GetAccessToken - Get or refresh an access token for the current workspace.
- GetUser - Get information about the current user.
- GetWorkspaceAccess - Get access allowances for a particular workspace
- ValidateAPIKey - Validate the current api key.
- GenerateRequestPostmanCollection - Generate a Postman collection for a particular request.
- GetRequestFromEventLog - Get information about a particular request.
- QueryEventLog - Query the event log to retrieve a list of requests.
- FetchPublishingPRs
- GithubCheckAccess
- GithubCheckPublishingSecrets
- GithubConfigureTarget
- GithubStorePublishingSecrets
- GithubTriggerAction
- CreateFreeTrial - Create a free trial for an organization
- GetOrganizationUsage - Get billing usage summary for a particular organization
- GetOrganizations - Get organizations for a user
- GetChangesReportSignedURL - Get the signed access url for the change reports for a particular document.
- GetLintingReportSignedURL - Get the signed access url for the linting reports for a particular document.
- UploadReport - Upload a report.
- SuggestOperationIDs - Generate operation ID suggestions.
- GetEmbedAccessToken - Get an embed access token for the current workspace.
- GetValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.
- RevokeEmbedAccessToken - Revoke an embed access EmbedToken.
- GetWorkspaceEventsByTarget - Load recent events for a particular workspace
- GetWorkspaceTargets - Load targets for a particular workspace
- PostWorkspaceEvents - Post events for a specific workspace
- SearchWorkspaceEvents - Search events for a particular workspace by any field
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
Error Object | Status Code | Content Type |
---|---|---|
sdkerrors.Error | 5XX | application/json |
sdkerrors.SDKError | 4xx-5xx | / |
package main
import (
"context"
"errors"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/sdkerrors"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.GetWorkspaceEventsByTargetRequest{
TargetID: "<value>",
}
ctx := context.Background()
res, err := s.Events.GetWorkspaceEventsByTarget(ctx, request)
if err != nil {
var e *sdkerrors.Error
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}
You can override the default server globally using the WithServer
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 names associated with the available servers:
Name | Server | Variables |
---|---|---|
prod |
https://api.prod.speakeasyapi.dev |
None |
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithServer("prod"),
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.DeleteAPIRequest{
APIID: "<value>",
VersionID: "<value>",
}
ctx := context.Background()
res, err := s.Apis.DeleteAPI(ctx, request)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
The default server can also be overridden globally using the WithServerURL
option when initializing the SDK client instance. For example:
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithServerURL("https://api.prod.speakeasyapi.dev"),
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.DeleteAPIRequest{
APIID: "<value>",
VersionID: "<value>",
}
ctx := context.Background()
res, err := s.Apis.DeleteAPI(ctx, request)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}
The built-in net/http
client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)
This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
This SDK supports the following security schemes globally:
Name | Type | Scheme |
---|---|---|
APIKey |
apiKey | API key |
Bearer |
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:
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.DeleteAPIRequest{
APIID: "<value>",
VersionID: "<value>",
}
ctx := context.Background()
res, err := s.Apis.DeleteAPI(ctx, request)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set workspaceID
to "<value>"
at SDK initialization and then you do not have to pass the same value on calls to operations like GetWorkspaceEventsByTarget
. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
Name | Type | Required | Description |
---|---|---|---|
WorkspaceID | string | The WorkspaceID parameter. |
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.GetWorkspaceEventsByTargetRequest{
TargetID: "<value>",
}
ctx := context.Background()
res, err := s.Events.GetWorkspaceEventsByTarget(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.CliEventBatch != nil {
// handle response
}
}
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig
object to the call by using the WithRetries
option:
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/utils"
"log"
"pkg/models/operations"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.GetWorkspaceAccessRequest{}
ctx := context.Background()
res, err := s.Auth.GetWorkspaceAccess(ctx, request, operations.WithRetries(
utils.RetryConfig{
Strategy: "backoff",
Backoff: &utils.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}))
if err != nil {
log.Fatal(err)
}
if res.AccessDetails != nil {
// handle response
}
}
If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig
option at SDK initialization:
package main
import (
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/utils"
"log"
)
func main() {
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithRetryConfig(
utils.RetryConfig{
Strategy: "backoff",
Backoff: &utils.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
request := operations.GetWorkspaceAccessRequest{}
ctx := context.Background()
res, err := s.Auth.GetWorkspaceAccess(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.AccessDetails != nil {
// handle response
}
}