# README

Go API client for iwfidl

This APIs for iwf SDKs to operate workflows

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: 1.0.0
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 iwfidl "github.com/indeedeng/iwf-idl"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
DefaultApi	ApiV1WorkflowConfigUpdatePost	Post /api/v1/workflow/config/update	update the config of a workflow
DefaultApi	ApiV1WorkflowDataobjectsGetPost	Post /api/v1/workflow/dataobjects/get	get workflow data objects
DefaultApi	ApiV1WorkflowGetPost	Post /api/v1/workflow/get	get a workflow's status and results(if completed & requested)
DefaultApi	ApiV1WorkflowGetWithWaitPost	Post /api/v1/workflow/getWithWait	get a workflow's status and results(if completed & requested), wait if the workflow is still running
DefaultApi	ApiV1WorkflowInternalDumpPost	Post /api/v1/workflow/internal/dump	dump internal info of a workflow
DefaultApi	ApiV1WorkflowResetPost	Post /api/v1/workflow/reset	reset a workflow
DefaultApi	ApiV1WorkflowRpcPost	Post /api/v1/workflow/rpc	execute an RPC of a workflow
DefaultApi	ApiV1WorkflowSearchPost	Post /api/v1/workflow/search	search for workflows by a search attribute query
DefaultApi	ApiV1WorkflowSearchattributesGetPost	Post /api/v1/workflow/searchattributes/get	get workflow search attributes
DefaultApi	ApiV1WorkflowSignalPost	Post /api/v1/workflow/signal	signal a workflow
DefaultApi	ApiV1WorkflowStartPost	Post /api/v1/workflow/start	start a workflow
DefaultApi	ApiV1WorkflowStateDecidePost	Post /api/v1/workflowState/decide	for invoking WorkflowState.execute API
DefaultApi	ApiV1WorkflowStateStartPost	Post /api/v1/workflowState/start	for invoking WorkflowState.waitUntil API
DefaultApi	ApiV1WorkflowStopPost	Post /api/v1/workflow/stop	stop a workflow
DefaultApi	ApiV1WorkflowTimerSkipPost	Post /api/v1/workflow/timer/skip	skip the timer of a workflow
DefaultApi	ApiV1WorkflowTriggerContinueAsNewPost	Post /api/v1/workflow/triggerContinueAsNew	trigger ContinueAsNew for a workflow
DefaultApi	ApiV1WorkflowWaitForStateCompletionPost	Post /api/v1/workflow/waitForStateCompletion
DefaultApi	ApiV1WorkflowWorkerRpcPost	Post /api/v1/workflowWorker/rpc	for invoking workflow RPC API in the worker
DefaultApi	InfoHealthcheckGet	Get /info/healthcheck	return health info of the server

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