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

# README

Go API client for openapi_N32_Handshake

N32-c Handshake 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/net/context

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

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

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

Documentation for API Endpoints

All URIs are relative to https://example.com/n32c-handshake/v1

ClassMethodHTTP requestDescription
N32FContextTerminateApiPostN32fTerminatePost /n32f-terminateN32-f Context Terminate
N32FErrorReportApiPostN32fErrorPost /n32f-errorN32-f Error Reporting Procedure
ParameterExchangeApiPostExchangeParamsPost /exchange-paramsParameter Exchange
SecurityCapabilityNegotiationApiPostExchangeCapabilityPost /exchange-capabilitySecurity Capability Negotiation

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

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
CallbackNameAsApiSignature is a convenience function that returns CallbackName wrapped in ApiSignature.
IsNil checks if an input is nil.
NewAccessTokenErr instantiates a new AccessTokenErr object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccessTokenErrWithDefaults instantiates a new AccessTokenErr object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccessTokenReq instantiates a new AccessTokenReq object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccessTokenReqWithDefaults instantiates a new AccessTokenReq object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIClient creates a new API client.
NewApiIeMapping instantiates a new ApiIeMapping object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewApiIeMappingWithDefaults instantiates a new ApiIeMapping object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCallbackName instantiates a new CallbackName object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCallbackNameWithDefaults instantiates a new CallbackName object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewFailedModificationInfo instantiates a new FailedModificationInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFailedModificationInfoWithDefaults instantiates a new FailedModificationInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIeInfo instantiates a new IeInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIeInfoWithDefaults instantiates a new IeInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIntendedN32Purpose instantiates a new IntendedN32Purpose object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIntendedN32PurposeWithDefaults instantiates a new IntendedN32Purpose object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInvalidParam instantiates a new InvalidParam object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInvalidParamWithDefaults instantiates a new InvalidParam object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIpxProviderSecInfo instantiates a new IpxProviderSecInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIpxProviderSecInfoWithDefaults instantiates a new IpxProviderSecInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewN32fContextInfo instantiates a new N32fContextInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewN32fContextInfoWithDefaults instantiates a new N32fContextInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewN32fErrorDetail instantiates a new N32fErrorDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewN32fErrorDetailWithDefaults instantiates a new N32fErrorDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewN32fErrorInfo instantiates a new N32fErrorInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewN32fErrorInfoWithDefaults instantiates a new N32fErrorInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPlmnId instantiates a new PlmnId object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPlmnIdNid instantiates a new PlmnIdNid object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPlmnIdNidWithDefaults instantiates a new PlmnIdNid object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPlmnIdWithDefaults instantiates a new PlmnId object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProblemDetails instantiates a new ProblemDetails object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProblemDetailsWithDefaults instantiates a new ProblemDetails object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProtectionPolicy instantiates a new ProtectionPolicy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProtectionPolicyWithDefaults instantiates a new ProtectionPolicy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSecNegotiateReqData instantiates a new SecNegotiateReqData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSecNegotiateReqDataWithDefaults instantiates a new SecNegotiateReqData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSecNegotiateRspData instantiates a new SecNegotiateRspData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSecNegotiateRspDataWithDefaults instantiates a new SecNegotiateRspData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSecParamExchReqData instantiates a new SecParamExchReqData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSecParamExchReqDataWithDefaults instantiates a new SecParamExchReqData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSecParamExchRspData instantiates a new SecParamExchRspData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSecParamExchRspDataWithDefaults instantiates a new SecParamExchRspData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnssai instantiates a new Snssai object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnssaiWithDefaults instantiates a new Snssai object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
stringAsApiSignature is a convenience function that returns string wrapped in ApiSignature.

# Variables

ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

AccessTokenErr Error returned in the access token response message.
AccessTokenReq Contains information related to the access token request.
APIClient manages communication with the N32 Handshake API API v1.3.0-alpha.2 In most cases there should be only one, shared, APIClient.
ApiIeMapping API URI to IE mapping on which the protection policy needs to be applied.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
ApiSignature - API URI of the service operation.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CallbackName Callback Name.
Configuration stores the configuration of the API client.
FailedModificationInfo Information on N32-f modifications block that failed to process.
FailureReason Reason for failure to reconstruct a HTTP/2 message from N32-f message.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
HttpMethod Enumeration of HTTP methods.
IeInfo Protection and modification policy for the IE.
IeLocation Location of the IE in a HTTP message.
IeType Enumeration of types of IEs (i.e kind of IE) to specify the protection policy.
IntendedN32Purpose Indicates the intended N32 establishment purpose.
InvalidParam It contains an invalid parameter and a related description.
IpxProviderSecInfo Defines the security information list of an IPX.
N32fContextInfo N32-f context information.
N32fErrorDetail Details about the N32f error.
N32fErrorInfo N32-f error information.
N32fErrorType Type of error while processing N32-f message.
N32Purpose Usage purpose of establishing N32 connectivity.
NFType NF types known to NRF.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PlmnId When PlmnId needs to be converted to string (e.g.
PlmnIdNid Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
ProblemDetails Provides additional information in an error response.
ProtectionPolicy The protection policy to be negotiated between the SEPPs.
SecNegotiateReqData Defines the security capabilities of a SEPP sent to a receiving SEPP.
SecNegotiateRspData Defines the selected security capabilities by a SEPP.
SecParamExchReqData Request data structure for parameter exchange.
SecParamExchRspData Response data structure for parameter exchange.
SecurityCapability Enumeration of security capabilities.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Snssai When Snssai needs to be converted to string (e.g.

# Interfaces

No description provided by the author

# Type aliases

N32FContextTerminateApiService N32FContextTerminateApi service.
N32FErrorReportApiService N32FErrorReportApi service.
ParameterExchangeApiService ParameterExchangeApi service.
SecurityCapabilityNegotiationApiService SecurityCapabilityNegotiationApi service.
ServerConfigurations stores multiple ServerConfiguration items.