client

package
v1.7.7 Latest Latest
Warning

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

 Go to latest Published: May 24, 2023 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/v1

Class Method HTTP request Description
ProjectApi ProjectsGet Get /projects List existing projects
ProjectApi ProjectsPost Post /projects Create new project
ProjectApi ProjectsProjectIdGet Get /projects/{project_id} Get project
ProjectApi ProjectsProjectIdPut Put /projects/{project_id} Update project
SecretApi ProjectsProjectIdSecretsGet Get /projects/{project_id}/secrets List secret
SecretApi ProjectsProjectIdSecretsPost Post /projects/{project_id}/secrets Create secret
SecretApi ProjectsProjectIdSecretsSecretIdDelete Delete /projects/{project_id}/secrets/{secret_id} Delete secret
SecretApi ProjectsProjectIdSecretsSecretIdPatch Patch /projects/{project_id}/secrets/{secret_id} Update secret

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 {
	ProjectApi *ProjectApiService

	SecretApi *SecretApiService
	// 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 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 ProjectApiProjectsGetOpts 

type ProjectApiProjectsGetOpts struct {
	Name optional.String
}

type ProjectApiService 

type ProjectApiService service

func (*ProjectApiService) ProjectsGet 

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

func (*ProjectApiService) ProjectsPost 

func (a *ProjectApiService) ProjectsPost(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) ProjectsProjectIdGet 

func (a *ProjectApiService) ProjectsProjectIdGet(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) ProjectsProjectIdPut 

func (a *ProjectApiService) ProjectsProjectIdPut(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 Secret 

type Secret struct {
	ID   int32  `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Data string `json:"data,omitempty"`
}

type SecretApiProjectsProjectIdSecretsSecretIdPatchOpts 

type SecretApiProjectsProjectIdSecretsSecretIdPatchOpts struct {
	Body optional.Interface
}

type SecretApiService 

type SecretApiService service

func (*SecretApiService) ProjectsProjectIdSecretsGet 

func (a *SecretApiService) ProjectsProjectIdSecretsGet(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) ProjectsProjectIdSecretsPost 

func (a *SecretApiService) ProjectsProjectIdSecretsPost(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) ProjectsProjectIdSecretsSecretIdDelete 

func (a *SecretApiService) ProjectsProjectIdSecretsSecretIdDelete(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) ProjectsProjectIdSecretsSecretIdPatch 

func (a *SecretApiService) ProjectsProjectIdSecretsSecretIdPatch(ctx context.Context, projectID int32, secretID int32, localVarOptionals *SecretApiProjectsProjectIdSecretsSecretIdPatchOpts) (Secret, *http.Response, error)

Source Files

View all Source files

Directories

Path Synopsis
examples
project-endpoints command
secret-endpoints command

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.