Categorygithub.com/5GCoreNet/openapiopenapi_Application_Data
package
1.18.2
Repository: https://github.com/5gcorenet/openapi.git
Documentation: pkg.go.dev

# README

Go API client for openapi_Application_Data

The API version is defined in 3GPP TS 29.504
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AMInfluenceDataStoreApiReadAmInfluenceDataGet /application-data/am-influence-dataRetrieve AM Influence Data
ApplicationDataSubscriptionsCollectionApiCreateIndividualApplicationDataSubscriptionPost /application-data/subs-to-notifyCreate a subscription to receive notification of application data changes
ApplicationDataSubscriptionsCollectionApiReadApplicationDataChangeSubscriptionsGet /application-data/subs-to-notifyRead Application Data change Subscriptions
BdtPolicyDataStoreApiReadBdtPolicyDataGet /application-data/bdtPolicyDataRetrieve applied BDT Policy Data
EASDeploymentDataStoreApiReadEasDeployDataGet /application-data/eas-deploy-dataRetrieve EAS Deployment Information Data
IPTVConfigurationDataStoreApiReadIPTVCongifurationDataGet /application-data/iptvConfigDataRetrieve IPTV configuration Data
IndividualAMInfluenceDataDocumentApiCreateOrReplaceIndividualAmInfluenceDataPut /application-data/am-influence-data/{amInfluenceId}Create or update an individual AM Influence Data resource
IndividualAMInfluenceDataDocumentApiDeleteIndividualAmInfluenceDataDelete /application-data/am-influence-data/{amInfluenceId}Delete an individual AM Influence Data resource
IndividualAMInfluenceDataDocumentApiUpdateIndividualAmInfluenceDataPatch /application-data/am-influence-data/{amInfluenceId}Modify part of the properties of an individual AM Influence Data resource
IndividualApplicationDataSubscriptionDocumentApiDeleteIndividualApplicationDataSubscriptionDelete /application-data/subs-to-notify/{subsId}Delete the individual Application Data subscription
IndividualApplicationDataSubscriptionDocumentApiReadIndividualApplicationDataSubscriptionGet /application-data/subs-to-notify/{subsId}Get an existing individual Application Data Subscription resource
IndividualApplicationDataSubscriptionDocumentApiReplaceIndividualApplicationDataSubscriptionPut /application-data/subs-to-notify/{subsId}Modify a subscription to receive notification of application data changes
IndividualAppliedBDTPolicyDataDocumentApiCreateIndividualAppliedBdtPolicyDataPut /application-data/bdtPolicyData/{bdtPolicyId}Create an individual applied BDT Policy Data resource
IndividualAppliedBDTPolicyDataDocumentApiDeleteIndividualAppliedBdtPolicyDataDelete /application-data/bdtPolicyData/{bdtPolicyId}Delete an individual Applied BDT Policy Data resource
IndividualAppliedBDTPolicyDataDocumentApiUpdateIndividualAppliedBdtPolicyDataPatch /application-data/bdtPolicyData/{bdtPolicyId}Modify part of the properties of an individual Applied BDT Policy Data resource
IndividualEASDeploymentDataDocumentApiCreateOrReplaceIndividualEasDeployDataPut /application-data/eas-deploy-data/{easDeployInfoId}Create or update an individual EAS Deployment Data resource
IndividualEASDeploymentDataDocumentApiReadIndividualEasDeployDataGet /application-data/eas-deploy-data/{easDeployInfoId}Retrieve an individual EAS Deployment Data resource
IndividualEasDeploymentDataDocumentApiDeleteIndividualEasDeployDataDelete /application-data/eas-deploy-data/{easDeployInfoId}Delete an individual EAS Deployment Data resource
IndividualIPTVConfigurationDataDocumentApiCreateOrReplaceIndividualIPTVConfigurationDataPut /application-data/iptvConfigData/{configurationId}Create or update an individual IPTV configuration resource
IndividualIPTVConfigurationDataDocumentApiDeleteIndividualIPTVConfigurationDataDelete /application-data/iptvConfigData/{configurationId}Delete an individual IPTV configuration resource
IndividualIPTVConfigurationDataDocumentApiPartialReplaceIndividualIPTVConfigurationDataPatch /application-data/iptvConfigData/{configurationId}Partial update an individual IPTV configuration resource
IndividualInfluenceDataDocumentApiCreateOrReplaceIndividualInfluenceDataPut /application-data/influenceData/{influenceId}Create or update an individual Influence Data resource
IndividualInfluenceDataDocumentApiDeleteIndividualInfluenceDataDelete /application-data/influenceData/{influenceId}Delete an individual Influence Data resource
IndividualInfluenceDataDocumentApiUpdateIndividualInfluenceDataPatch /application-data/influenceData/{influenceId}Modify part of the properties of an individual Influence Data resource
IndividualInfluenceDataSubscriptionDocumentApiDeleteIndividualInfluenceDataSubscriptionDelete /application-data/influenceData/subs-to-notify/{subscriptionId}Delete an individual Influence Data Subscription resource
IndividualInfluenceDataSubscriptionDocumentApiReadIndividualInfluenceDataSubscriptionGet /application-data/influenceData/subs-to-notify/{subscriptionId}Get an existing individual Influence Data Subscription resource
IndividualInfluenceDataSubscriptionDocumentApiReplaceIndividualInfluenceDataSubscriptionPut /application-data/influenceData/subs-to-notify/{subscriptionId}Modify an existing individual Influence Data Subscription resource
IndividualPFDDataDocumentApiCreateOrReplaceIndividualPFDDataPut /application-data/pfds/{appId}Create or update the corresponding PFDs for the specified application identifier
IndividualPFDDataDocumentApiDeleteIndividualPFDDataDelete /application-data/pfds/{appId}Delete the corresponding PFDs of the specified application identifier
IndividualPFDDataDocumentApiReadIndividualPFDDataGet /application-data/pfds/{appId}Retrieve the corresponding PFDs of the specified application identifier
IndividualServiceParameterDataDocumentApiCreateOrReplaceServiceParameterDataPut /application-data/serviceParamData/{serviceParamId}Create or update an individual Service Parameter Data resource
IndividualServiceParameterDataDocumentApiDeleteIndividualServiceParameterDataDelete /application-data/serviceParamData/{serviceParamId}Delete an individual Service Parameter Data resource
IndividualServiceParameterDataDocumentApiUpdateIndividualServiceParameterDataPatch /application-data/serviceParamData/{serviceParamId}Modify part of the properties of an individual Service Parameter Data resource
InfluenceDataStoreApiReadInfluenceDataGet /application-data/influenceDataRetrieve Traffic Influence Data
InfluenceDataSubscriptionsCollectionApiCreateIndividualInfluenceDataSubscriptionPost /application-data/influenceData/subs-to-notifyCreate a new Individual Influence Data Subscription resource
InfluenceDataSubscriptionsCollectionApiReadInfluenceDataSubscriptionsGet /application-data/influenceData/subs-to-notifyRead Influence Data Subscriptions
PFDDataStoreApiReadPFDDataGet /application-data/pfdsRetrieve PFDs for application identifier(s)
ServiceParameterDataStoreApiReadServiceParameterDataGet /application-data/serviceParamDataRetrieve Service Parameter Data

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