Go API client for filemagego

FileMage Gateway provides a simple API to configure storage endpoints, users, and keys. Please note that all urls must end in a trailing slash, and the Content-Type header must be set to application/json.

Authentication

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.12.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

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 filemagego "github.com/elgranjero/filemagego"

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 filemagego.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), filemagego.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value filemagego.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), filemagego.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 filemagego.ContextOperationServerIndices and filemagego.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), filemagego.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), filemagego.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://sftp.example.com

Class	Method	HTTP request	Description
AuditAPI	ListLogs	Get /logs/	Get audit log entries
EndpointsAPI	CreateEndpoint	Post /endpoints/	Create endpoint
EndpointsAPI	DeleteEndpoint	Delete /endpoints/{id}/	Delete endpoint
EndpointsAPI	GetEndpoint	Get /endpoints/{id}/	Get endpoint
EndpointsAPI	ListEndpoints	Get /endpoints/	List endpoints
EndpointsAPI	UpdateEndpoint	Put /endpoints/{id}/	Update endpoint
GroupsAPI	CreateGroup	Post /groups/	Create group
GroupsAPI	DeleteGroup	Delete /groups/{id}/	Delete group
GroupsAPI	GetGroup	Get /groups/{id}/	Get group
GroupsAPI	ListGroups	Get /groups/	List groups
GroupsAPI	UpdateGroup	Put /groups/{id}/	Update group
KeysAPI	CreateKey	Post /users/{userId}/keys/	Add key
KeysAPI	DeleteKey	Delete /users/{userId}/keys/{keyId}/	Delete key
PermissionsAPI	DetailPermissions	Get /permissions/query/	Folder permission detail
PermissionsAPI	ViewPermissions	Get /permissions/	Folder permissions overview
UsersAPI	CreatUser	Post /users/	Create user
UsersAPI	DeleteUser	Delete /users/{id}/	Delete user
UsersAPI	GetUser	Get /users/{id}/	Get user
UsersAPI	ListUsers	Get /users/	List users
UsersAPI	UpdateUser	Put /users/{id}/	Update user

Documentation For Models

• AuditLog
• BlobEndpoint
• BlobEndpointConfig
• CreateEndpointRequest
• EndpointCreated
• EndpointInfo
• Error
• GCSEndpoint
• GCSEndpointConfig
• Group
• GroupCreated
• GroupInfo
• Key
• KeyInfo
• Permission
• PermissionDetail
• PermissionOverview
• S3Endpoint
• S3EndpointConfig
• User
• UserDetail
• UserHome
• UserId
• UserInfo

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: filemage-api-token
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: filemage-api-token and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		filemagego.ContextAPIKeys,
		map[string]filemagego.APIKey{
			"filemage-api-token": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

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