Go API client for openapi_Nudm_UECM

Nudm Context Management Service.
© 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: 1.3.0-alpha.1
• 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/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi_Nudm_UECM "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Nudm_UECM"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/nudm-uecm/v1

Class	Method	HTTP request	Description
AMF3GppAccessRegistrationInfoRetrievalApi	Get3GppRegistration	Get /{ueId}/registrations/amf-3gpp-access	retrieve the AMF registration for 3GPP access information
AMFNon3GPPAccessRegistrationInfoRetrievalApi	GetNon3GppRegistration	Get /{ueId}/registrations/amf-non-3gpp-access	retrieve the AMF registration for non-3GPP access information
AMFRegistrationFor3GPPAccessApi	Call3GppRegistration	Put /{ueId}/registrations/amf-3gpp-access	register as AMF for 3GPP access
AMFRegistrationForNon3GPPAccessApi	Non3GppRegistration	Put /{ueId}/registrations/amf-non-3gpp-access	register as AMF for non-3GPP access
IPSMGWDeregistrationApi	IpSmGwDeregistration	Delete /{ueId}/registrations/ip-sm-gw	Delete the IP-SM-GW registration
IPSMGWRegistrationApi	IpSmGwRegistration	Put /{ueId}/registrations/ip-sm-gw	Register an IP-SM-GW
IPSMGWRegistrationInfoRetrievalApi	GetIpSmGwRegistration	Get /{ueId}/registrations/ip-sm-gw	Retrieve the IP-SM-GW registration information
NWDAFDeregistrationApi	NwdafDeregistration	Delete /{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}	delete an NWDAF registration
NWDAFRegistrationApi	NwdafRegistration	Put /{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}	register as NWDAF
NWDAFRegistrationInfoRetrievalApi	GetNwdafRegistration	Get /{ueId}/registrations/nwdaf-registrations	retrieve the NWDAF registration
PEIUpdateApi	PeiUpdate	Post /{ueId}/registrations/amf-3gpp-access/pei-update	Updates the PEI in the 3GPP access registration context
ParameterUpdateInTheAMFRegistrationFor3GPPAccessApi	Update3GppRegistration	Patch /{ueId}/registrations/amf-3gpp-access	Update a parameter in the AMF registration for 3GPP access
ParameterUpdateInTheAMFRegistrationForNon3GPPAccessApi	UpdateNon3GppRegistration	Patch /{ueId}/registrations/amf-non-3gpp-access	update a parameter in the AMF registration for non-3GPP access
ParameterUpdateInTheNWDAFRegistrationApi	UpdateNwdafRegistration	Patch /{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}	Update a parameter in the NWDAF registration
ParameterUpdateInTheSMFRegistrationApi	UpdateSmfRegistration	Patch /{ueId}/registrations/smf-registrations/{pduSessionId}	update a parameter in the SMF registration
RetrieveSMFRegistrationApi	RetrieveSmfRegistration	Get /{ueId}/registrations/smf-registrations/{pduSessionId}	get an SMF registration
RoamingInformationUpdateApi	UpdateRoamingInformation	Post /{ueId}/registrations/amf-3gpp-access/roaming-info-update	Update the Roaming Information
SMFDeregistrationApi	SmfDeregistration	Delete /{ueId}/registrations/smf-registrations/{pduSessionId}	delete an SMF registration
SMFSmfRegistrationApi	GetSmfRegistration	Get /{ueId}/registrations/smf-registrations	retrieve the SMF registration information
SMFSmfRegistrationApi	Registration	Put /{ueId}/registrations/smf-registrations/{pduSessionId}	register as SMF
SMSF3GPPAccessRegistrationInfoRetrievalApi	Get3GppSmsfRegistration	Get /{ueId}/registrations/smsf-3gpp-access	retrieve the SMSF registration for 3GPP access information
SMSFDeregistrationFor3GPPAccessApi	Call3GppSmsfDeregistration	Delete /{ueId}/registrations/smsf-3gpp-access	delete the SMSF registration for 3GPP access
SMSFDeregistrationForNon3GPPAccessApi	Non3GppSmsfDeregistration	Delete /{ueId}/registrations/smsf-non-3gpp-access	delete SMSF registration for non 3GPP access
SMSFNon3GPPAccessRegistrationInfoRetrievalApi	GetNon3GppSmsfRegistration	Get /{ueId}/registrations/smsf-non-3gpp-access	retrieve the SMSF registration for non-3GPP access information
SMSFRegistrationFor3GPPAccessApi	Call3GppSmsfRegistration	Put /{ueId}/registrations/smsf-3gpp-access	register as SMSF for 3GPP access
SMSFRegistrationForNon3GPPAccessApi	Non3GppSmsfRegistration	Put /{ueId}/registrations/smsf-non-3gpp-access	register as SMSF for non-3GPP access
SendRoutingInfoSMCustomOperationApi	SendRoutingInfoSm	Post /{ueId}/registrations/send-routing-info-sm	Retreive addressing information for SMS delivery
TriggerAMFFor3GPPAccessDeregistrationApi	DeregAMF	Post /{ueId}/registrations/amf-3gpp-access/dereg-amf	trigger AMF for 3GPP access deregistration
TriggerPCSCFRestorationApi	TriggerPCSCFRestoration	Post /restore-pcscf	Trigger the Restoration of the P-CSCF
UECMRegistrationInfoRetrievalApi	GetRegistrations	Get /{ueId}/registrations	retrieve UE registration data sets
UELocationInformationRetrievalApi	GetLocationInfo	Get /{ueId}/registrations/location	retrieve the target UE's location information

