Go API client for xcapi

This APIs between xCherry service and SDKs

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.0.1
• 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 xcapi "github.com/xcherryio/apis"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultAPI	ApiV1XcherryServiceProcessExecutionDescribePost	Post /api/v1/xcherry/service/process-execution/describe	describe a process execution
DefaultAPI	ApiV1XcherryServiceProcessExecutionPublishToLocalQueuePost	Post /api/v1/xcherry/service/process-execution/publish-to-local-queue	send message(s) to be consumed within a single process execution
DefaultAPI	ApiV1XcherryServiceProcessExecutionRpcPost	Post /api/v1/xcherry/service/process-execution/rpc	execute a RPC method of a process execution
DefaultAPI	ApiV1XcherryServiceProcessExecutionStartPost	Post /api/v1/xcherry/service/process-execution/start	start a process execution
DefaultAPI	ApiV1XcherryServiceProcessExecutionStopPost	Post /api/v1/xcherry/service/process-execution/stop	stop a process execution
DefaultAPI	ApiV1XcherryWorkerAsyncStateExecutePost	Post /api/v1/xcherry/worker/async-state/execute	invoking AsyncState.execute API
DefaultAPI	ApiV1XcherryWorkerAsyncStateWaitUntilPost	Post /api/v1/xcherry/worker/async-state/wait-until	invoking AsyncState.waitUntil API
DefaultAPI	ApiV1XcherryWorkerProcessRpcPost	Post /api/v1/xcherry/worker/process/rpc	execute a RPC method of a process execution in the worker
DefaultAPI	InternalApiV1XcherryNotifyImmediateTasksPost	Post /internal/api/v1/xcherry/notify-immediate-tasks	for api service to tell async service that there are new immediate tasks added to the queue
DefaultAPI	InternalApiV1XcherryNotifyTimerTasksPost	Post /internal/api/v1/xcherry/notify-timer-tasks	for api service to tell async service that there are new timer tasks added to the queue

Documentation For Models

• ApiErrorResponse
• AsyncStateConfig
• AsyncStateExecuteRequest
• AsyncStateExecuteResponse
• AsyncStateWaitUntilRequest
• AsyncStateWaitUntilResponse
• AttributeWriteConflictMode
• CommandRequest
• CommandResults
• CommandStatus
• CommandWaitingType
• Context
• EncodedObject
• GlobalAttributeConfig
• GlobalAttributeTableConfig
• GlobalAttributeTableRowUpdate
• KeyValue
• LoadGlobalAttributeResponse
• LoadGlobalAttributesRequest
• LoadLocalAttributesRequest
• LoadLocalAttributesResponse
• LocalAttributeConfig
• LocalQueueCommand
• LocalQueueMessage
• LocalQueueMessageResult
• LocalQueueResult
• NotifyImmediateTasksRequest
• NotifyTimerTasksRequest
• ProcessExecutionDescribeRequest
• ProcessExecutionDescribeResponse
• ProcessExecutionRpcRequest
• ProcessExecutionRpcResponse
• ProcessExecutionStartRequest
• ProcessExecutionStartResponse
• ProcessExecutionStopRequest
• ProcessExecutionStopType
• ProcessIdReusePolicy
• ProcessRpcWorkerRequest
• ProcessRpcWorkerResponse
• ProcessStartConfig
• ProcessStatus
• PublishToLocalQueueRequest
• RetryPolicy
• StateApiType
• StateDecision
• StateFailureRecoveryOptions
• StateFailureRecoveryPolicy
• StateMovement
• TableColumnDef
• TableColumnValue
• TableReadLockingPolicy
• TableReadRequest
• TableReadResponse
• ThreadCloseDecision
• ThreadCloseType
• TimerCommand
• TimerResult
• WorkerErrorResponse

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