2024-07-20 17:18:49 +00: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 ](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.
2024-09-01 16:50:40 +00:00
- API version: 1.0
2024-07-20 17:18:49 +00:00
- 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:
2024-09-01 16:50:40 +00:00
```shell
2024-07-20 17:18:49 +00:00
go get github.com/stretchr/testify/assert
2024-09-01 16:50:40 +00:00
go get golang.org/x/oauth2
2024-07-20 17:18:49 +00:00
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
2024-09-01 16:50:40 +00:00
```golang
2024-09-01 17:09:40 +00:00
import openapi "git.anthrove.art/Anthrove/orchestrator-swagger-go-client"
2024-07-20 17:18:49 +00:00
```
To use a proxy, set the environment variable `HTTP_PROXY` :
2024-09-01 16:50:40 +00:00
```golang
2024-07-20 17:18:49 +00:00
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
2024-09-01 16:50:40 +00:00
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int` .
2024-07-20 17:18:49 +00:00
2024-09-01 16:50:40 +00:00
```golang
2024-07-20 17:18:49 +00:00
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
```
### Templated Server URL
2024-09-01 16:50:40 +00:00
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string` .
2024-07-20 17:18:49 +00:00
2024-09-01 16:50:40 +00:00
```golang
2024-07-20 17:18:49 +00:00
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.
2024-09-01 16:50:40 +00:00
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
2024-07-20 17:18:49 +00:00
2024-09-01 16:50:40 +00:00
```golang
2024-07-20 17:18:49 +00:00
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
------------ | ------------- | ------------- | -------------
2024-09-01 16:50:40 +00:00
*UserApi* | [**UserTaskPost** ](docs/UserApi.md#usertaskpost ) | **Post** /user/task | Start scraping all user sources
*UserApi* | [**UserTaskUserIdGet** ](docs/UserApi.md#usertaskuseridget ) | **Get** /user/task/{user_id} | Gets all tasks of a user
*UserSourceApi* | [**PlugTaskPlugIdentifierPost** ](docs/UserSourceApi.md#plugtaskplugidentifierpost ) | **Post** /plug/task/{plug_identifier} | Start a plug task
*UserSourceApi* | [**PlugTaskPlugIdentifierTaskIdDelete** ](docs/UserSourceApi.md#plugtaskplugidentifiertaskiddelete ) | **Delete** /plug/task/{plug_identifier}/{task_id} | Stop a plug task
*UserSourceApi* | [**PlugTaskPlugIdentifierTaskIdGet** ](docs/UserSourceApi.md#plugtaskplugidentifiertaskidget ) | **Get** /plug/task/{plug_identifier}/{task_id} | Gets the status of a plug task
2024-07-20 17:18:49 +00:00
## Documentation For Models
2024-09-01 16:50:40 +00:00
- [TaskResponse ](docs/TaskResponse.md )
- [TaskStartTask ](docs/TaskStartTask.md )
2024-07-20 17:18:49 +00:00
## Documentation For Authorization
2024-09-01 16:50:40 +00:00
Endpoints do not require authorization.
2024-07-20 17:18:49 +00:00
## 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