Go SDK for Flowpipe

Flowpipe is a low-code workflow automation tool that aims to be simple yet powerful.

For help on getting started with Flowpipe, please visit https://flowpipe.io

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.1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit http://www.flowpipe.io

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 flowpipeapi "github.com/turbot/flowpipe-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 sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), flowpipeapi.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(), flowpipeapi.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(), flowpipeapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), flowpipeapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v0

Class	Method	HTTP request	Description
IntegrationApi	Get	Get /integration/{integration_name}	Get integration
IntegrationApi	List	Get /integration	List integrations
ModApi	Get	Get /mod/{mod_name}	Get mod
NotifierApi	Get	Get /notifier/{notifier_name}	Get notifier
NotifierApi	List	Get /notifier	List notifiers
PipelineApi	Command	Post /pipeline/{pipeline_name}/command	Execute a pipeline command
PipelineApi	Get	Get /pipeline/{pipeline_name}	Get pipeline
PipelineApi	List	Get /pipeline	List pipelines
ProcessApi	Get	Get /process/{process_id}	Get process
ProcessApi	GetExecution	Get /process/{process_id}/execution	Get process execution
ProcessApi	GetLog	Get /process/{process_id}/log/process.json	Get process log
ProcessApi	List	Get /process	List processs
TriggerApi	Command	Post /trigger/{trigger_name}/command	Execute a trigger command
TriggerApi	Get	Get /trigger/{trigger_name}	Get trigger
TriggerApi	List	Get /trigger	List triggers
VariableApi	Get	Get /variable/{variable_name}	Get variable
VariableApi	List	Get /variable	List variables

Documentation For Models

• CmdPipeline
• CmdTrigger
• EventEventLogImpl
• ExecutionExecution
• ExecutionPipelineExecution
• ExecutionStepExecution
• ExecutionStepExecutionOutput
• ExecutionStepExecutionStepForEach
• ExecutionStepStatus
• FlowpipeRequire
• FlowpipeResponseMetadata
• FlowpipeTriggerResponseMetadata
• FpIntegration
• FpNotifier
• FpNotify
• FpPipeline
• FpPipelineParam
• FpTrigger
• FpTriggerPipeline
• FpVariable
• HclPos
• HclRange
• HclRangeStart
• ListIntegrationResponse
• ListNotifierResponse
• ListPipelineResponse
• ListProcessLogJSONResponse
• ListProcessResponse
• ListTriggerResponse
• ListVariableResponse
• Mod
• ModVersionConstraint
• ModconfigNextStepAction
• ModconfigOutput
• ModconfigPipelineOutput
• ModconfigStepError
• ModconfigStepForEach
• ModconfigStepLoop
• ModconfigStepRetry
• OpenGraph
• PerrErrorDetailModel
• PerrErrorModel
• PipelineExecutionResponse
• Process
• Require
• TriggerExecutionResponse

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

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

[email protected]