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: 0.33.0
• Package version: 1.0.0
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Import the package in a go file in your project and run go mod tidy:

import api "beryju.io/gravity/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 api.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 api.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 api.ContextOperationServerIndices and api.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
ClusterAPI	ClusterGetClusterInfo	Get /api/v1/cluster	Cluster
ClusterInstancesAPI	ClusterGetInstanceInfo	Get /api/v1/cluster/instance	Instance
ClusterInstancesAPI	ClusterInstanceRoleRestart	Post /api/v1/cluster/roles/restart	Instance roles
RolesApiAPI	ApiAuthConfig	Get /api/v1/auth/config	API Users
RolesApiAPI	ApiDeleteTokens	Delete /api/v1/auth/tokens	Tokens
RolesApiAPI	ApiDeleteUsers	Delete /api/v1/auth/users	API Users
RolesApiAPI	ApiExport	Post /api/v1/cluster/export	Export Cluster
RolesApiAPI	ApiGetLogMessages	Get /api/v1/cluster/node/logs	Log messages
RolesApiAPI	ApiGetRoleConfig	Get /api/v1/roles/api	API role config
RolesApiAPI	ApiGetTokens	Get /api/v1/auth/tokens	Tokens
RolesApiAPI	ApiGetUsers	Get /api/v1/auth/users	API Users
RolesApiAPI	ApiImport	Post /api/v1/cluster/import	Import Cluster
RolesApiAPI	ApiLoginUser	Post /api/v1/auth/login	API Users
RolesApiAPI	ApiPutRoleConfig	Post /api/v1/roles/api	API role config
RolesApiAPI	ApiPutTokens	Post /api/v1/auth/tokens	Tokens
RolesApiAPI	ApiPutUsers	Post /api/v1/auth/users	API Users
RolesApiAPI	ApiUsersMe	Get /api/v1/auth/me	API Users
RolesApiAPI	ToolsPing	Post /api/v1/tools/ping	Ping tool
RolesApiAPI	ToolsPortmap	Post /api/v1/tools/portmap	Portmap tool
RolesApiAPI	ToolsTraceroute	Post /api/v1/tools/traceroute	Traceroute tool
RolesBackupAPI	BackupGetRoleConfig	Get /api/v1/roles/backup	Backup role config
RolesBackupAPI	BackupPutRoleConfig	Post /api/v1/roles/backup	Backup role config
RolesBackupAPI	BackupStart	Post /api/v1/backup/start	Backup start
RolesBackupAPI	BackupStatus	Get /api/v1/backup/status	Backup status
RolesDhcpAPI	DhcpDeleteLeases	Delete /api/v1/dhcp/scopes/leases	DHCP Leases
RolesDhcpAPI	DhcpDeleteScopes	Delete /api/v1/dhcp/scopes	DHCP Scopes
RolesDhcpAPI	DhcpGetLeases	Get /api/v1/dhcp/scopes/leases	DHCP Leases
RolesDhcpAPI	DhcpGetRoleConfig	Get /api/v1/roles/dhcp	DHCP role config
RolesDhcpAPI	DhcpGetScopes	Get /api/v1/dhcp/scopes	DHCP Scopes
RolesDhcpAPI	DhcpImportScopes	Post /api/v1/dhcp/scopes/import	DHCP Scopes
RolesDhcpAPI	DhcpPutLeases	Post /api/v1/dhcp/scopes/leases	DHCP Leases
RolesDhcpAPI	DhcpPutRoleConfig	Post /api/v1/roles/dhcp	DHCP role config
RolesDhcpAPI	DhcpPutScopes	Post /api/v1/dhcp/scopes	DHCP Scopes
RolesDhcpAPI	DhcpWolLeases	Post /api/v1/dhcp/scopes/leases/wol	DHCP Leases
RolesDiscoveryAPI	DiscoveryApplyDevice	Post /api/v1/discovery/devices/apply	Apply Discovered devices
RolesDiscoveryAPI	DiscoveryDeleteDevices	Delete /api/v1/discovery/devices/delete	Discovery devices
RolesDiscoveryAPI	DiscoveryDeleteSubnets	Delete /api/v1/discovery/subnets	Discovery Subnets
RolesDiscoveryAPI	DiscoveryGetDevices	Get /api/v1/discovery/devices	Discovery devices
RolesDiscoveryAPI	DiscoveryGetRoleConfig	Get /api/v1/roles/discovery	Discovery role config
RolesDiscoveryAPI	DiscoveryGetSubnets	Get /api/v1/discovery/subnets	Discovery subnets
RolesDiscoveryAPI	DiscoveryPutRoleConfig	Post /api/v1/roles/discovery	Discovery role config
RolesDiscoveryAPI	DiscoveryPutSubnets	Post /api/v1/discovery/subnets	Discovery Subnets
RolesDiscoveryAPI	DiscoverySubnetStart	Post /api/v1/discovery/subnets/start	Discovery Subnets
RolesDnsAPI	DnsDeleteRecords	Delete /api/v1/dns/zones/records	DNS Records
RolesDnsAPI	DnsDeleteZones	Delete /api/v1/dns/zones	DNS Zones
RolesDnsAPI	DnsGetRecords	Get /api/v1/dns/zones/records	DNS Records
RolesDnsAPI	DnsGetRoleConfig	Get /api/v1/roles/dns	DNS role config
RolesDnsAPI	DnsGetZones	Get /api/v1/dns/zones	DNS Zones
RolesDnsAPI	DnsImportZones	Post /api/v1/dns/zones/import	DNS Zones
RolesDnsAPI	DnsPutRecords	Post /api/v1/dns/zones/records	DNS Records
RolesDnsAPI	DnsPutRoleConfig	Post /api/v1/roles/dns	DNS role config
RolesDnsAPI	DnsPutZones	Post /api/v1/dns/zones	DNS Zones
RolesEtcdAPI	EtcdGetMembers	Get /api/v1/etcd/members	Etcd members
RolesEtcdAPI	EtcdJoinMember	Post /api/v1/etcd/join	Etcd join
RolesEtcdAPI	EtcdMoveLeader	Post /api/v1/etcd/move_leader	Etcd move leader
RolesEtcdAPI	EtcdRemoveMember	Delete /api/v1/etcd/remove	Etcd remove
RolesMonitoringAPI	MonitoringGetRoleConfig	Get /api/v1/roles/monitoring	Monitoring role config
RolesMonitoringAPI	MonitoringPutRoleConfig	Post /api/v1/roles/monitoring	Monitoring role config
RolesTftpAPI	TftpDeleteFiles	Delete /api/v1/tftp/files	TFTP Files
RolesTftpAPI	TftpDownloadFiles	Get /api/v1/tftp/files/download	TFTP Files
RolesTftpAPI	TftpGetFiles	Get /api/v1/tftp/files	TFTP Files
RolesTftpAPI	TftpGetRoleConfig	Get /api/v1/roles/tftp	TFTP role config
RolesTftpAPI	TftpPutFiles	Post /api/v1/tftp/files	TFTP Files
RolesTftpAPI	TftpPutRoleConfig	Post /api/v1/roles/tftp	TFTP role config
RolesTsdbAPI	TsdbGetMetrics	Get /api/v1/tsdb/metrics	Retrieve Metrics
RolesTsdbAPI	TsdbGetRoleConfig	Get /api/v1/roles/tsdb	TSDB role config
RolesTsdbAPI	TsdbPutRoleConfig	Post /api/v1/roles/tsdb	TSDB role config

