Go API client for api

Description of all APIs

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: version not set
Package version: 1.0.0
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 api "github.com/eschercloudai/argocd-client-go/pkg/api"

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountServiceApi	AccountServiceCanI	Get /api/v1/account/can-i/{resource}/{action}/{subresource}	CanI checks if the current account has permission to perform an action
AccountServiceApi	AccountServiceCreateToken	Post /api/v1/account/{name}/token	CreateToken creates a token
AccountServiceApi	AccountServiceDeleteToken	Delete /api/v1/account/{name}/token/{id}	DeleteToken deletes a token
AccountServiceApi	AccountServiceGetAccount	Get /api/v1/account/{name}	GetAccount returns an account
AccountServiceApi	AccountServiceListAccounts	Get /api/v1/account	ListAccounts returns the list of accounts
AccountServiceApi	AccountServiceUpdatePassword	Put /api/v1/account/password	UpdatePassword updates an account's password to a new value
ApplicationServiceApi	ApplicationServiceCreate	Post /api/v1/applications	Create creates an application
ApplicationServiceApi	ApplicationServiceDelete	Delete /api/v1/applications/{name}	Delete deletes an application
ApplicationServiceApi	ApplicationServiceDeleteResource	Delete /api/v1/applications/{name}/resource	DeleteResource deletes a single application resource
ApplicationServiceApi	ApplicationServiceGet	Get /api/v1/applications/{name}	Get returns an application by name
ApplicationServiceApi	ApplicationServiceGetApplicationSyncWindows	Get /api/v1/applications/{name}/syncwindows	Get returns sync windows of the application
ApplicationServiceApi	ApplicationServiceGetManifests	Get /api/v1/applications/{name}/manifests	GetManifests returns application manifests
ApplicationServiceApi	ApplicationServiceGetManifestsWithFiles	Post /api/v1/applications/manifestsWithFiles	GetManifestsWithFiles returns application manifests using provided files to generate them
ApplicationServiceApi	ApplicationServiceGetResource	Get /api/v1/applications/{name}/resource	GetResource returns single application resource
ApplicationServiceApi	ApplicationServiceList	Get /api/v1/applications	List returns list of applications
ApplicationServiceApi	ApplicationServiceListResourceActions	Get /api/v1/applications/{name}/resource/actions	ListResourceActions returns list of resource actions
ApplicationServiceApi	ApplicationServiceListResourceEvents	Get /api/v1/applications/{name}/events	ListResourceEvents returns a list of event resources
ApplicationServiceApi	ApplicationServiceManagedResources	Get /api/v1/applications/{applicationName}/managed-resources	ManagedResources returns list of managed resources
ApplicationServiceApi	ApplicationServicePatch	Patch /api/v1/applications/{name}	Patch patch an application
ApplicationServiceApi	ApplicationServicePatchResource	Post /api/v1/applications/{name}/resource	PatchResource patch single application resource
ApplicationServiceApi	ApplicationServicePodLogs	Get /api/v1/applications/{name}/pods/{podName}/logs	PodLogs returns stream of log entries for the specified pod. Pod
ApplicationServiceApi	ApplicationServicePodLogs2	Get /api/v1/applications/{name}/logs	PodLogs returns stream of log entries for the specified pod. Pod
ApplicationServiceApi	ApplicationServiceResourceTree	Get /api/v1/applications/{applicationName}/resource-tree	ResourceTree returns resource tree
ApplicationServiceApi	ApplicationServiceRevisionMetadata	Get /api/v1/applications/{name}/revisions/{revision}/metadata	Get the meta-data (author, date, tags, message) for a specific revision of the application
ApplicationServiceApi	ApplicationServiceRollback	Post /api/v1/applications/{name}/rollback	Rollback syncs an application to its target state
ApplicationServiceApi	ApplicationServiceRunResourceAction	Post /api/v1/applications/{name}/resource/actions	RunResourceAction run resource action
ApplicationServiceApi	ApplicationServiceSync	Post /api/v1/applications/{name}/sync	Sync syncs an application to its target state
ApplicationServiceApi	ApplicationServiceTerminateOperation	Delete /api/v1/applications/{name}/operation	TerminateOperation terminates the currently running operation
ApplicationServiceApi	ApplicationServiceUpdate	Put /api/v1/applications/{application.metadata.name}	Update updates an application
ApplicationServiceApi	ApplicationServiceUpdateSpec	Put /api/v1/applications/{name}/spec	UpdateSpec updates an application spec
ApplicationServiceApi	ApplicationServiceWatch	Get /api/v1/stream/applications	Watch returns stream of application change events
ApplicationServiceApi	ApplicationServiceWatchResourceTree	Get /api/v1/stream/applications/{applicationName}/resource-tree	Watch returns stream of application resource tree
ApplicationSetServiceApi	ApplicationSetServiceCreate	Post /api/v1/applicationsets	Create creates an applicationset
ApplicationSetServiceApi	ApplicationSetServiceDelete	Delete /api/v1/applicationsets/{name}	Delete deletes an application set
ApplicationSetServiceApi	ApplicationSetServiceGet	Get /api/v1/applicationsets/{name}	Get returns an applicationset by name
ApplicationSetServiceApi	ApplicationSetServiceList	Get /api/v1/applicationsets	List returns list of applicationset
CertificateServiceApi	CertificateServiceCreateCertificate	Post /api/v1/certificates	Creates repository certificates on the server
CertificateServiceApi	CertificateServiceDeleteCertificate	Delete /api/v1/certificates	Delete the certificates that match the RepositoryCertificateQuery
CertificateServiceApi	CertificateServiceListCertificates	Get /api/v1/certificates	List all available repository certificates
ClusterServiceApi	ClusterServiceCreate	Post /api/v1/clusters	Create creates a cluster
ClusterServiceApi	ClusterServiceDelete	Delete /api/v1/clusters/{id.value}	Delete deletes a cluster
ClusterServiceApi	ClusterServiceGet	Get /api/v1/clusters/{id.value}	Get returns a cluster by server address
ClusterServiceApi	ClusterServiceInvalidateCache	Post /api/v1/clusters/{id.value}/invalidate-cache	InvalidateCache invalidates cluster cache
ClusterServiceApi	ClusterServiceList	Get /api/v1/clusters	List returns list of clusters
ClusterServiceApi	ClusterServiceRotateAuth	Post /api/v1/clusters/{id.value}/rotate-auth	RotateAuth rotates the bearer token used for a cluster
ClusterServiceApi	ClusterServiceUpdate	Put /api/v1/clusters/{id.value}	Update updates a cluster
GPGKeyServiceApi	GPGKeyServiceCreate	Post /api/v1/gpgkeys	Create one or more GPG public keys in the server's configuration
GPGKeyServiceApi	GPGKeyServiceDelete	Delete /api/v1/gpgkeys	Delete specified GPG public key from the server's configuration
GPGKeyServiceApi	GPGKeyServiceGet	Get /api/v1/gpgkeys/{keyID}	Get information about specified GPG public key from the server
GPGKeyServiceApi	GPGKeyServiceList	Get /api/v1/gpgkeys	List all available repository certificates
NotificationServiceApi	NotificationServiceListServices	Get /api/v1/notifications/services	List returns list of services
NotificationServiceApi	NotificationServiceListTemplates	Get /api/v1/notifications/templates	List returns list of templates
NotificationServiceApi	NotificationServiceListTriggers	Get /api/v1/notifications/triggers	List returns list of triggers
ProjectServiceApi	ProjectServiceCreate	Post /api/v1/projects	Create a new project
ProjectServiceApi	ProjectServiceCreateToken	Post /api/v1/projects/{project}/roles/{role}/token	Create a new project token
ProjectServiceApi	ProjectServiceDelete	Delete /api/v1/projects/{name}	Delete deletes a project
ProjectServiceApi	ProjectServiceDeleteToken	Delete /api/v1/projects/{project}/roles/{role}/token/{iat}	Delete a new project token
ProjectServiceApi	ProjectServiceGet	Get /api/v1/projects/{name}	Get returns a project by name
ProjectServiceApi	ProjectServiceGetDetailedProject	Get /api/v1/projects/{name}/detailed	GetDetailedProject returns a project that include project, global project and scoped resources by name
ProjectServiceApi	ProjectServiceGetGlobalProjects	Get /api/v1/projects/{name}/globalprojects	Get returns a virtual project by name
ProjectServiceApi	ProjectServiceGetSyncWindowsState	Get /api/v1/projects/{name}/syncwindows	GetSchedulesState returns true if there are any active sync syncWindows
ProjectServiceApi	ProjectServiceList	Get /api/v1/projects	List returns list of projects
ProjectServiceApi	ProjectServiceListEvents	Get /api/v1/projects/{name}/events	ListEvents returns a list of project events
ProjectServiceApi	ProjectServiceUpdate	Put /api/v1/projects/{project.metadata.name}	Update updates a project
RepoCredsServiceApi	RepoCredsServiceCreateRepositoryCredentials	Post /api/v1/repocreds	CreateRepositoryCredentials creates a new repository credential set
RepoCredsServiceApi	RepoCredsServiceDeleteRepositoryCredentials	Delete /api/v1/repocreds/{url}	DeleteRepositoryCredentials deletes a repository credential set from the configuration
RepoCredsServiceApi	RepoCredsServiceListRepositoryCredentials	Get /api/v1/repocreds	ListRepositoryCredentials gets a list of all configured repository credential sets
RepoCredsServiceApi	RepoCredsServiceUpdateRepositoryCredentials	Put /api/v1/repocreds/{creds.url}	UpdateRepositoryCredentials updates a repository credential set
RepositoryServiceApi	RepositoryServiceCreateRepository	Post /api/v1/repositories	CreateRepository creates a new repository configuration
RepositoryServiceApi	RepositoryServiceDeleteRepository	Delete /api/v1/repositories/{repo}	DeleteRepository deletes a repository from the configuration
RepositoryServiceApi	RepositoryServiceGet	Get /api/v1/repositories/{repo}	Get returns a repository or its credentials
RepositoryServiceApi	RepositoryServiceGetAppDetails	Post /api/v1/repositories/{source.repoURL}/appdetails	GetAppDetails returns application details by given path
RepositoryServiceApi	RepositoryServiceGetHelmCharts	Get /api/v1/repositories/{repo}/helmcharts	GetHelmCharts returns list of helm charts in the specified repository
RepositoryServiceApi	RepositoryServiceListApps	Get /api/v1/repositories/{repo}/apps	ListApps returns list of apps in the repo
RepositoryServiceApi	RepositoryServiceListRefs	Get /api/v1/repositories/{repo}/refs
RepositoryServiceApi	RepositoryServiceListRepositories	Get /api/v1/repositories	ListRepositories gets a list of all configured repositories
RepositoryServiceApi	RepositoryServiceUpdateRepository	Put /api/v1/repositories/{repo.repo}	UpdateRepository updates a repository configuration
RepositoryServiceApi	RepositoryServiceValidateAccess	Post /api/v1/repositories/{repo}/validate	ValidateAccess validates access to a repository with given parameters
SessionServiceApi	SessionServiceCreate	Post /api/v1/session	Create a new JWT for authentication and set a cookie if using HTTP
SessionServiceApi	SessionServiceDelete	Delete /api/v1/session	Delete an existing JWT cookie if using HTTP
SessionServiceApi	SessionServiceGetUserInfo	Get /api/v1/session/userinfo	Get the current user's info
SettingsServiceApi	SettingsServiceGet	Get /api/v1/settings	Get returns Argo CD settings
VersionServiceApi	VersionServiceVersion	Get /api/version	Version returns version information of the API server

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

# Packages

# README