Skip to content

README.md

Latest commit

 

History

History
126 lines (87 loc) · 4.77 KB

README.md

File metadata and controls

126 lines (87 loc) · 4.77 KB
Raw

Go API client for adminclient

Manage Function Stream Resources

Overview

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

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import adminclient "github.com/functionstream/functionstream/admin/client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value adminclient.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), adminclient.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value adminclient.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), adminclient.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using adminclient.ContextOperationServerIndices and adminclient.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), adminclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), adminclient.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost:7300

Class Method HTTP request Description
FunctionAPI CreateFunction Post /api/v1/function create a function
FunctionAPI DeleteFunction Delete /api/v1/function/{name} delete a function
FunctionAPI DeleteNamespacedFunction Delete /api/v1/function/{namespace}/{name} delete a namespaced function
FunctionAPI GetAllFunctions Get /api/v1/function get all functions
FunctionStoreAPI ReloadFunctions Get /api/v1/function-store/reload reload functions from the function store
HttpTubeAPI TriggerHttpTubeEndpoint Post /api/v1/http-tube/{endpoint} trigger the http tube endpoint
StateAPI GetState Get /api/v1/state/{key} get a state
StateAPI SetState Post /api/v1/state/{key} set a state
StatusAPI GetStatus Get /api/v1/status Get the status of the Function Stream
TubeAPI ConsumeMessage Get /api/v1/consume/{name} consume a message
TubeAPI ProduceMessage Post /api/v1/produce/{name} produce a message

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author