Documentation For Models

• ApiAPIExportInput
• ApiAPIExportOutput
• ApiAPIImportInput
• ApiAPILogMessage
• ApiAPILogMessages
• ApiAPIRoleConfigInput
• ApiAPIRoleConfigOutput
• ApiAPIToolPingInput
• ApiAPIToolPingOutput
• ApiAPIToolPortmapInput
• ApiAPIToolPortmapOutput
• ApiAPIToolPortmapOutputPort
• ApiAPIToolTracerouteInput
• ApiAPIToolTracerouteOutput
• ApiAPIToolTracerouteOutputHop
• ApiAPITransportEntry
• ApiRoleConfig
• AuthAPIConfigOutput
• AuthAPILoginInput
• AuthAPILoginOutput
• AuthAPIMeOutput
• AuthAPIToken
• AuthAPITokensGetOutput
• AuthAPITokensPutOutput
• AuthAPIUser
• AuthAPIUsersGetOutput
• AuthAPIUsersPutInput
• BackupAPIBackupStatus
• BackupAPIBackupStatusOutput
• BackupAPIRoleConfigInput
• BackupAPIRoleConfigOutput
• BackupBackupStatus
• BackupRoleConfig
• DhcpAPILease
• DhcpAPILeaseInfo
• DhcpAPILeasesGetOutput
• DhcpAPILeasesPutInput
• DhcpAPIRoleConfigInput
• DhcpAPIRoleConfigOutput
• DhcpAPIScope
• DhcpAPIScopeStatistics
• DhcpAPIScopesGetOutput
• DhcpAPIScopesImportInput
• DhcpAPIScopesImportOutput
• DhcpAPIScopesImporterType
• DhcpAPIScopesPutInput
• DhcpRoleConfig
• DhcpScopeDNS
• DiscoveryAPIDevice
• DiscoveryAPIDevicesApplyInput
• DiscoveryAPIDevicesGetOutput
• DiscoveryAPIRoleConfigInput
• DiscoveryAPIRoleConfigOutput
• DiscoveryAPISubnet
• DiscoveryAPISubnetsGetOutput
• DiscoveryAPISubnetsPutInput
• DiscoveryRoleConfig
• DnsAPIRecord
• DnsAPIRecordsGetOutput
• DnsAPIRecordsPutInput
• DnsAPIRoleConfigInput
• DnsAPIRoleConfigOutput
• DnsAPIZone
• DnsAPIZonesGetOutput
• DnsAPIZonesImportInput
• DnsAPIZonesImportOutput
• DnsAPIZonesImporterType
• DnsAPIZonesPutInput
• DnsRoleConfig
• EtcdAPIMember
• EtcdAPIMemberJoinInput
• EtcdAPIMemberJoinOutput
• EtcdAPIMembersOutput
• ExtconfigExtConfigDirs
• InstanceAPIClusterInfoOutput
• InstanceAPIInstanceInfo
• InstanceAPIRoleRestartInput
• InstanceInstanceInfo
• MonitoringAPIRoleConfigInput
• MonitoringAPIRoleConfigOutput
• MonitoringRoleConfig
• RestErrResponse
• TftpAPIFile
• TftpAPIFilesDownloadOutput
• TftpAPIFilesGetOutput
• TftpAPIFilesPutInput
• TftpAPIRoleConfigInput
• TftpAPIRoleConfigOutput
• TftpRoleConfig
• TsdbAPIRoleConfigInput
• TsdbAPIRoleConfigOutput
• TsdbRoleConfig
• TypesAPIMetricsGetOutput
• TypesAPIMetricsRecord
• TypesAPIMetricsRole
• TypesDHCPOption
• TypesDNSRecordType
• TypesOIDCConfig
• TypesPermission

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

Author