# Packages

http-client

No description provided by the author

Go API client for openapi

aifs api

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

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 "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 sw.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 sw.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 sw.ContextOperationServerIndices and sw.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 https://www.example.com/api/open/v1

Class	Method	HTTP request	Description
AnnotationTemplateApi	CopyAnnotationTemplate	Post /annotation-templates/{annotationTemplateId}/copy	Copy an annotation template
AnnotationTemplateApi	CreateAnnotationTemplate	Post /annotation-templates	Create an annotation template
AnnotationTemplateApi	DeleteAnnotationTemplate	Delete /annotation-templates/{annotationTemplateId}	Delete an annotation template
AnnotationTemplateApi	GetAnnoTemplateDetails	Get /annotation-templates/{annotationTemplateId}/details	Get annotation template details
AnnotationTemplateApi	GetAnnoTemplateList	Get /annotation-templates	Get annotation template list
AnnotationTemplateApi	UpdateAnnotationTemplate	Put /annotation-templates	Update an annotation template
AnnotationTemplateTypeApi	GetAnnoTemplateTypeList	Get /annotation-template-types	Get annotation template type list
DataViewApi	CreateDataView	Post /data-views	Create a data view
DataViewApi	DeleteDataItemInDataView	Delete /data-views/{dataViewId}/data-items	Delete data item in a data view
DataViewApi	DeleteDataView	Delete /data-views/{dataViewId}	Delete a data view
DataViewApi	DivideDataView	Post /data-views/{dataViewId}/raw-data-divide	Divide data view
DataViewApi	FilterAnnotationsInDataView	Post /data-views/{dataViewId}/annotation-filter	Filter annotations in a data view
DataViewApi	GetAllAnnotationDataInDataView	Get /data-views/{dataViewId}/annotation-data	Get all annotation data in a data view
DataViewApi	GetAllAnnotationLocationsInDataView	Get /data-views/{dataViewId}/annotation-locations	Get all annotation locations in a data view
DataViewApi	GetAllRawDataLocationsInDataView	Get /data-views/{dataViewId}/raw-data-locations	Get all raw data locations in a data view
DataViewApi	GetAnnotationsInDataView	Get /data-views/{dataViewId}/annotations	Get data view annotations
DataViewApi	GetArtifactLocationsInDataView	Get /data-views/{dataViewId}/artifact-locations	Get files' locations in artifact data view
DataViewApi	GetDataViewDetails	Get /data-views/{dataViewId}/details	Get data view details
DataViewApi	GetDataViewList	Get /data-views	Get data view list
DataViewApi	GetDataViewStatistics	Get /data-views/{dataViewId}/statistics	Get data view statistics
DataViewApi	GetDatasetZipLocationInDataView	Get /data-views/{dataViewId}/dataset-zip-location	Get dataset zip's location in a data view
DataViewApi	GetModelDataLocationsInDataView	Get /data-views/{dataViewId}/model-data-locations	Get all model data locations in a data view
DataViewApi	GetRawDataHashListInDataView	Get /data-views/{dataViewId}/raw-data-hash-list	Get data view raw data hash list
DataViewApi	GetRawDataInDataView	Get /data-views/{dataViewId}/raw-data	Get data view raw data
DataViewApi	HardDeleteDataView	Delete /data-views/{dataViewId}/hard-delete	Hard delete a data view
DataViewApi	MergeDataViews	Post /data-views/merge	Merge data views
DataViewApi	MergeDataViewsToCrurrent	Post /data-views/{dataViewId}/merge	Merge data views
DataViewApi	MoveDataViewItems	Post /data-views/move	Move data items between data views
DataViewApi	UpdateDatasetZipView	Put /data-views/{dataViewId}/dataset-zip	Update a dataset-zip view meta
DataViewUploadApi	UploadAnnotationToDataView	Post /data-views/{dataViewId}/annotations	Upload annotations to data view
DataViewUploadApi	UploadDatasetZipToDataView	Post /data-views/{dataViewId}/dataset-zip	Upload dataset zip
DataViewUploadApi	UploadFileToDataView	Post /data-views/{dataViewId}/artifact	Upload file to data view
DataViewUploadApi	UploadModelDataToDataView	Post /data-views/{dataViewId}/model	Upload model data to data view
DataViewUploadApi	UploadRawDataToDataView	Post /data-views/{dataViewId}/raw-data	Upload raw data to data view

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