orchestrator-swagger-go-client/README.md

# 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](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.

- 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](http://anthrove.art/support)

## Installation

Install the following dependencies:

```sh
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:

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

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
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`.

```go
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`.

```go
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.

```go
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**](docs/PlugAPI.md#plugplugtypeput) | **Put** /plug/{plug_type} | Initiates a scraping operation for a user with a specific plug type
*PlugAPI* | [**PlugPlugTypeTaskIdDelete**](docs/PlugAPI.md#plugplugtypetaskiddelete) | **Delete** /plug/{plug_type}/{task_id} | Stops a scraping operation for a user with a specific plug type
*PlugAPI* | [**PlugPlugTypeTaskIdGet**](docs/PlugAPI.md#plugplugtypetaskidget) | **Get** /plug/{plug_type}/{task_id} | Retrieves the status of a specific task type
*UserAPI* | [**UserUserIdPut**](docs/UserAPI.md#useruseridput) | **Put** /user/{user_id} | Initiates a scraping operation for the entire user


## Documentation For Models

 - [ModelsOrchestratorTask](docs/ModelsOrchestratorTask.md)
 - [ModelsPlugTask](docs/ModelsPlugTask.md)
 - [ModelsPlugTaskState](docs/ModelsPlugTaskState.md)


## 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