client

package
v1.13.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 10, 2024 License: Apache-2.0 Imports: 21 Imported by: 12

README

Go API client for client

API Guide for accessing MLP API

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 0.4.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

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

import "./client"

Documentation for API Endpoints

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

Class Method HTTP request Description
ApplicationApi V2ApplicationsGet Get /v2/applications List CaraML applications
ProjectApi V1ProjectsGet Get /v1/projects List existing projects
ProjectApi V1ProjectsPost Post /v1/projects Create new project
ProjectApi V1ProjectsProjectIdGet Get /v1/projects/{project_id} Get project
ProjectApi V1ProjectsProjectIdPut Put /v1/projects/{project_id} Update project
SecretApi V1ProjectsProjectIdSecretsGet Get /v1/projects/{project_id}/secrets List secret
SecretApi V1ProjectsProjectIdSecretsPost Post /v1/projects/{project_id}/secrets Create secret
SecretApi V1ProjectsProjectIdSecretsSecretIdDelete Delete /v1/projects/{project_id}/secrets/{secret_id} Delete secret
SecretApi V1ProjectsProjectIdSecretsSecretIdGet Get /v1/projects/{project_id}/secrets/{secret_id} Get secret
SecretApi V1ProjectsProjectIdSecretsSecretIdPatch Patch /v1/projects/{project_id}/secrets/{secret_id} Update secret
SecretStorageApi V1ProjectsProjectIdSecretStoragesGet Get /v1/projects/{project_id}/secret_storages List secret storage
SecretStorageApi V1ProjectsProjectIdSecretStoragesPost Post /v1/projects/{project_id}/secret_storages Create secret storage
SecretStorageApi V1ProjectsProjectIdSecretStoragesSecretStorageIdDelete Delete /v1/projects/{project_id}/secret_storages/{secret_storage_id} Delete secret storage
SecretStorageApi V1ProjectsProjectIdSecretStoragesSecretStorageIdGet Get /v1/projects/{project_id}/secret_storages/{secret_storage_id} Get secret storage
SecretStorageApi V1ProjectsProjectIdSecretStoragesSecretStorageIdPatch Patch /v1/projects/{project_id}/secret_storages/{secret_storage_id} Update secret storage

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	ApplicationApi *ApplicationApiService

	ProjectApi *ProjectApiService

	SecretApi *SecretApiService

	SecretStorageApi *SecretStorageApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the MLP API API v0.4.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Application added in v1.8.0 

type Application struct {
	Name        string             `json:"name"`
	Description string             `json:"description,omitempty"`
	Homepage    string             `json:"homepage"`
	Config      *ApplicationConfig `json:"config,omitempty"`
}

type ApplicationApiService added in v1.8.0 

type ApplicationApiService service

func (*ApplicationApiService) V2ApplicationsGet added in v1.8.0 

func (a *ApplicationApiService) V2ApplicationsGet(ctx context.Context) ([]Application, *http.Response, error)

ApplicationApiService List CaraML applications

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Application

type ApplicationConfig added in v1.8.0 

type ApplicationConfig struct {
	Api        string                        `json:"api,omitempty"`
	Icon       string                        `json:"icon,omitempty"`
	Navigation []ApplicationConfigNavigation `json:"navigation,omitempty"`
}

type ApplicationConfigNavigation added in v1.8.0 

