# Packages

test

No description provided by the author

Go API client for openapi

The API for the FunLess Platform

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.

API version: 0.5
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

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 openapi "github.com/funlessdev/fl-client-sdk-go"

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 openapi.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), openapi.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 openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AppAPI	CreateApp	Post /v1/app	Create new APP script
AppAPI	DeleteApp	Delete /v1/app/{app_name}	Delete APP
AppAPI	ListApp	Get /v1/app	List current APP scripts
AppAPI	ShowAppByName	Get /v1/app/{app_name}	Show APP info
FunctionsAPI	CreateFunction	Post /v1/fn/{module_name}	Create new function
FunctionsAPI	DeleteFunction	Delete /v1/fn/{module_name}/{function_name}	Delete function
FunctionsAPI	InvokeFunction	Post /v1/fn/{module_name}/{function_name}	Invoke function
FunctionsAPI	ShowFunctionByName	Get /v1/fn/{module_name}/{function_name}	Show function info
FunctionsAPI	UpdateFunction	Put /v1/fn/{module_name}/{function_name}	Update function
ModulesAPI	CreateModule	Post /v1/fn	Create
ModulesAPI	DeleteModule	Delete /v1/fn/{module_name}	Delete module
ModulesAPI	ListModules	Get /v1/fn	List modules
ModulesAPI	ShowModuleByName	Get /v1/fn/{module_name}	Show module info
ModulesAPI	UpdateModule	Put /v1/fn/{module_name}	Update module name
SubjectsAPI	CreateSubject	Post /v1/admin/subjects	Create subject
SubjectsAPI	ListSubjects	Get /v1/admin/subjects	List all subjects

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