Skip to content

Latest commit

 

History

History
494 lines (450 loc) · 28.3 KB

README.md

File metadata and controls

494 lines (450 loc) · 28.3 KB
Raw

Go API client for storage

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: 2006-03-01
  • Package version: 1.1
  • 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 storage "github.com/hamidfzm/arvancloud-go/storage"

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(), storage.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(), storage.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(), storage.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), storage.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://s3.ir-thr-at1.arvanstorage.com

Class Method HTTP request Description
BucketAPI CreateBucket Put /{Bucket}
BucketAPI DeleteBucket Delete /{Bucket}
BucketAPI DeleteObjects Post /{Bucket}#delete
BucketAPI DeletePublicAccessBlock Delete /{Bucket}#publicAccessBlock
BucketAPI GetPublicAccessBlock Get /{Bucket}#publicAccessBlock
BucketAPI HeadBucket Head /{Bucket}
BucketAPI ListBuckets Get /{Bucket}
BucketAPI ListObjectVersions Get /{Bucket}#versions
BucketAPI ListObjects Get /{Bucket}#Listobjects
BucketAPI ListObjectsV2 Get /{Bucket}#list-type=2
BucketAPI PutPublicAccessBlock Put /{Bucket}#publicAccessBlock
BucketACLAPI GetBucketAcl Get /{Bucket}#acl
BucketACLAPI PutBucketAcl Put /{Bucket}#acl
BucketCORSAPI DeleteBucketCors Delete /{Bucket}#cors
BucketCORSAPI GetBucketCors Get /{Bucket}#cors
BucketCORSAPI PutBucketCors Put /{Bucket}#cors
BucketLifecycleConfigurationAPI DeleteBucketLifecycle Delete /{Bucket}#lifecycle
BucketLifecycleConfigurationAPI GetBucketLifecycleConfiguration Get /{Bucket}#lifecycle
BucketLifecycleConfigurationAPI PutBucketLifecycleConfiguration Put /{Bucket}#lifecycle
BucketPolicyAPI DeleteBucketPolicy Delete /{Bucket}#policy
BucketPolicyAPI GetBucketPolicy Get /{Bucket}#policy
BucketPolicyAPI GetBucketPolicyStatus Get /{Bucket}#policyStatus
BucketPolicyAPI PutBucketPolicy Put /{Bucket}#policy
BucketTaggingAPI DeleteBucketTagging Delete /{Bucket}#tagging
BucketTaggingAPI GetBucketTagging Get /{Bucket}#tagging
BucketTaggingAPI PutBucketTagging Put /{Bucket}#tagging
BucketVersioningAPI GetBucketVersioning Get /{Bucket}#versioning
BucketVersioningAPI PutBucketVersioning Put /{Bucket}#versioning
BucketWebsiteConfigurationAPI DeleteBucketWebsite Delete /{Bucket}#website
BucketWebsiteConfigurationAPI GetBucketWebsite Get /{Bucket}#website
BucketWebsiteConfigurationAPI PutBucketWebsite Put /{Bucket}#website
MultipartAPI AbortMultipartUpload Delete /{Bucket}/{Key}#uploadId
MultipartAPI CompleteMultipartUpload Post /{Bucket}/{Key}#uploadId
MultipartAPI CreateMultipartUpload Post /{Bucket}/{Key}#uploads
MultipartAPI ListMultipartUploads Get /{Bucket}#uploads
MultipartAPI ListParts Get /{Bucket}/{Key}#uploadId
MultipartAPI UploadPart Put /{Bucket}/{Key}#partNumber&uploadId
ObjectAPI DeleteObject Delete /{Bucket}/{Key}
ObjectAPI GetObject Get /{Bucket}/{Key}
ObjectAPI HeadObject Head /{Bucket}/{Key}
ObjectAPI PutObject Put /{Bucket}/{Key}
ObjectACLAPI GetObjectAcl Get /{Bucket}/{Key}#acl
ObjectACLAPI PutObjectAcl Put /{Bucket}/{Key}#acl
ObjectTaggingAPI DeleteObjectTagging Delete /{Bucket}/{Key}#tagging
ObjectTaggingAPI GetObjectTagging Get /{Bucket}/{Key}#tagging
ObjectTaggingAPI PutObjectTagging Put /{Bucket}/{Key}#tagging

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

hmac

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

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

Example

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