Documentation For Models

• AccessTokenErr
• AccessTokenReq
• AccessType
• Amf3GppAccessRegistration
• Amf3GppAccessRegistrationModification
• AmfDeregInfo
• AmfNon3GppAccessRegistration
• AmfNon3GppAccessRegistrationModification
• BackupAmfInfo
• ContextInfo
• DataRestorationNotification
• DeregistrationData
• DeregistrationReason
• EpsInterworkingInfo
• EpsIwkPgw
• EventId
• FqdnRm
• Guami
• IdentityRange
• ImsVoPs
• InvalidParam
• IpAddress
• IpSmGwGuidance
• IpSmGwInfo
• IpSmGwRegistration
• Ipv6Addr
• Ipv6Prefix
• LocationInfo
• NFType
• NetworkNodeDiameterAddress
• NullValue
• NwdafRegistration
• NwdafRegistrationInfo
• NwdafRegistrationModification
• PatchResult
• PcscfAddress
• PcscfRestorationNotification
• PeiUpdateInfo
• PlmnId
• PlmnIdNid
• ProblemDetails
• RatType
• RedirectResponse
• RegistrationDataSetName
• RegistrationDataSets
• RegistrationLocationInfo
• RegistrationReason
• ReportItem
• RoamingInfoUpdate
• RoutingInfoSmRequest
• RoutingInfoSmResponse
• ServiceName
• SmfRegistration
• SmfRegistrationInfo
• SmfRegistrationModification
• SmsRouterInfo
• SmsfRegistration
• Snssai
• SupiRange
• TriggerRequest
• UeReachableInd
• UpdateNwdafRegistration200Response
• VgmlcAddress

Documentation For Authorization

oAuth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• nudm-uecm: Access to the nudm-uecm API
• nudm_uecm:amf-registration:write: Write access (update/modify) to representations of the Amf3GppAccessRegistration and AmfNon3GppAccessRegistration resources
• nudm_uecm:smf-registration:write: Write access (create/delete/modify) to the representations of individualSmfRegistration resources
• nudm_uecm:smsf-registration:write: Write access (create/delete/modify) to representations of the Smsf3GppAccessRegistration and SmsfNon3GppAccessRegistration resources
• nudm_uecm:ip-sm-gw-registration:write: Write access (create/delete/modify) to the representation of the IpSmGwRegistration resource
• nudm_uecm:nwdaf-registration:write: Write access (create/delete/modify) to the representation of the NwdafRegistration resource

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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