# 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
Class | Method | HTTP request | Description |
---|---|---|---|
AMInfluenceDataStoreApi | ReadAmInfluenceData | Get /application-data/am-influence-data | Retrieve AM Influence Data |
ApplicationDataSubscriptionsCollectionApi | CreateIndividualApplicationDataSubscription | Post /application-data/subs-to-notify | Create a subscription to receive notification of application data changes |
ApplicationDataSubscriptionsCollectionApi | ReadApplicationDataChangeSubscriptions | Get /application-data/subs-to-notify | Read Application Data change Subscriptions |
BdtPolicyDataStoreApi | ReadBdtPolicyData | Get /application-data/bdtPolicyData | Retrieve applied BDT Policy Data |
EASDeploymentDataStoreApi | ReadEasDeployData | Get /application-data/eas-deploy-data | Retrieve EAS Deployment Information Data |
IPTVConfigurationDataStoreApi | ReadIPTVCongifurationData | Get /application-data/iptvConfigData | Retrieve IPTV configuration Data |
IndividualAMInfluenceDataDocumentApi | CreateOrReplaceIndividualAmInfluenceData | Put /application-data/am-influence-data/{amInfluenceId} | Create or update an individual AM Influence Data resource |
IndividualAMInfluenceDataDocumentApi | DeleteIndividualAmInfluenceData | Delete /application-data/am-influence-data/{amInfluenceId} | Delete an individual AM Influence Data resource |
IndividualAMInfluenceDataDocumentApi | UpdateIndividualAmInfluenceData | Patch /application-data/am-influence-data/{amInfluenceId} | Modify part of the properties of an individual AM Influence Data resource |
IndividualApplicationDataSubscriptionDocumentApi | DeleteIndividualApplicationDataSubscription | Delete /application-data/subs-to-notify/{subsId} | Delete the individual Application Data subscription |
IndividualApplicationDataSubscriptionDocumentApi | ReadIndividualApplicationDataSubscription | Get /application-data/subs-to-notify/{subsId} | Get an existing individual Application Data Subscription resource |
IndividualApplicationDataSubscriptionDocumentApi | ReplaceIndividualApplicationDataSubscription | Put /application-data/subs-to-notify/{subsId} | Modify a subscription to receive notification of application data changes |
IndividualAppliedBDTPolicyDataDocumentApi | CreateIndividualAppliedBdtPolicyData | Put /application-data/bdtPolicyData/{bdtPolicyId} | Create an individual applied BDT Policy Data resource |
IndividualAppliedBDTPolicyDataDocumentApi | DeleteIndividualAppliedBdtPolicyData | Delete /application-data/bdtPolicyData/{bdtPolicyId} | Delete an individual Applied BDT Policy Data resource |
IndividualAppliedBDTPolicyDataDocumentApi | UpdateIndividualAppliedBdtPolicyData | Patch /application-data/bdtPolicyData/{bdtPolicyId} | Modify part of the properties of an individual Applied BDT Policy Data resource |
IndividualEASDeploymentDataDocumentApi | CreateOrReplaceIndividualEasDeployData | Put /application-data/eas-deploy-data/{easDeployInfoId} | Create or update an individual EAS Deployment Data resource |
IndividualEASDeploymentDataDocumentApi | ReadIndividualEasDeployData | Get /application-data/eas-deploy-data/{easDeployInfoId} | Retrieve an individual EAS Deployment Data resource |
IndividualEasDeploymentDataDocumentApi | DeleteIndividualEasDeployData | Delete /application-data/eas-deploy-data/{easDeployInfoId} | Delete an individual EAS Deployment Data resource |
IndividualIPTVConfigurationDataDocumentApi | CreateOrReplaceIndividualIPTVConfigurationData | Put /application-data/iptvConfigData/{configurationId} | Create or update an individual IPTV configuration resource |
IndividualIPTVConfigurationDataDocumentApi | DeleteIndividualIPTVConfigurationData | Delete /application-data/iptvConfigData/{configurationId} | Delete an individual IPTV configuration resource |
IndividualIPTVConfigurationDataDocumentApi | PartialReplaceIndividualIPTVConfigurationData | Patch /application-data/iptvConfigData/{configurationId} | Partial update an individual IPTV configuration resource |
IndividualInfluenceDataDocumentApi | CreateOrReplaceIndividualInfluenceData | Put /application-data/influenceData/{influenceId} | Create or update an individual Influence Data resource |
IndividualInfluenceDataDocumentApi | DeleteIndividualInfluenceData | Delete /application-data/influenceData/{influenceId} | Delete an individual Influence Data resource |
IndividualInfluenceDataDocumentApi | UpdateIndividualInfluenceData | Patch /application-data/influenceData/{influenceId} | Modify part of the properties of an individual Influence Data resource |
IndividualInfluenceDataSubscriptionDocumentApi | DeleteIndividualInfluenceDataSubscription | Delete /application-data/influenceData/subs-to-notify/{subscriptionId} | Delete an individual Influence Data Subscription resource |
IndividualInfluenceDataSubscriptionDocumentApi | ReadIndividualInfluenceDataSubscription | Get /application-data/influenceData/subs-to-notify/{subscriptionId} | Get an existing individual Influence Data Subscription resource |
IndividualInfluenceDataSubscriptionDocumentApi | ReplaceIndividualInfluenceDataSubscription | Put /application-data/influenceData/subs-to-notify/{subscriptionId} | Modify an existing individual Influence Data Subscription resource |
IndividualPFDDataDocumentApi | CreateOrReplaceIndividualPFDData | Put /application-data/pfds/{appId} | Create or update the corresponding PFDs for the specified application identifier |
IndividualPFDDataDocumentApi | DeleteIndividualPFDData | Delete /application-data/pfds/{appId} | Delete the corresponding PFDs of the specified application identifier |
IndividualPFDDataDocumentApi | ReadIndividualPFDData | Get /application-data/pfds/{appId} | Retrieve the corresponding PFDs of the specified application identifier |
IndividualServiceParameterDataDocumentApi | CreateOrReplaceServiceParameterData | Put /application-data/serviceParamData/{serviceParamId} | Create or update an individual Service Parameter Data resource |
IndividualServiceParameterDataDocumentApi | DeleteIndividualServiceParameterData | Delete /application-data/serviceParamData/{serviceParamId} | Delete an individual Service Parameter Data resource |
IndividualServiceParameterDataDocumentApi | UpdateIndividualServiceParameterData | Patch /application-data/serviceParamData/{serviceParamId} | Modify part of the properties of an individual Service Parameter Data resource |
InfluenceDataStoreApi | ReadInfluenceData | Get /application-data/influenceData | Retrieve Traffic Influence Data |
InfluenceDataSubscriptionsCollectionApi | CreateIndividualInfluenceDataSubscription | Post /application-data/influenceData/subs-to-notify | Create a new Individual Influence Data Subscription resource |
InfluenceDataSubscriptionsCollectionApi | ReadInfluenceDataSubscriptions | Get /application-data/influenceData/subs-to-notify | Read Influence Data Subscriptions |
PFDDataStoreApi | ReadPFDData | Get /application-data/pfds | Retrieve PFDs for application identifier(s) |
ServiceParameterDataStoreApi | ReadServiceParameterData | Get /application-data/serviceParamData | Retrieve Service Parameter Data |
Documentation For Models
- AccessRightStatus
- AccessTokenErr
- AccessTokenReq
- AmInfluData
- AmInfluDataPatch
- AmInfluEvent
- AppDescriptor
- ApplicationDataChangeNotif
- ApplicationDataInfluenceDataSubsToNotifyPostRequestInner
- ApplicationDataSubs
- BdtPolicyData
- BdtPolicyDataPatch
- CivicAddress
- ConnectionCapabilities
- DataFilter
- DataInd
- DnaiChangeType
- DnaiInformation
- DnnSnssaiInformation
- DnsServerIdentifier
- DomainNameProtocol
- EasDeployInfoData
- Ecgi
- EllipsoidArc
- EllipsoidArcAllOf
- EthFlowDescription
- Event
- FlowDirection
- FlowInfo
- FqdnPatternMatchingRule
- GADShape
- GNbId
- GeographicArea
- GeographicalArea
- GeographicalCoordinates
- GlobalRanNodeId
- InvalidParam
- IpAddr
- IptvConfigData
- IptvConfigDataPatch
- Ipv6Addr
- Ipv6Prefix
- Local2dPointUncertaintyEllipse
- Local2dPointUncertaintyEllipseAllOf
- Local3dPointUncertaintyEllipsoid
- Local3dPointUncertaintyEllipsoidAllOf
- LocalOrigin
- MatchingOperator
- MulticastAccessControl
- NFType
- Ncgi
- NetworkAreaInfo
- PfdChangeNotification
- PfdContent
- PfdDataForAppExt
- PlmnId
- PlmnIdNid
- Point
- PointAllOf
- PointAltitude
- PointAltitudeAllOf
- PointAltitudeUncertainty
- PointAltitudeUncertaintyAllOf
- PointUncertaintyCircle
- PointUncertaintyCircleAllOf
- PointUncertaintyEllipse
- PointUncertaintyEllipseAllOf
- Polygon
- PolygonAllOf
- ProblemDetails
- RelativeCartesianLocation
- RouteInformation
- RouteSelectionParameterSet
- RouteToLocation
- ServiceAreaCoverageInfo
- ServiceParameterData
- ServiceParameterDataPatch
- Snssai
- StringMatchingCondition
- StringMatchingRule
- SubscribedEvent
- SupportedGADShapes
- Tai
- TemporalValidity
- TrafficDescriptorComponents
- TrafficInfluData
- TrafficInfluDataNotif
- TrafficInfluDataPatch
- TrafficInfluSub
- UncertaintyEllipse
- UncertaintyEllipsoid
- UrspRuleRequest
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