Go to file
2024-09-04 20:49:07 +02:00
.idea feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
.openapi-generator feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
api feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
docs feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
.gitignore migration from old git (no git history) 2024-07-20 19:18:49 +02:00
.openapi-generator-ignore migration from old git (no git history) 2024-07-20 19:18:49 +02:00
.travis.yml migration from old git (no git history) 2024-07-20 19:18:49 +02:00
api_user_message.go feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
api_user_source.go feat(version): updated for latest release of the Orchestrator 2024-09-01 19:15:48 +02:00
api_user.go feat(version): updated for latest release of the OOrchestrator 2024-09-01 18:50:40 +02:00
client.go feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
configuration.go feat(version): updated for latest release of the OOrchestrator 2024-09-01 18:50:40 +02:00
git_push.sh migration from old git (no git history) 2024-07-20 19:18:49 +02:00
go.mod feat(version): updated gomod 2024-09-01 19:16:10 +02:00
go.sum feat(version): updated gomod 2024-09-01 19:16:10 +02:00
model_task_message.go feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
model_task_response.go feat(version): updated for latest release of the Orchestrator 2024-09-01 19:15:48 +02:00
model_task_start_task.go feat(version): updated for latest release of the Orchestrator 2024-09-01 19:15:48 +02:00
README.md feat(version): update to orchestrator version v1.1.0 2024-09-04 20:49:07 +02:00
response.go feat(version): updated for latest release of the OOrchestrator 2024-09-01 18:50:40 +02:00
utils.go feat(version): updated for latest release of the OOrchestrator 2024-09-01 18:50:40 +02:00

Go API client for openapi

This service handles the communication between the manager and the plugs

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

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "git.anthrove.art/Anthrove/orchestrator-swagger-go-client"

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(), openapi.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(), 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 sw.ContextOperationServerIndices and sw.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 /api/v1

Class Method HTTP request Description
UserApi UserTaskPost Post /user/task Start scraping all user sources
UserApi UserTaskUserIdGet Get /user/task/{user_id} Gets all tasks of a user
UserMessageApi PlugMessagesPlugIdentifierUserSourceIdGet Get /plug/messages/{plug_identifier}/{user_source_id} Get all Messages from a user
UserSourceApi PlugTaskPlugIdentifierPost Post /plug/task/{plug_identifier} Start a plug task
UserSourceApi PlugTaskPlugIdentifierTaskIdDelete Delete /plug/task/{plug_identifier}/{task_id} Stop a plug task
UserSourceApi PlugTaskPlugIdentifierTaskIdGet Get /plug/task/{plug_identifier}/{task_id} Gets the status of a plug task

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

Author

support@anthrove.art