api

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jan 14, 2025 License: GPL-3.0 Imports: 20 Imported by: 0

README ¶

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.24.0
  • 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 "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 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
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 ApiGetMembers Get /api/v1/etcd/members Etcd members
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 EtcdJoinMember Post /api/v1/etcd/join Etcd join
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

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

Documentation ¶

Index ¶