Go to file
2024-07-20 19:24:05 +02:00
.idea migration from old git (no git history) 2024-07-20 19:18:49 +02:00
.openapi-generator migration from old git (no git history) 2024-07-20 19:18:49 +02:00
api migration from old git (no git history) 2024-07-20 19:18:49 +02:00
docs fix: changed mod paths to correct url 2024-07-20 19:24:05 +02:00
test fix: changed mod paths to correct url 2024-07-20 19:24:05 +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_plug.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
api_user.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
client.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
configuration.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
git_push.sh migration from old git (no git history) 2024-07-20 19:18:49 +02:00
go.mod fix: changed mod paths to correct url 2024-07-20 19:24:05 +02:00
go.sum migration from old git (no git history) 2024-07-20 19:18:49 +02:00
model_models_orchestrator_task.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
model_models_plug_task_state.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
model_models_plug_task.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
README.md fix: changed mod paths to correct url 2024-07-20 19:24:05 +02:00
response.go migration from old git (no git history) 2024-07-20 19:18:49 +02:00
utils.go migration from old git (no git history) 2024-07-20 19:18:49 +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: 0.1-PREVIEW
  • 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/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 openapi.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 openapi.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 openapi.ContextOperationServerIndices and openapi.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
PlugAPI PlugPlugTypePut Put /plug/{plug_type} Initiates a scraping operation for a user with a specific plug type
PlugAPI PlugPlugTypeTaskIdDelete Delete /plug/{plug_type}/{task_id} Stops a scraping operation for a user with a specific plug type
PlugAPI PlugPlugTypeTaskIdGet Get /plug/{plug_type}/{task_id} Retrieves the status of a specific task type
UserAPI UserUserIdPut Put /user/{user_id} Initiates a scraping operation for the entire user

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