sdk

package module
v1.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 4, 2024 License: Apache-2.0 Imports: 0 Imported by: 0

README

iStreamPlanet SDK for Go

This is the iStreamPlanet SDK for the Go programming language. It is generated from the iStreamPlanet OpenAPI with OpenAPI Generator.

See https://istreamlabs.github.io/docs/sdks/golang

How to run

Prerequisites

A clean directory is required to ensure defunct files are removed. However, some files do need to be kept to ensure the SDK is generated properly.

This is automatically handled when using ./run.sh

Requirements

  • Docker

Generated SDK will be outputted to the isp folder.

# By default, it generates against prod
./run.sh

# Generate against stage
./run.sh stage

Verify SDK generated successfully

# There should be no build errors
go build ./...

# Running the example with valid client id, client secret, and org should be successful.
CLIENT_ID="<YOUR_CLIENT_ID>" CLIENT_SECRET="<YOUR_CLIENT_SECRET>" ORG="<ORG>" go run ./example

# Or use a JWT you already have:
AUTH_HEADER=$(restish auth-header isp) ORG="<ORG>" go run ./example

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL