https://github.com/speakeasy-api/speakeasy-client-sdk-go

Developer-friendly & type-safe Go SDK specifically catered to leverage the Speakeasy API.
https://github.com/speakeasy-api/speakeasy-client-sdk-go
go sdk speakeasy
Last synced: 3 months ago
JSON representation
Developer-friendly & type-safe Go SDK specifically catered to leverage the Speakeasy API.
Host: GitHub
URL: https://github.com/speakeasy-api/speakeasy-client-sdk-go
Owner: speakeasy-api
License: apache-2.0
Created: 2022-08-25T14:19:08.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-11-27T22:03:35.000Z (11 months ago)
Last Synced: 2024-11-30T19:44:54.171Z (11 months ago)
Topics: go, sdk, speakeasy
Language: Go
Homepage: https://speakeasy.com
Size: 1.72 MB
Stars: 0
Watchers: 13
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

          


    

	

	

	

    

    Speakeasy Go SDK

    The platform to build, test, document and distribute APIs to your users ❤️ Building really high quality APIs is hard. Speakeasy is a set of OpenAPI tools to make it easier.

    Developer-friendly & type-safe Go SDK specifically catered to leverage the Speakeasy API.

    

    



## Summary

Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events

For more information about the API: [The Speakeasy Platform Documentation](/docs)

