# README

Go API client for openapi_Nnrf_NFManagement

NRF NFManagement 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.2
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_Nnrf_NFManagement "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Nnrf_NFManagement"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/nnrf-nfm/v1

Class	Method	HTTP request	Description
NFInstanceIDDocumentApi	DeregisterNFInstance	Delete /nf-instances/{nfInstanceID}	Deregisters a given NF Instance
NFInstanceIDDocumentApi	GetNFInstance	Get /nf-instances/{nfInstanceID}	Read the profile of a given NF Instance
NFInstanceIDDocumentApi	RegisterNFInstance	Put /nf-instances/{nfInstanceID}	Register a new NF Instance
NFInstanceIDDocumentApi	UpdateNFInstance	Patch /nf-instances/{nfInstanceID}	Update NF Instance profile
NFInstancesStoreApi	GetNFInstances	Get /nf-instances	Retrieves a collection of NF Instances
NFInstancesStoreApi	OptionsNFInstances	Options /nf-instances	Discover communication options supported by NRF for NF Instances
SubscriptionIDDocumentApi	RemoveSubscription	Delete /subscriptions/{subscriptionID}	Deletes a subscription
SubscriptionIDDocumentApi	UpdateSubscription	Patch /subscriptions/{subscriptionID}	Updates a subscription
SubscriptionsCollectionApi	CreateSubscription	Post /subscriptions	Create a new subscription

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

Type: OAuth
Flow: application
Authorization URL:
Scopes:
nnrf-nfm: Access to the Nnrf_NFManagement API
nnrf-nfm:nf-instances:read: Access to read the nf-instances resource, or an individual NF Instance ID resource
nnrf-nfm:subscriptions:subs-complete-profile: Access to subscribe to the complete profile of NF instances

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