# README

Go API client for api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: 2.5.0
Package version: 2.4.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://storageos.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./api"

Documentation for API Endpoints

All URIs are relative to http://localhost/v2

Class	Method	HTTP request	Description
DefaultApi	AttachNFSVolume	Post /namespaces/{namespaceID}/volumes/{id}/nfs/attach	attach and share the volume using NFS
DefaultApi	AttachVolume	Post /namespaces/{namespaceID}/volumes/{id}/attach	Attach a volume to the given node
DefaultApi	AuthenticateUser	Post /auth/login	Authenticate a user
DefaultApi	CreateNamespace	Post /namespaces	Create a new namespace
DefaultApi	CreatePolicyGroup	Post /policies	Create a new policy group
DefaultApi	CreateUser	Post /users	Create a new user
DefaultApi	CreateVolume	Post /namespaces/{namespaceID}/volumes	Create a new Volume in the specified namespace
DefaultApi	DeleteAuthenticatedUser	Delete /users/self	Delete the authenticated user
DefaultApi	DeleteAuthenticatedUserSessions	Delete /users/self/sessions	Invalidate the logged in user's sessions
DefaultApi	DeleteNamespace	Delete /namespaces/{id}	Delete a namespace
DefaultApi	DeleteNode	Delete /nodes/{id}	Delete a node
DefaultApi	DeletePolicyGroup	Delete /policies/{id}	Delete a policy group
DefaultApi	DeleteSessions	Delete /users/{id}/sessions	Invalidate login sessions
DefaultApi	DeleteUser	Delete /users/{id}	Delete a user
DefaultApi	DeleteVolume	Delete /namespaces/{namespaceID}/volumes/{id}	Delete a volume
DefaultApi	DetachVolume	Delete /namespaces/{namespaceID}/volumes/{id}/attach	Detach the given volume
DefaultApi	GetAuthenticatedUser	Get /users/self	Get the currently authenticated user's information
DefaultApi	GetCluster	Get /cluster	Retrieves the cluster's global configuration settings
DefaultApi	GetDiagnostics	Get /diagnostics	Retrieves a diagnostics bundle from the target node
DefaultApi	GetLicence	Get /cluster/licence	Retrieves the cluster's licence information
DefaultApi	GetNamespace	Get /namespaces/{id}	Fetch a namespace
DefaultApi	GetNode	Get /nodes/{id}	Fetch a node
DefaultApi	GetPolicyGroup	Get /policies/{id}	Fetch a policy group
DefaultApi	GetSingleNodeDiagnostics	Get /diagnostics/{id}	Retrieves a single node diagnostics bundle from the target node
DefaultApi	GetUser	Get /users/{id}	Fetch a user
DefaultApi	GetVolume	Get /namespaces/{namespaceID}/volumes/{id}	Fetch a volume
DefaultApi	ListNamespaces	Get /namespaces	Fetch the list of namespaces
DefaultApi	ListNodes	Get /nodes	Fetch the list of nodes
DefaultApi	ListPolicyGroups	Get /policies	Fetch the list of policy groups
DefaultApi	ListUsers	Get /users	Fetch the list of users
DefaultApi	ListVolumes	Get /namespaces/{namespaceID}/volumes	Fetch the list of volumes in the given namespace
DefaultApi	RefreshJwt	Post /auth/refresh	Refresh the JWT
DefaultApi	ResizeVolume	Put /namespaces/{namespaceID}/volumes/{id}/size	Increase the size of a volume.
DefaultApi	SetComputeOnly	Put /nodes/{id}/compute-only	Modify the computeonly behaviour state for a node
DefaultApi	SetCordoned	Put /nodes/{id}/cordon	Modify the cordoned state for a node
DefaultApi	SetFailureMode	Put /namespaces/{namespaceID}/volumes/{id}/failure-mode	Set the failure mode of the volume.
DefaultApi	SetPlacementStrategy	Put /namespaces/{namespaceID}/volumes/{id}/placement-strategy	Sets the placement strategy of the volume.
DefaultApi	SetReplicas	Put /namespaces/{namespaceID}/volumes/{id}/replicas	Set the number of replicas to maintain for the volume.
DefaultApi	Spec	Get /openapi	Serves this openapi spec file
DefaultApi	UpdateAuthenticatedUser	Put /users/self	Update the authenticated user's information
DefaultApi	UpdateCluster	Put /cluster	Update the cluster's global configuration settings
DefaultApi	UpdateLicence	Put /cluster/licence	Update the licence global configuration settings
DefaultApi	UpdateNFSVolumeExports	Put /namespaces/{namespaceID}/volumes/{id}/nfs/export-config	Update an nfs volume's export configuration
DefaultApi	UpdateNFSVolumeMountEndpoint	Put /namespaces/{namespaceID}/volumes/{id}/nfs/mount-endpoint	Update an nfs volume's mount endpoint
DefaultApi	UpdateNamespace	Put /namespaces/{id}	Update a namespace
DefaultApi	UpdateNode	Put /nodes/{id}	Update a node
DefaultApi	UpdatePolicyGroup	Put /policies/{id}	Update a policy group
DefaultApi	UpdateUser	Put /users/{id}	Update a user
DefaultApi	UpdateVolume	Put /namespaces/{namespaceID}/volumes/{id}	Update a volume

Documentation For Models

Documentation For Authorization

jwt

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

[email protected]