Go API client for labs_alert_manager_client

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: 1.0.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 labs_alert_manager_client "github.com/GIT_USER_ID/GIT_REPO_ID"

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 labs_alert_manager_client.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), labs_alert_manager_client.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value labs_alert_manager_client.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), labs_alert_manager_client.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 labs_alert_manager_client.ContextOperationServerIndices and labs_alert_manager_client.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), labs_alert_manager_client.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), labs_alert_manager_client.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
ChannelsAPI	DeletePolicyChannelsDelete	Delete /channels/{id}
ChannelsAPI	GetPolicyChannelsGet	Get /channels/{id}
ChannelsAPI	GetPolicyChannelsGetAll	Get /channels
ChannelsAPI	PostPolicyChannelsPost	Post /channels
ChannelsAPI	PostPolicyChannelsTest	Post /channels/test
ChannelsAPI	PutPolicyChannelsPut	Put /channels/{id}
DocsAPI	GetSwaggerJson	Get /docs/swagger.json
DocsAPI	GetSwaggerYml	Get /docs/swagger.yml
EventsAPI	DeleteEventsParametersDelete	Delete /events/parameters/{app_key}
EventsAPI	GetEventsGet	Get /events/{id}
EventsAPI	GetEventsGetAll	Get /events
EventsAPI	GetEventsParametersGet	Get /events/parameters
EventsAPI	PostEventsPost	Post /events
HealthCheckAPI	GetHealthCheck	Get /health_check
NotificationsAPI	GetNotificationLogGet	Get /notifications/{id}
NotificationsAPI	GetNotificationLogGetAll	Get /notifications
NotificationsAPI	PostNotificationLogResend	Post /notifications/{id}/resend
PoliciesAPI	DeletePoliciesDelete	Delete /policies/{id}
PoliciesAPI	GetPoliciesGet	Get /policies/{id}
PoliciesAPI	GetPoliciesGetAll	Get /policies
PoliciesAPI	PostPoliciesPost	Post /policies
PoliciesAPI	PutPoliciesPut	Put /policies/{id}
WelcomeAPI	GetWelcome	Get /

Documentation For Models

• EventSchema
• NotificationSchema
• PaginationSchema
• PolicyChannelSchema
• PolicySchema

Documentation For Authorization

Authentication schemes defined for the API:

auth_token

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		labs_alert_manager_client.ContextAPIKeys,
		map[string]labs_alert_manager_client.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

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