package
1.13.2
Repository: https://github.com/caraml-dev/mlp.git
Documentation: pkg.go.dev

# 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

ClassMethodHTTP requestDescription
ApplicationApiV2ApplicationsGetGet /v2/applicationsList CaraML applications
ProjectApiV1ProjectsGetGet /v1/projectsList existing projects
ProjectApiV1ProjectsPostPost /v1/projectsCreate new project
ProjectApiV1ProjectsProjectIdGetGet /v1/projects/{project_id}Get project
ProjectApiV1ProjectsProjectIdPutPut /v1/projects/{project_id}Update project
SecretApiV1ProjectsProjectIdSecretsGetGet /v1/projects/{project_id}/secretsList secret
SecretApiV1ProjectsProjectIdSecretsPostPost /v1/projects/{project_id}/secretsCreate secret
SecretApiV1ProjectsProjectIdSecretsSecretIdDeleteDelete /v1/projects/{project_id}/secrets/{secret_id}Delete secret
SecretApiV1ProjectsProjectIdSecretsSecretIdGetGet /v1/projects/{project_id}/secrets/{secret_id}Get secret
SecretApiV1ProjectsProjectIdSecretsSecretIdPatchPatch /v1/projects/{project_id}/secrets/{secret_id}Update secret
SecretStorageApiV1ProjectsProjectIdSecretStoragesGetGet /v1/projects/{project_id}/secret_storagesList secret storage
SecretStorageApiV1ProjectsProjectIdSecretStoragesPostPost /v1/projects/{project_id}/secret_storagesCreate secret storage
SecretStorageApiV1ProjectsProjectIdSecretStoragesSecretStorageIdDeleteDelete /v1/projects/{project_id}/secret_storages/{secret_storage_id}Delete secret storage
SecretStorageApiV1ProjectsProjectIdSecretStoragesSecretStorageIdGetGet /v1/projects/{project_id}/secret_storages/{secret_storage_id}Get secret storage
SecretStorageApiV1ProjectsProjectIdSecretStoragesSecretStorageIdPatchPatch /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

# Packages

No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the MLP API API v0.4.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author