{"id":18995578,"url":"https://github.com/turbot/flowpipe-sdk-go","last_synced_at":"2025-09-09T08:48:36.614Z","repository":{"id":212258142,"uuid":"646706605","full_name":"turbot/flowpipe-sdk-go","owner":"turbot","description":"Flowpipe SDK for Go. Query APIs exposed by the Flowpipe CLI while running in server mode.","archived":false,"fork":false,"pushed_at":"2024-10-21T12:42:39.000Z","size":331,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2025-07-07T22:16:29.300Z","etag":null,"topics":["flowpipe","golang","hacktoberfest","openapi","sdk"],"latest_commit_sha":null,"homepage":"https://flowpipe.io","language":"Mustache","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/turbot.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-29T06:46:52.000Z","updated_at":"2024-10-21T12:42:44.000Z","dependencies_parsed_at":"2024-05-31T01:44:15.435Z","dependency_job_id":"9b49d8d3-3413-4259-ba35-b9b7ff8aa092","html_url":"https://github.com/turbot/flowpipe-sdk-go","commit_stats":null,"previous_names":["turbot/flowpipe-sdk-go"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/turbot/flowpipe-sdk-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turbot%2Fflowpipe-sdk-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turbot%2Fflowpipe-sdk-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turbot%2Fflowpipe-sdk-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turbot%2Fflowpipe-sdk-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/turbot","download_url":"https://codeload.github.com/turbot/flowpipe-sdk-go/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/turbot%2Fflowpipe-sdk-go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274268373,"owners_count":25253390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flowpipe","golang","hacktoberfest","openapi","sdk"],"created_at":"2024-11-08T17:31:47.398Z","updated_at":"2025-09-09T08:48:36.591Z","avatar_url":"https://github.com/turbot.png","language":"Mustache","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Go SDK for Flowpipe\n\nFlowpipe is a low-code workflow automation tool that aims to be simple yet powerful.\n\nFor help on getting started with Flowpipe, please visit https://flowpipe.io\n\n## Overview\nThis API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.\n\n- API version: 0.1.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.GoClientCodegen\nFor more information, please visit [http://www.flowpipe.io](http://www.flowpipe.io)\n\n## Installation\n\nInstall the following dependencies:\n\n```shell\ngo get github.com/stretchr/testify/assert\ngo get golang.org/x/net/context\n```\n\nPut the package under your project folder and add the following in import:\n\n```golang\nimport flowpipeapi \"github.com/turbot/flowpipe-sdk-go\"\n```\n\nTo use a proxy, set the environment variable `HTTP_PROXY`:\n\n```golang\nos.Setenv(\"HTTP_PROXY\", \"http://proxy_name:proxy_port\")\n```\n\n## Configuration of Server URL\n\nDefault configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.\n\n### Select Server Configuration\n\nFor using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.\n\n```golang\nctx := context.WithValue(context.Background(), flowpipeapi.ContextServerIndex, 1)\n```\n\n### Templated Server URL\n\nTemplated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.\n\n```golang\nctx := context.WithValue(context.Background(), flowpipeapi.ContextServerVariables, map[string]string{\n\t\"basePath\": \"v2\",\n})\n```\n\nNote, enum values are always validated and all unused variables are silently ignored.\n\n### URLs Configuration per Operation\n\nEach operation can use different server URL defined using `OperationServers` map in the `Configuration`.\nAn operation is uniquely identified by `\"{classname}Service.{nickname}\"` string.\nSimilar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.\n\n```golang\nctx := context.WithValue(context.Background(), flowpipeapi.ContextOperationServerIndices, map[string]int{\n\t\"{classname}Service.{nickname}\": 2,\n})\nctx = context.WithValue(context.Background(), flowpipeapi.ContextOperationServerVariables, map[string]map[string]string{\n\t\"{classname}Service.{nickname}\": {\n\t\t\"port\": \"8443\",\n\t},\n})\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://localhost/api/v0*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*IntegrationApi* | [**Get**](docs/IntegrationApi.md#get) | **Get** /integration/{integration_name} | Get integration\n*IntegrationApi* | [**List**](docs/IntegrationApi.md#list) | **Get** /integration | List integrations\n*ModApi* | [**Get**](docs/ModApi.md#get) | **Get** /mod/{mod_name} | Get mod\n*NotifierApi* | [**Get**](docs/NotifierApi.md#get) | **Get** /notifier/{notifier_name} | Get notifier\n*NotifierApi* | [**List**](docs/NotifierApi.md#list) | **Get** /notifier | List notifiers\n*PipelineApi* | [**Command**](docs/PipelineApi.md#command) | **Post** /pipeline/{pipeline_name}/command | Execute a pipeline command\n*PipelineApi* | [**Get**](docs/PipelineApi.md#get) | **Get** /pipeline/{pipeline_name} | Get pipeline\n*PipelineApi* | [**List**](docs/PipelineApi.md#list) | **Get** /pipeline | List pipelines\n*ProcessApi* | [**Get**](docs/ProcessApi.md#get) | **Get** /process/{process_id} | Get process\n*ProcessApi* | [**GetExecution**](docs/ProcessApi.md#getexecution) | **Get** /process/{process_id}/execution | Get process execution\n*ProcessApi* | [**GetLog**](docs/ProcessApi.md#getlog) | **Get** /process/{process_id}/log/process.json | Get process log\n*ProcessApi* | [**List**](docs/ProcessApi.md#list) | **Get** /process | List processs\n*TriggerApi* | [**Command**](docs/TriggerApi.md#command) | **Post** /trigger/{trigger_name}/command | Execute a trigger command\n*TriggerApi* | [**Get**](docs/TriggerApi.md#get) | **Get** /trigger/{trigger_name} | Get trigger\n*TriggerApi* | [**List**](docs/TriggerApi.md#list) | **Get** /trigger | List triggers\n*VariableApi* | [**Get**](docs/VariableApi.md#get) | **Get** /variable/{variable_name} | Get variable\n*VariableApi* | [**List**](docs/VariableApi.md#list) | **Get** /variable | List variables\n\n\n## Documentation For Models\n\n - [CmdPipeline](docs/CmdPipeline.md)\n - [CmdTrigger](docs/CmdTrigger.md)\n - [EventEventLogImpl](docs/EventEventLogImpl.md)\n - [ExecutionExecution](docs/ExecutionExecution.md)\n - [ExecutionPipelineExecution](docs/ExecutionPipelineExecution.md)\n - [ExecutionStepExecution](docs/ExecutionStepExecution.md)\n - [ExecutionStepExecutionOutput](docs/ExecutionStepExecutionOutput.md)\n - [ExecutionStepExecutionStepForEach](docs/ExecutionStepExecutionStepForEach.md)\n - [ExecutionStepStatus](docs/ExecutionStepStatus.md)\n - [FlowpipeRequire](docs/FlowpipeRequire.md)\n - [FlowpipeResponseMetadata](docs/FlowpipeResponseMetadata.md)\n - [FlowpipeTriggerResponseMetadata](docs/FlowpipeTriggerResponseMetadata.md)\n - [FpIntegration](docs/FpIntegration.md)\n - [FpNotifier](docs/FpNotifier.md)\n - [FpNotify](docs/FpNotify.md)\n - [FpPipeline](docs/FpPipeline.md)\n - [FpPipelineParam](docs/FpPipelineParam.md)\n - [FpTrigger](docs/FpTrigger.md)\n - [FpTriggerPipeline](docs/FpTriggerPipeline.md)\n - [FpVariable](docs/FpVariable.md)\n - [HclPos](docs/HclPos.md)\n - [HclRange](docs/HclRange.md)\n - [HclRangeStart](docs/HclRangeStart.md)\n - [ListIntegrationResponse](docs/ListIntegrationResponse.md)\n - [ListNotifierResponse](docs/ListNotifierResponse.md)\n - [ListPipelineResponse](docs/ListPipelineResponse.md)\n - [ListProcessLogJSONResponse](docs/ListProcessLogJSONResponse.md)\n - [ListProcessResponse](docs/ListProcessResponse.md)\n - [ListTriggerResponse](docs/ListTriggerResponse.md)\n - [ListVariableResponse](docs/ListVariableResponse.md)\n - [Mod](docs/Mod.md)\n - [ModVersionConstraint](docs/ModVersionConstraint.md)\n - [ModconfigNextStepAction](docs/ModconfigNextStepAction.md)\n - [ModconfigOutput](docs/ModconfigOutput.md)\n - [ModconfigPipelineOutput](docs/ModconfigPipelineOutput.md)\n - [ModconfigStepError](docs/ModconfigStepError.md)\n - [ModconfigStepForEach](docs/ModconfigStepForEach.md)\n - [ModconfigStepLoop](docs/ModconfigStepLoop.md)\n - [ModconfigStepRetry](docs/ModconfigStepRetry.md)\n - [OpenGraph](docs/OpenGraph.md)\n - [PerrErrorDetailModel](docs/PerrErrorDetailModel.md)\n - [PerrErrorModel](docs/PerrErrorModel.md)\n - [PipelineExecutionResponse](docs/PipelineExecutionResponse.md)\n - [Process](docs/Process.md)\n - [Require](docs/Require.md)\n - [TriggerExecutionResponse](docs/TriggerExecutionResponse.md)\n\n\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\nNote, 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.\n\n\n## Documentation for Utility Methods\n\nDue to the fact that model structure members are all pointers, this package contains\na number of utility functions to easily obtain pointers to values of basic types.\nEach of these functions takes a value of the given basic type and returns a pointer to it:\n\n* `PtrBool`\n* `PtrInt`\n* `PtrInt32`\n* `PtrInt64`\n* `PtrFloat`\n* `PtrFloat32`\n* `PtrFloat64`\n* `PtrString`\n* `PtrTime`\n\n## Author\n\ninfo@flowpipe.io\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturbot%2Fflowpipe-sdk-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fturbot%2Fflowpipe-sdk-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturbot%2Fflowpipe-sdk-go/lists"}