Categorygithub.com/upbound/up-sdk-go
modulepackage
0.3.0
Repository: https://github.com/upbound/up-sdk-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
24
Files
160 SLOC

# README

Upbound Go SDK

up-sdk-go is the official Go SDK for Upbound. It is currently under active development and subject to breaking changes.

Supported Services

The following services are currently supported:

  • Accounts
  • Configurations
  • Control Planes
  • Organizations
  • Repositories
  • Robots
  • Tokens

Authentication

up-sdk-go currently defers authentication to the consumer by passing a configured http.Client. The _examples directory contains examples of how this can be accomplished with a cookiejar implementation and session tokens.

# Packages

Package apis contains Kubernetes API for the MXE provider.
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewClient builds a new default HTTP client for Upbound.
NewConfig builds a new Config for communicating with the Upbound API.

# Structs

Config represents common configuration for Upbound SDK clients.
DefaultErrorHandler is the default operations for handling errors returned by the Upbound API.
HTTPClient implements the Client interface and allows for overriding of base URL, error handling, and user agent.

# Interfaces

Client is an HTTP client for communicating with Upbound.
A ResponseErrorHandler handles errors in HTTP responses.

# Type aliases

A ClientModifierFn modifies an HTTP client.
A ConfigModifierFn modifies a Config.