# README

Go API client for openapi_Namf_Communication

AMF Communication 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_Namf_Communication "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Namf_Communication"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/namf-comm/v1

Class	Method	HTTP request	Description
IndividualSubscriptionDocumentApi	AMFStatusChangeSubscribeModfy	Put /subscriptions/{subscriptionId}	Namf_Communication AMF Status Change Subscribe Modify service Operation
IndividualSubscriptionDocumentApi	AMFStatusChangeUnSubscribe	Delete /subscriptions/{subscriptionId}	Namf_Communication AMF Status Change UnSubscribe service Operation
IndividualUeContextDocumentApi	CancelRelocateUEContext	Post /ue-contexts/{ueContextId}/cancel-relocate	Namf_Communication CancelRelocateUEContext service Operation
IndividualUeContextDocumentApi	CreateUEContext	Put /ue-contexts/{ueContextId}	Namf_Communication CreateUEContext service Operation
IndividualUeContextDocumentApi	EBIAssignment	Post /ue-contexts/{ueContextId}/assign-ebi	Namf_Communication EBI Assignment service Operation
IndividualUeContextDocumentApi	RegistrationStatusUpdate	Post /ue-contexts/{ueContextId}/transfer-update	Namf_Communication RegistrationStatusUpdate service Operation
IndividualUeContextDocumentApi	ReleaseUEContext	Post /ue-contexts/{ueContextId}/release	Namf_Communication ReleaseUEContext service Operation
IndividualUeContextDocumentApi	RelocateUEContext	Post /ue-contexts/{ueContextId}/relocate	Namf_Communication RelocateUEContext service Operation
IndividualUeContextDocumentApi	UEContextTransfer	Post /ue-contexts/{ueContextId}/transfer	Namf_Communication UEContextTransfer service Operation
N1N2IndividualSubscriptionDocumentApi	N1N2MessageUnSubscribe	Delete /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId}	Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation
N1N2MessageCollectionCollectionApi	N1N2MessageTransfer	Post /ue-contexts/{ueContextId}/n1-n2-messages	Namf_Communication N1N2 Message Transfer (UE Specific) service Operation
N1N2SubscriptionsCollectionForIndividualUEContextsCollectionApi	N1N2MessageSubscribe	Post /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions	Namf_Communication N1N2 Message Subscribe (UE Specific) service Operation
NonUEN2MessageNotificationIndividualSubscriptionDocumentApi	NonUeN2InfoUnSubscribe	Delete /non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}	Namf_Communication Non UE N2 Info UnSubscribe service Operation
NonUEN2MessagesCollectionCollectionApi	NonUeN2MessageTransfer	Post /non-ue-n2-messages/transfer	Namf_Communication Non UE N2 Message Transfer service Operation
NonUEN2MessagesSubscriptionsCollectionCollectionApi	NonUeN2InfoSubscribe	Post /non-ue-n2-messages/subscriptions	Namf_Communication Non UE N2 Info Subscribe service Operation
SubscriptionsCollectionCollectionApi	AMFStatusChangeSubscribe	Post /subscriptions	Namf_Communication AMF Status Change Subscribe service Operation

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

Type: OAuth
Flow: application
Authorization URL:
Scopes:
namf-comm: Access to the Namf_Communication API

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