type ApplicationConfigNavigation struct {
	Label       string `json:"label,omitempty"`
	Destination string `json:"destination,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type Label 

type Label struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type Project 

type Project struct {
	ID                int32     `json:"id,omitempty"`
	Name              string    `json:"name"`
	MLFlowTrackingURL string    `json:"mlflow_tracking_url,omitempty"`
	Administrators    []string  `json:"administrators,omitempty"`
	Readers           []string  `json:"readers,omitempty"`
	Team              string    `json:"team,omitempty"`
	Stream            string    `json:"stream,omitempty"`
	Labels            []Label   `json:"labels,omitempty"`
	CreatedAt         time.Time `json:"created_at,omitempty"`
	UpdatedAt         time.Time `json:"updated_at,omitempty"`
}

type ProjectApiService 

type ProjectApiService service

func (*ProjectApiService) V1ProjectsGet added in v1.8.0 

func (a *ProjectApiService) V1ProjectsGet(ctx context.Context, localVarOptionals *ProjectApiV1ProjectsGetOpts) ([]Project, *http.Response, error)

func (*ProjectApiService) V1ProjectsPost added in v1.8.0 

func (a *ProjectApiService) V1ProjectsPost(ctx context.Context, body Project) (Project, *http.Response, error)

ProjectApiService Create new project

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Project object that has to be added

@return Project

func (*ProjectApiService) V1ProjectsProjectIdGet added in v1.8.0 

func (a *ProjectApiService) V1ProjectsProjectIdGet(ctx context.Context, projectID int32) (Project, *http.Response, error)

ProjectApiService Get project

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID project id of the project to be retrieved

@return Project

func (*ProjectApiService) V1ProjectsProjectIdPut added in v1.8.0 

func (a *ProjectApiService) V1ProjectsProjectIdPut(ctx context.Context, projectID int32, body Project) (Project, *http.Response, error)

ProjectApiService Update project

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID project id of the project to be updated
  • @param body Project object that has to be updated

@return Project

type ProjectApiV1ProjectsGetOpts added in v1.8.0 

type ProjectApiV1ProjectsGetOpts struct {
	Name optional.String
}

type Secret 

type Secret struct {
	ID              int32     `json:"id,omitempty"`
	Name            string    `json:"name"`
	Data            string    `json:"data"`
	SecretStorageID int32     `json:"secret_storage_id,omitempty"`
	CreatedAt       time.Time `json:"created_at,omitempty"`
	UpdatedAt       time.Time `json:"updated_at,omitempty"`
}

type SecretApiService 

type SecretApiService service

func (*SecretApiService) V1ProjectsProjectIdSecretsGet added in v1.8.0 

func (a *SecretApiService) V1ProjectsProjectIdSecretsGet(ctx context.Context, projectID int32) ([]Secret, *http.Response, error)

SecretApiService List secret

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID

@return []Secret

func (*SecretApiService) V1ProjectsProjectIdSecretsPost added in v1.8.0 

func (a *SecretApiService) V1ProjectsProjectIdSecretsPost(ctx context.Context, projectID int32, body Secret) (Secret, *http.Response, error)

SecretApiService Create secret

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID
  • @param body

@return Secret

func (*SecretApiService) V1ProjectsProjectIdSecretsSecretIdDelete added in v1.8.0 

func (a *SecretApiService) V1ProjectsProjectIdSecretsSecretIdDelete(ctx context.Context, projectID int32, secretId int32) (*http.Response, error)

SecretApiService Delete secret

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID
  • @param secretId

func (*SecretApiService) V1ProjectsProjectIdSecretsSecretIdGet added in v1.8.0 

func (a *SecretApiService) V1ProjectsProjectIdSecretsSecretIdGet(ctx context.Context, projectID int32, secretId int32) (Secret, *http.Response, error)

SecretApiService Get secret

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID
  • @param secretId

@return Secret

func (*SecretApiService) V1ProjectsProjectIdSecretsSecretIdPatch added in v1.8.0 

func (a *SecretApiService) V1ProjectsProjectIdSecretsSecretIdPatch(ctx context.Context, projectID int32, secretId int32, localVarOptionals *SecretApiV1ProjectsProjectIdSecretsSecretIdPatchOpts) (Secret, *http.Response, error)

type SecretApiV1ProjectsProjectIdSecretsSecretIdPatchOpts added in v1.8.0 

type SecretApiV1ProjectsProjectIdSecretsSecretIdPatchOpts struct {
	Body optional.Interface
}

type SecretStorage added in v1.8.0 

type SecretStorage struct {
	ID        int32                `json:"id,omitempty"`
	Name      string               `json:"name"`
	Type_     string               `json:"type"`
	Scope     string               `json:"scope"`
	ProjectID int32                `json:"project_id,omitempty"`
	Config    *SecretStorageConfig `json:"config"`
	CreatedAt time.Time            `json:"created_at,omitempty"`
	UpdatedAt time.Time            `json:"updated_at,omitempty"`
}

type SecretStorageApiService added in v1.8.0 

type SecretStorageApiService service

func (*SecretStorageApiService) V1ProjectsProjectIdSecretStoragesGet added in v1.8.0 

func (a *SecretStorageApiService) V1ProjectsProjectIdSecretStoragesGet(ctx context.Context, projectID int32) ([]SecretStorage, *http.Response, error)

SecretStorageApiService List secret storage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID

@return []SecretStorage

func (*SecretStorageApiService) V1ProjectsProjectIdSecretStoragesPost added in v1.8.0 

func (a *SecretStorageApiService) V1ProjectsProjectIdSecretStoragesPost(ctx context.Context, projectID int32, body SecretStorage) (SecretStorage, *http.Response, error)

SecretStorageApiService Create secret storage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID
  • @param body

@return SecretStorage

func (*SecretStorageApiService) V1ProjectsProjectIdSecretStoragesSecretStorageIdDelete added in v1.8.0 

func (a *SecretStorageApiService) V1ProjectsProjectIdSecretStoragesSecretStorageIdDelete(ctx context.Context, projectID int32, secretStorageID int32) (*http.Response, error)

SecretStorageApiService Delete secret storage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID
  • @param secretStorageID

func (*SecretStorageApiService) V1ProjectsProjectIdSecretStoragesSecretStorageIdGet added in v1.8.0 

func (a *SecretStorageApiService) V1ProjectsProjectIdSecretStoragesSecretStorageIdGet(ctx context.Context, projectID int32, secretStorageID int32) (SecretStorage, *http.Response, error)

SecretStorageApiService Get secret storage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectID
  • @param secretStorageID

@return SecretStorage

func (*SecretStorageApiService) V1ProjectsProjectIdSecretStoragesSecretStorageIdPatch added in v1.8.0 

func (a *SecretStorageApiService) V1ProjectsProjectIdSecretStoragesSecretStorageIdPatch(ctx context.Context, projectID int32, secretStorageID int32, localVarOptionals *SecretStorageApiV1ProjectsProjectIdSecretStoragesSecretStorageIdPatchOpts) (SecretStorage, *http.Response, error)

type SecretStorageApiV1ProjectsProjectIdSecretStoragesSecretStorageIdPatchOpts added in v1.8.0 

type SecretStorageApiV1ProjectsProjectIdSecretStoragesSecretStorageIdPatchOpts struct {
	Body optional.Interface
}

type SecretStorageConfig added in v1.8.0 

type SecretStorageConfig struct {
	Vault *VaultSecretStorageConfig `json:"vault,omitempty"`
}

type VaultSecretStorageConfig added in v1.8.0 

type VaultSecretStorageConfig struct {
	URL                 string `json:"url"`
	Role                string `json:"role,omitempty"`
	MountPath           string `json:"mount_path"`
	PathPrefix          string `json:"path_prefix"`
	AuthMethod          string `json:"auth_method"`
	GcpAuthType         string `json:"gcp_auth_type,omitempty"`
	ServiceAccountEmail string `json:"service_account_email,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis
examples
project-endpoints
secret-endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.