README.md

Go API client for edgeapplications

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: 2.0.0
• Package version: 1.0.0
• Generator version: 7.7.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 edgeapplications "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 edgeapplications.ContextServerIndex of type int.

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

Templated Server URL

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

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

ctx := context.WithValue(context.Background(), edgeapplications.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), edgeapplications.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.azionapi.net

Class	Method	HTTP request	Description
EdgeApplicationsCacheSettingsAPI	EdgeApplicationsEdgeApplicationIdCacheSettingsCacheSettingsIdDelete	Delete /edge_applications/{edge_application_id}/cache_settings/{cache_settings_id}	/edge_applications/:edge_application_id:/cache_settings/:cache_settings_id:
EdgeApplicationsCacheSettingsAPI	EdgeApplicationsEdgeApplicationIdCacheSettingsCacheSettingsIdGet	Get /edge_applications/{edge_application_id}/cache_settings/{cache_settings_id}	/edge_applications/:edge_application_id:/cache_settings/:cache_settings_id:
EdgeApplicationsCacheSettingsAPI	EdgeApplicationsEdgeApplicationIdCacheSettingsCacheSettingsIdPatch	Patch /edge_applications/{edge_application_id}/cache_settings/{cache_settings_id}	/edge_applications/:edge_application_id:/cache_settings/:cache_settings_id:
EdgeApplicationsCacheSettingsAPI	EdgeApplicationsEdgeApplicationIdCacheSettingsCacheSettingsIdPut	Put /edge_applications/{edge_application_id}/cache_settings/{cache_settings_id}	/edge_applications/:edge_application_id:/cache_settings/ca
EdgeApplicationsCacheSettingsAPI	EdgeApplicationsEdgeApplicationIdCacheSettingsGet	Get /edge_applications/{edge_application_id}/cache_settings	/edge_applications/{edge_application_id}/cache_settings
EdgeApplicationsCacheSettingsAPI	EdgeApplicationsEdgeApplicationIdCacheSettingsPost	Post /edge_applications/{edge_application_id}/cache_settings	/edge_applications/:edge_application_id:/cache_settings
EdgeApplicationsDeviceGroupsAPI	EdgeApplicationsEdgeApplicationIdDeviceGroupsDeviceGroupIdDelete	Delete /edge_applications/{edge_application_id}/device_groups/{device_group_id}	/edge_applications/{edge_application_id}/device_groups/{device_group_id}
EdgeApplicationsDeviceGroupsAPI	EdgeApplicationsEdgeApplicationIdDeviceGroupsDeviceGroupIdGet	Get /edge_applications/{edge_application_id}/device_groups/{device_group_id}	/edge_applications/{edge_application_id}/device_groups/{device_group_id}
EdgeApplicationsDeviceGroupsAPI	EdgeApplicationsEdgeApplicationIdDeviceGroupsDeviceGroupIdPatch	Patch /edge_applications/{edge_application_id}/device_groups/{device_group_id}	/edge_applications/{edge_application_id}/device_groups/{device_group_id}
EdgeApplicationsDeviceGroupsAPI	EdgeApplicationsEdgeApplicationIdDeviceGroupsDeviceGroupIdPut	Put /edge_applications/{edge_application_id}/device_groups/{device_group_id}	/edge_applications/{edge_application_id}/device_groups/{device_group_id}
EdgeApplicationsDeviceGroupsAPI	EdgeApplicationsEdgeApplicationIdDeviceGroupsGet	Get /edge_applications/{edge_application_id}/device_groups	/edge_applications/{edge_application_id}/device_groups
EdgeApplicationsDeviceGroupsAPI	EdgeApplicationsEdgeApplicationIdDeviceGroupsPost	Post /edge_applications/{edge_application_id}/device_groups	/edge_applications/{edge_application_id}/device_groups
EdgeApplicationsEdgeFunctionsInstancesAPI	EdgeApplicationsEdgeApplicationIdFunctionsInstancesFunctionsInstancesIdDelete	Delete /edge_applications/{edge_application_id}/functions_instances/{functions_instances_id}	/edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:
EdgeApplicationsEdgeFunctionsInstancesAPI	EdgeApplicationsEdgeApplicationIdFunctionsInstancesFunctionsInstancesIdGet	Get /edge_applications/{edge_application_id}/functions_instances/{functions_instances_id}	/edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:
EdgeApplicationsEdgeFunctionsInstancesAPI	EdgeApplicationsEdgeApplicationIdFunctionsInstancesFunctionsInstancesIdPatch	Patch /edge_applications/{edge_application_id}/functions_instances/{functions_instances_id}	/edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:
EdgeApplicationsEdgeFunctionsInstancesAPI	EdgeApplicationsEdgeApplicationIdFunctionsInstancesFunctionsInstancesIdPut	Put /edge_applications/{edge_application_id}/functions_instances/{functions_instances_id}	/edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:
EdgeApplicationsEdgeFunctionsInstancesAPI	EdgeApplicationsEdgeApplicationIdFunctionsInstancesGet	Get /edge_applications/{edge_application_id}/functions_instances	/edge_applications/:edge_application_id:/functions_instances
EdgeApplicationsEdgeFunctionsInstancesAPI	EdgeApplicationsEdgeApplicationIdFunctionsInstancesPost	Post /edge_applications/{edge_application_id}/functions_instances	edge_application/:edge_application_id:/functions_instances
EdgeApplicationsMainSettingsAPI	EdgeApplicationsGet	Get /edge_applications	/edge_applications
EdgeApplicationsMainSettingsAPI	EdgeApplicationsIdDelete	Delete /edge_applications/{id}	/edge_applications/:id
EdgeApplicationsMainSettingsAPI	EdgeApplicationsIdGet	Get /edge_applications/{id}	/edge_applications/:id
EdgeApplicationsMainSettingsAPI	EdgeApplicationsIdPatch	Patch /edge_applications/{id}	/edge_applications/:id
EdgeApplicationsMainSettingsAPI	EdgeApplicationsIdPut	Put /edge_applications/{id}	/edge_applications/:id
EdgeApplicationsMainSettingsAPI	EdgeApplicationsPost	Post /edge_applications	/edge_applications
EdgeApplicationsOriginsAPI	EdgeApplicationsEdgeApplicationIdOriginsGet	Get /edge_applications/{edge_application_id}/origins	/edge_applications/{edge_application_id}/origins
EdgeApplicationsOriginsAPI	EdgeApplicationsEdgeApplicationIdOriginsOriginKeyDelete	Delete /edge_applications/{edge_application_id}/origins/{origin_key}	/edge_applications/{edge_application_id}/origins/{origin_id}
EdgeApplicationsOriginsAPI	EdgeApplicationsEdgeApplicationIdOriginsOriginKeyGet	Get /edge_applications/{edge_application_id}/origins/{origin_key}	/edge_applications/{edge_application_id}/origins/{origin_key}
EdgeApplicationsOriginsAPI	EdgeApplicationsEdgeApplicationIdOriginsOriginKeyPatch	Patch /edge_applications/{edge_application_id}/origins/{origin_key}	/edge_applications/:edge_application_id:/origins/:origin_id:
EdgeApplicationsOriginsAPI	EdgeApplicationsEdgeApplicationIdOriginsOriginKeyPut	Put /edge_applications/{edge_application_id}/origins/{origin_key}	/edge_applications/{edge_application_id}/origins/{origin_id}
EdgeApplicationsOriginsAPI	EdgeApplicationsEdgeApplicationIdOriginsPost	Post /edge_applications/{edge_application_id}/origins	/edge_applications/{edge_application_id}/origins
EdgeApplicationsRulesEngineAPI	EdgeApplicationsEdgeApplicationIdRulesEnginePhaseRulesGet	Get /edge_applications/{edge_application_id}/rules_engine/{phase}/rules	/edge_applications/{edge_application_id}/rules_engine/{phase}/rules
EdgeApplicationsRulesEngineAPI	EdgeApplicationsEdgeApplicationIdRulesEnginePhaseRulesPost	Post /edge_applications/{edge_application_id}/rules_engine/{phase}/rules	/edge_applications/{edge_application_id}/rules_engine/{phase}/rules
EdgeApplicationsRulesEngineAPI	EdgeApplicationsEdgeApplicationIdRulesEnginePhaseRulesRuleIdDelete	Delete /edge_applications/{edge_application_id}/rules_engine/{phase}/rules/{rule_id}	/edge_applications/{edge_application_id}/rules_engine/{phase}/rules
EdgeApplicationsRulesEngineAPI	EdgeApplicationsEdgeApplicationIdRulesEnginePhaseRulesRuleIdGet	Get /edge_applications/{edge_application_id}/rules_engine/{phase}/rules/{rule_id}	/edge_applications/{edge_application_id}/rules_engine/{phase}/rules
EdgeApplicationsRulesEngineAPI	EdgeApplicationsEdgeApplicationIdRulesEnginePhaseRulesRuleIdPatch	Patch /edge_applications/{edge_application_id}/rules_engine/{phase}/rules/{rule_id}	/edge_applications/:edge_application_id:/rules_engine/:phase:/rules/:rule_id:
EdgeApplicationsRulesEngineAPI	EdgeApplicationsEdgeApplicationIdRulesEnginePhaseRulesRuleIdPut	Put /edge_applications/{edge_application_id}/rules_engine/{phase}/rules/{rule_id}	/edge_applications/:edge_application_id:/rules_engine/:phase:/rules/:rule_id:

