ondeviceapi

README

Go API client for swagger

OpenAPI for the gokrazy on-device API

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 1.4.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to http://gokrazy

Class	Method	HTTP request	Description
SuperviseApi	Index	Get /	Index
SuperviseApi	Status	Get /status	Status

Documentation For Models

• IndexResult
• Service

Documentation For Authorization

Endpoints do not require authorization.

Author

michael+gokrazy@stapelberg.ch

Documentation

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
• type APIKey
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type BasicAuth
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
• type GenericSwaggerError
  • func (e GenericSwaggerError) Body() []byte
  • func (e GenericSwaggerError) Error() string
  • func (e GenericSwaggerError) Model() interface{}
• type IndexResult
• type Service
• type SuperviseApiService
  • func (a *SuperviseApiService) Index(ctx context.Context) (IndexResult, *http.Response, error)
  • func (a *SuperviseApiService) Status(ctx context.Context, path string) (Service, *http.Response, error)

Variables

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	SuperviseApi *SuperviseApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the gokrazy on-device API API v1.4.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type IndexResult

type IndexResult struct {
	// The Linux kernel version
	Kernel string `json:"Kernel,omitempty"`
	// Model name of the machine on which gokrazy is running
	Model string `json:"Model,omitempty"`
	// running services
	Services []Service `json:"Services,omitempty"`
}

index of what is supervised

type Service

type Service struct {
	// Path to the service program
	Path string `json:"Path,omitempty"`
	// Command-line arguments with which to start the service
	Args []string `json:"Args,omitempty"`
	// TODO
	Diverted string `json:"Diverted,omitempty"`
	// Whether the service is stopped (gokrazy will not attempt to start it) or supervised
	Stopped bool `json:"Stopped,omitempty"`
	// TODO
	StartTime string `json:"StartTime,omitempty"`
}

type SuperviseApiService

type SuperviseApiService service

func (*SuperviseApiService) Index

func (a *SuperviseApiService) Index(ctx context.Context) (IndexResult, *http.Response, error)

SuperviseApiService Index TODO: description

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return IndexResult

func (*SuperviseApiService) Status

func (a *SuperviseApiService) Status(ctx context.Context, path string) (Service, *http.Response, error)

SuperviseApiService Status TODO: description

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param path path to the service

@return Service