## Table of Contents

  * [SDK Installation](#sdk-installation)

  * [SDK Example Usage](#sdk-example-usage)

  * [Available Resources and Operations](#available-resources-and-operations)

  * [Error Handling](#error-handling)

  * [Server Selection](#server-selection)

  * [Custom HTTP Client](#custom-http-client)

  * [Authentication](#authentication)

  * [Global Parameters](#global-parameters)

  * [Retries](#retries)

## SDK Installation

To add the SDK as a dependency to your project:

```bash

go get github.com/speakeasy-api/speakeasy-client-sdk-go

```

## SDK Example Usage

### Example

```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/shared"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil)

	if err != nil {

		log.Fatal(err)

	}

	if res != nil {

		// handle response

	}

}

```

## Available Resources and Operations

Available methods

### [Artifacts](docs/sdks/artifacts/README.md)

* [CreateRemoteSource](docs/sdks/artifacts/README.md#createremotesource) - Configure a new remote source

* [GetBlob](docs/sdks/artifacts/README.md#getblob) - Get blob for a particular digest

* [GetManifest](docs/sdks/artifacts/README.md#getmanifest) - Get manifest for a particular reference

* [GetNamespaces](docs/sdks/artifacts/README.md#getnamespaces) - Each namespace contains many revisions.

* [GetRevisions](docs/sdks/artifacts/README.md#getrevisions)

* [GetTags](docs/sdks/artifacts/README.md#gettags)

* [ListRemoteSources](docs/sdks/artifacts/README.md#listremotesources) - Get remote sources attached to a particular namespace

* [PostTags](docs/sdks/artifacts/README.md#posttags) - Add tags to an existing revision

* [Preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints

* [SetArchived](docs/sdks/artifacts/README.md#setarchived) - Set whether a namespace is archived

* [SetVisibility](docs/sdks/artifacts/README.md#setvisibility) - Set visibility of a namespace with an existing metadata entry

### [Auth](docs/sdks/auth/README.md)

* [GetAccess](docs/sdks/auth/README.md#getaccess) - Get access allowances for a particular workspace

* [GetAccessToken](docs/sdks/auth/README.md#getaccesstoken) - Get or refresh an access token for the current workspace.

* [GetUser](docs/sdks/auth/README.md#getuser) - Get information about the current user.

* [ValidateAPIKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.

### [CodeSamples](docs/sdks/codesamples/README.md)

* [GenerateCodeSamplePreview](docs/sdks/codesamples/README.md#generatecodesamplepreview) - Generate Code Sample previews from a file and configuration parameters.

* [GenerateCodeSamplePreviewAsync](docs/sdks/codesamples/README.md#generatecodesamplepreviewasync) - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling.

* [Get](docs/sdks/codesamples/README.md#get) - Retrieve usage snippets

* [GetCodeSamplePreviewAsync](docs/sdks/codesamples/README.md#getcodesamplepreviewasync) - Poll for the result of an asynchronous Code Sample preview generation.

### [Events](docs/sdks/events/README.md)

* [GetEventsByTarget](docs/sdks/events/README.md#geteventsbytarget) - Load recent events for a particular workspace

* [GetTargets](docs/sdks/events/README.md#gettargets) - Load targets for a particular workspace

* [GetTargetsDeprecated](docs/sdks/events/README.md#gettargetsdeprecated) - Load targets for a particular workspace

* [Post](docs/sdks/events/README.md#post) - Post events for a specific workspace

* [Search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field

### [Github](docs/sdks/github/README.md)

* [CheckAccess](docs/sdks/github/README.md#checkaccess)

* [CheckPublishingPRs](docs/sdks/github/README.md#checkpublishingprs)

* [CheckPublishingSecrets](docs/sdks/github/README.md#checkpublishingsecrets)

* [ConfigureCodeSamples](docs/sdks/github/README.md#configurecodesamples)

* [ConfigureMintlifyRepo](docs/sdks/github/README.md#configuremintlifyrepo)

* [ConfigureTarget](docs/sdks/github/README.md#configuretarget)

* [GetAction](docs/sdks/github/README.md#getaction)

* [GetSetup](docs/sdks/github/README.md#getsetup)

* [LinkGithub](docs/sdks/github/README.md#linkgithub)

* [StorePublishingSecrets](docs/sdks/github/README.md#storepublishingsecrets)

* [TriggerAction](docs/sdks/github/README.md#triggeraction)

### [Organizations](docs/sdks/organizations/README.md)

* [Create](docs/sdks/organizations/README.md#create) - Create an organization

* [CreateBillingAddOns](docs/sdks/organizations/README.md#createbillingaddons) - Create billing add ons

* [CreateFreeTrial](docs/sdks/organizations/README.md#createfreetrial) - Create a free trial for an organization

* [DeleteBillingAddOn](docs/sdks/organizations/README.md#deletebillingaddon) - Delete billing add ons

* [Get](docs/sdks/organizations/README.md#get) - Get organization

* [GetAll](docs/sdks/organizations/README.md#getall) - Get organizations for a user

* [GetBillingAddOns](docs/sdks/organizations/README.md#getbillingaddons) - Get billing add ons

* [GetUsage](docs/sdks/organizations/README.md#getusage) - Get billing usage summary for a particular organization

### [PublishingTokens](docs/sdks/publishingtokens/README.md)

* [Create](docs/sdks/publishingtokens/README.md#create) - Create a publishing token for a workspace

* [Delete](docs/sdks/publishingtokens/README.md#delete) - Delete a specific publishing token

* [Get](docs/sdks/publishingtokens/README.md#get) - Get a specific publishing token

* [List](docs/sdks/publishingtokens/README.md#list) - Get publishing tokens for a workspace

* [ResolveMetadata](docs/sdks/publishingtokens/README.md#resolvemetadata) - Get metadata about the token

* [ResolveTarget](docs/sdks/publishingtokens/README.md#resolvetarget) - Get a specific publishing token target

* [Update](docs/sdks/publishingtokens/README.md#update) - Updates the validitity period of a publishing token

### [Reports](docs/sdks/reports/README.md)

* [GetChangesReportSignedURL](docs/sdks/reports/README.md#getchangesreportsignedurl) - Get the signed access url for the change reports for a particular document.

* [GetLintingReportSignedURL](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.

* [UploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.

### [SchemaStore](docs/sdks/schemastore/README.md)

* [CreateSchemaStoreItem](docs/sdks/schemastore/README.md#createschemastoreitem) - Create a schema in the schema store

* [GetSchemaStoreItem](docs/sdks/schemastore/README.md#getschemastoreitem) - Get a OAS schema from the schema store

### [ShortURLs](docs/sdks/shorturls/README.md)

* [Create](docs/sdks/shorturls/README.md#create) - Shorten a URL.

### [Subscriptions](docs/sdks/subscriptions/README.md)

* [ActivateSubscriptionNamespace](docs/sdks/subscriptions/README.md#activatesubscriptionnamespace) - Activate an ignored namespace for a subscription

* [IgnoreSubscriptionNamespace](docs/sdks/subscriptions/README.md#ignoresubscriptionnamespace) - Ignored a namespace for a subscription

### [Suggest](docs/sdks/suggest/README.md)

* [Suggest](docs/sdks/suggest/README.md#suggest) - Generate suggestions for improving an OpenAPI document.

* [SuggestItems](docs/sdks/suggest/README.md#suggestitems) - Generate generic suggestions for a list of items.

* [SuggestOpenAPI](docs/sdks/suggest/README.md#suggestopenapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.

* [SuggestOpenAPIRegistry](docs/sdks/suggest/README.md#suggestopenapiregistry) - Generate suggestions for improving an OpenAPI document stored in the registry.

### [Workspaces](docs/sdks/workspaces/README.md)

* [Create](docs/sdks/workspaces/README.md#create) - Create a workspace

* [CreateToken](docs/sdks/workspaces/README.md#createtoken) - Create a token for a particular workspace

* [DeleteToken](docs/sdks/workspaces/README.md#deletetoken) - Delete a token for a particular workspace

* [Get](docs/sdks/workspaces/README.md#get) - Get workspace by context

* [GetAll](docs/sdks/workspaces/README.md#getall) - Get workspaces for a user

* [GetByID](docs/sdks/workspaces/README.md#getbyid) - Get workspace

* [GetFeatureFlags](docs/sdks/workspaces/README.md#getfeatureflags) - Get workspace feature flags

* [GetSettings](docs/sdks/workspaces/README.md#getsettings) - Get workspace settings

* [GetTeam](docs/sdks/workspaces/README.md#getteam) - Get team members for a particular workspace

* [GetTokens](docs/sdks/workspaces/README.md#gettokens) - Get tokens for a particular workspace

* [GrantAccess](docs/sdks/workspaces/README.md#grantaccess) - Grant a user access to a particular workspace

* [RevokeAccess](docs/sdks/workspaces/README.md#revokeaccess) - Revoke a user's access to a particular workspace

* [SetFeatureFlags](docs/sdks/workspaces/README.md#setfeatureflags) - Set workspace feature flags

* [Update](docs/sdks/workspaces/README.md#update) - Update workspace details

* [UpdateSettings](docs/sdks/workspaces/README.md#updatesettings) - Update workspace settings

## Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return `sdkerrors.SDKError`. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation.

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

| Error Type         | Status Code | Content Type     |

| ------------------ | ----------- | ---------------- |

| sdkerrors.Error    | 4XX         | application/json |

| sdkerrors.SDKError | 5XX         | \*/\*            |

### Example

```go

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/sdkerrors"

	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil)

	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())

		}

	}

}

```

## Server Selection

### Select Server by Name

You can override the default server globally using the `WithServer(server string)` 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                           | Description |

| ------ | -------------------------------- | ----------- |

| `prod` | `https://api.prod.speakeasy.com` |             |

#### Example

```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/shared"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithServer("prod"),

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil)

	if err != nil {

		log.Fatal(err)

	}

	if res != nil {

		// handle response

	}

}

```

### Override Server URL Per-Client

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

import (

	"context"

	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"

	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithServerURL("https://api.prod.speakeasy.com"),

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil)

	if err != nil {

		log.Fatal(err)

	}

	if res != nil {

		// handle response

	}

}

```

## Custom HTTP Client

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:

```go

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.

```go

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.

## Authentication

### Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name                  | Type   | Scheme      |

| --------------------- | ------ | ----------- |

| `APIKey`              | apiKey | API key     |

| `Bearer`              | http   | HTTP Bearer |

| `WorkspaceIdentifier` | apiKey | API key     |

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

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/shared"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil)

	if err != nil {

		log.Fatal(err)

	}

	if res != nil {

		// handle response

	}

}

```

## Global Parameters

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 `workspace_id` to `""` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetAccessToken`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

### Available Globals

The following global parameter is available.

| Name        | Type   | Description                |

| ----------- | ------ | -------------------------- |

| WorkspaceID | string | The WorkspaceID parameter. |

### Example

```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"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New()

	res, err := s.Auth.GetAccessToken(ctx, operations.GetAccessTokenRequest{

		WorkspaceID: "",

	})

	if err != nil {

		log.Fatal(err)

	}

	if res.AccessToken != nil {

		// handle response

	}

}

```

## Retries

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 `retry.Config` object to the call by using the `WithRetries` option:

```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/shared"

	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"

	"log"

	"pkg/models/operations"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil, operations.WithRetries(

		retry.Config{

			Strategy: "backoff",

			Backoff: &retry.BackoffStrategy{

				InitialInterval: 1,

				MaxInterval:     50,

				Exponent:        1.1,

				MaxElapsedTime:  100,

			},

			RetryConnectionErrors: false,

		}))

	if err != nil {

		log.Fatal(err)

	}

	if res != 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:

```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/shared"

	"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/retry"

	"log"

)

func main() {

	ctx := context.Background()

	s := speakeasyclientsdkgo.New(

		speakeasyclientsdkgo.WithRetryConfig(

			retry.Config{

				Strategy: "backoff",

				Backoff: &retry.BackoffStrategy{

					InitialInterval: 1,

					MaxInterval:     50,

					Exponent:        1.1,

					MaxElapsedTime:  100,

				},

				RetryConnectionErrors: false,

			}),

		speakeasyclientsdkgo.WithSecurity(shared.Security{

			APIKey: speakeasyclientsdkgo.String(""),

		}),

	)

	res, err := s.Artifacts.CreateRemoteSource(ctx, nil)

	if err != nil {

		log.Fatal(err)

	}

	if res != nil {

		// handle response

	}

}

```

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

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/speakeasy-api/speakeasy-client-sdk-go

Awesome Lists containing this project

README

Speakeasy Go SDK
