Go API client for aerostack

Aerostack Platform API - Unified access to database, authentication, caching, queues, storage, and AI services.

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.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://aerostack.ai/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 aerostack "github.com/GIT_USER_ID/GIT_REPO_ID"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.aerostack.dev/v1

Class	Method	HTTP request	Description
AIAPI	AiChat	Post /ai/chat	Generate AI chat completion
AIAPI	Configure	Post /ai/search/configure	Update search configuration
AIAPI	Delete	Post /ai/search/delete	Delete item by ID
AIAPI	DeleteByType	Post /ai/search/deleteByType	Delete all items of a type
AIAPI	Ingest	Post /ai/search/ingest	Ingest content into managed search index
AIAPI	ListTypes	Get /ai/search/listTypes	List distinct types and counts
AIAPI	Query	Post /ai/search/query	Search managed index
AuthenticationAPI	AuthSignin	Post /auth/signin	Sign in user
AuthenticationAPI	AuthSignup	Post /auth/signup	Sign up new user
CacheAPI	CacheGet	Post /cache/get	Get cached value
CacheAPI	CacheSet	Post /cache/set	Set cached value
DatabaseAPI	DbQuery	Post /db/query	Execute SQL query
GatewayAPI	GatewayBillingLog	Post /gateway/billing/log	Log Gateway usage
QueueAPI	QueueEnqueue	Post /queue/enqueue	Add job to queue
ServicesAPI	ServicesInvoke	Post /services/invoke	Invoke another service
StorageAPI	StorageUpload	Post /storage/upload	Upload file to storage

Documentation For Models

• AiChat200Response
• AiChatRequest
• AiChatRequestMessagesInner
• AuthResponse
• AuthSigninRequest
• AuthSignupRequest
• CacheGet200Response
• CacheGetRequest
• CacheSet200Response
• CacheSetRequest
• ConfigureRequest
• DbQueryRequest
• DbQueryResult
• DeleteByTypeRequest
• DeleteRequest
• ErrorResponse
• GatewayBillingLog200Response
• GatewayBillingLogRequest
• IngestRequest
• ListTypes200Response
• Query200Response
• QueryRequest
• QueueEnqueue201Response
• QueueEnqueueRequest
• SearchResult
• ServicesInvoke200Response
• ServicesInvokeRequest
• StorageUpload200Response
• TypeStats
• User

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Aerostack-Key
• Location: HTTP header

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

Example

auth := context.WithValue(
		context.Background(),
		aerostack.ContextAPIKeys,
		map[string]aerostack.APIKey{
			"X-Aerostack-Key": {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