Documentation For Models

• ApplicationCacheCreateRequest
• ApplicationCacheCreateResponse
• ApplicationCacheCreateResults
• ApplicationCacheGetOneResponse
• ApplicationCacheGetResponse
• ApplicationCachePatchRequest
• ApplicationCachePatchResponse
• ApplicationCachePutRequest
• ApplicationCachePutResponse
• ApplicationCacheResponseDetails
• ApplicationCacheResults
• ApplicationCreateInstanceRequest
• ApplicationInstanceResults
• ApplicationInstancesGetOneResponse
• ApplicationInstancesGetResponse
• ApplicationInstancesResults
• ApplicationLinks
• ApplicationOrigins
• ApplicationPutInstanceRequest
• ApplicationPutRequest
• ApplicationPutResult
• ApplicationResults
• ApplicationResultsCreate
• ApplicationUpdateInstanceRequest
• ApplicationUpdateRequest
• ApplicationUpdateResponse
• ApplicationUpdateResults
• ApplicationsResults
• CreateApplicationRequest
• CreateApplicationResult
• CreateDeviceGroupsRequest
• CreateOriginsRequest
• CreateOriginsRequestAddresses
• CreateRulesEngineRequest
• DeviceGroupsIdResponse
• DeviceGroupsResponse
• DeviceGroupsResponseLinks
• DeviceGroupsResultResponse
• GetApplicationResponse
• GetApplicationsResponse
• OriginsIdResponse
• OriginsResponse
• OriginsResponseLinks
• OriginsResultResponse
• OriginsResultResponseAddresses
• PatchDeviceGroupsRequest
• PatchOriginsRequest
• PatchRulesEngineRequest
• RulesEngineBehaviorEntry
• RulesEngineBehaviorObject
• RulesEngineBehaviorObjectTarget
• RulesEngineBehaviorString
• RulesEngineCriteria
• RulesEngineIdResponse
• RulesEngineResponse
• RulesEngineResultResponse
• UpdateDeviceGroupsRequest
• UpdateOriginsRequest
• UpdateRulesEngineRequest

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

• 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(),
		edgeapplications.ContextAPIKeys,
		map[string]edgeapplications.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